magic-cta-pipe 0.3.0

No project description provided

magic-cta-pipe

Repository for the analysis of MAGIC and MAGIC+LST1 data, based on ctapipe.

• Code: https://github.com/cta-observatory/magic-cta-pipe

v0.2.0 of magic-cta-pipe provides all the functionalities to perform a MAGIC+LST-1 or a MAGIC-only analysis. Both types of analyses can be performed using the scripts within the lst1_magic folder. See the README for more details on how to run the analysis.

Installation for users

magic-cta-pipe and its dependencies may be installed using the Anaconda or Miniconda package system. We recommend creating a conda virtual environment first, to isolate the installed version and dependencies from your master environment (this is optional).

The following command will set up a conda virtual environment, add the necessary package channels, and install magic-cta-pipe and its dependencies::

git clone https://github.com/cta-observatory/magic-cta-pipe.git
cd magic-cta-pipe
conda env create -n magic-lst1 -f environment.yml
conda activate magic-lst1
pip install .

Instructions for developers

People who would like to join the development of magic-cta-pipe, please contact Alessio Berti ([e-mail]) to get write access to the repository.

Developers should follow the coding style guidelines of the ctapipe project, see https://ctapipe.readthedocs.io/en/latest/development/style-guide.html and https://ctapipe.readthedocs.io/en/latest/development/code-guidelines.html.

In short, to check for code/style errors and for reformatting the code:

pip install hacking     # installs all checker tools
pip install black       # installs black formatter
pyflakes magicctapipe   # checks for code errors
flake8 magicctapipe     # checks style and code errors
black filename.py       # reformats filename.py with black

In general, if you want to add a new feature or fix a bug, please open a new issue, and then create a new branch to develop the new feature or code the bug fix. You can create an early pull request even if it is not complete yet, you can tag it as "Draft" so that it will not be merged, and other developers can already check it and provide comments. When the code is ready, remove the tag "Draft" and select two people to review the pull request (at the moment the merge is not blocked if no review is performed, but that may change in the future). When the review is complete, the branch will be merged into the main branch.