integral/ridge
1
0
Fork 0
generated from erosita/uds
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update

Browse Source
This commit is contained in:
Roman Krivonos 2024-10-31 08:37:49 +03:00
parent a2de1661c6
commit 324f4e482c
1 changed files with 18 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -1,40 +1,44 @@
# Galactic diffuse emission with INTEGRAL/IBIS
This repository provides the code of the IBIS/ISGRI background model used in paper *The properties of the Galactic Hard X-Ray and soft gamma-ray Background based on 20 years of INTEGRAL/IBIS observations* [arXiv:2409.20058](https://arxiv.org/abs/2409.20058).
This repository provides the code of the IBIS/ISGRI background model used in paper [arXiv:2409.20058](https://arxiv.org/abs/2409.20058).
In addition to the code, the package contains preprocessed data. In particular, it contains ISGRI detector count rate cleaned from the contribution of X-ray point sources, for each INTEGRAL observation (so-called "science window", ScW) in the range of the INTEGRAL orbits 70-2740 and in different energy bands. This data set and code can be used to calibrate the ISGRI background model and measure the X-ray intensity of the Galactic background in different parts of the Milky Way.
In addition to the code, the package contains preprocessed data in **data** directory. In particular, it contains ISGRI detector count rate cleaned from the contribution of X-ray point sources, for each INTEGRAL observation (so-called "science window", ScW) in the range of the INTEGRAL orbits 70-2740 and in different energy bands. This data set and code can be used to calibrate the ISGRI background model and measure the X-ray intensity of the Galactic background in different parts of the Milky Way.
# INSTALL
## Шаг 1. (опционально) Устанавливаем локальное виртуальное окружение Python
## Step 1. (optionally) Creation of Python virtual environment
```
mkdir ~/work; cd ~/work
python -m venv venv
source ./venv/bin/activate.csh
python3 -m venv venv
source ./venv/bin/activate
```
или запускаем другое виртуальное окружение, например:
or activate already installed environment, e.g. conda:
``` conda activate ciao-4.15 ```
## Шаг 2. Клонируем проект из репозитория
## Step 2. Clone a repository into a new directory
```
mkdir ~/work; cd ~/work
cd ~/work
git clone git@heagit.cosmos.ru:integral/ridge.git
```
## Шаг 3. Устанавливаем проект в ваше виртуальное окружение
## Step 3. Install code in your Python virtual environment
```
cd ridge
cd ~/work/ridge
pip install --editable ridge/
```
Обратите внимание на параметр **--editable**, он позволяет вам редактировать исходный код данного пакета и сразу его выполнять. Если вы не планируете модифицировать локальную копию кода, можете убрать этот параметр.
Pay attention to the **--editable** parameter, it allows you to edit the source code of this package and execute it immediately. If you do not plan to modify the local copy of the code, you can remove this option.
After work, you can delete the project:
После работы можете удалить проект:
``` pip uninstall ridge ```
## Работа с данными
## Work with pre-processed data
Actual work with the data takes place in the **scripts** directory, where processing scripts must be run sequentially. This directory contains a detailed description of all actions.
Непосредственная работа с данными происходит в директории scripts, где нужно последовательно запускать скрипты обработки. В данной директории находится подробное описание всех действий.