magic-cta-pipe

Pipeline for the analysis of MAGIC and LST1 data, and more.

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

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    9 of 22 committers (40.9%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Pipeline for the analysis of MAGIC and LST1 data, and more.

Basic Info
Statistics
  • Stars: 8
  • Watchers: 12
  • Forks: 9
  • Open Issues: 19
  • Releases: 16
Created about 4 years ago · Last pushed 6 months ago
Metadata Files
Readme License Citation

README.rst

==============
magic-cta-pipe
==============

.. container::

    |Actions Status| |PyPI Status| |Conda Status| |Documentation Status| |Pre-Commit| |isort Status| |black|

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

* Code: https://github.com/cta-observatory/magic-cta-pipe
* Docs (preliminary): https://magic-cta-pipe.readthedocs.io/

The latest stable release, v0.5.7, 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 `here `_ for more details on how to run the analysis.

v0.5.* is based on *ctapipe* v0.19.x and *cta-lstchain* v0.10.x (with 5<=x<12).

**NOTE ON OLD RELEASES**

v0.3.1 of *magic-cta-pipe* was the last release before the cleanup of old files. Also, it was the last one supporting ctapipe v0.12.
In order to exploit fully the new functionalities provided by *ctapipe*, use always the latest stable release of *magic-cta-pipe*.
v0.4.0 contained backward incompatible changes with respect to v0.3.1. Therefore, you cannot mix analyses performed with the two releases (and more recent ones).

**COMPATIBILITY OF MAGIC-CTA-PIPE WITH LSTCHAIN DATA**

At the moment of the release v0.4.0 of *magic-cta-pipe*, some LST-1 data were processed with *cta-lstchain* v0.9.x,
while the most recent ones are processed with v0.10.x. v0.4.2 of *magic-cta-pipe* and more recent releases allow to read in LST data files
created with both v0.9.x and v0.10.x, so that you do not need to use different versions of *magic-cta-pipe* to
process LST data.

Note that there are quite a lot of differences between v0.3.1 and v0.4.x, like for the telescope combinations definition,
the way IRF are created (due to different *pyirf* versions) and so on. Therefore it may not be straightforward to stack the
data at high level. We recommend to use only releases more recent than v0.4.2 for the processing, so that there will be no mismatches during the analysis.

Installation for users
----------------------

The very first step to reduce MAGIC-LST data is to have remote access/credentials to the IT Container. If you do not have it, please write an email to request it to , and the admin will send you the instructions to connect to the IT container.

*magic-cta-pipe* and its dependencies may be installed using the *Anaconda* or *Miniconda* package system (if you have mamba installed, we recommend you to use it instead of conda, so that the installation process will be much faster; if you don't have anaconda/miniconda/miniforge, please install one of them into your workspace directory). We recommend creating a conda virtual environment
first, to isolate the installed version and dependencies from your master environment (this is optional).

Since version 0.5.1, *magic-cta-pipe* is on conda-forge (https://anaconda.org/conda-forge/magic-cta-pipe), which is the easiest way to install it.

To install into an exisiting environment, just do::

    # or conda
    $ mamba install -c conda-forge magic-cta-pipe

or, to create a new environment::

    # or conda
    mamba create -c conda-forge -n mcp python=3.11 magic-cta-pipe

Alternatively, 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-lst -f environment.yml
    conda activate magic-lst
    pip install .

In general, *magic-cta-pipe* is still in heavy development phase, so expect large changes between different releases.

Instructions for developers
---------------------------

Developers should follow the development install instructions found in the
`documentation `_.

.. |Actions Status| image:: https://github.com/cta-observatory/magic-cta-pipe/actions/workflows/ci.yml/badge.svg?branch=master
    :target: https://github.com/cta-observatory/magic-cta-pipe/actions
    :alt: magic-cta-pipe GitHub Actions CI Status

.. |PyPI Status| image:: https://badge.fury.io/py/magic-cta-pipe.svg
    :target: https://pypi.org/project/magic-cta-pipe
    :alt: magic-cta-pipe PyPI Status

.. |Conda Status| image:: https://anaconda.org/conda-forge/magic-cta-pipe/badges/version.svg
    :target: https://anaconda.org/conda-forge/magic-cta-pipe
    :alt: magic-cta-pipe Conda Status

.. |Documentation Status| image:: https://readthedocs.org/projects/magic-cta-pipe/badge/?version=latest&style=flat
    :target: https://magic-cta-pipe.readthedocs.io/en/latest/
    :alt: magic-cta-pipe documentation Status

.. |Pre-Commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
   :target: https://github.com/pre-commit/pre-commit
   :alt: pre-commit

.. |isort Status| image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
    :target: https://pycqa.github.io/isort/
    :alt: isort Status

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black

Owner

  • Name: Cherenkov Telescope Array Consortium
  • Login: cta-observatory
  • Kind: organization

open-source software for the CTA Consortium.

Citation (CITATION.bib)

@ARTICLE{2023A&A...680A..66A,
       author = {{Abe}, H. and {Abe}, K. and {Abe}, S. and {Acciari}, V.~A. and {Aguasca-Cabot}, A. and {Agudo}, I. and {Alvarez Crespo}, N. and {Aniello}, T. and {Ansoldi}, S. and {Antonelli}, L.~A. and {Aramo}, C. and {Arbet-Engels}, A. and {Arcaro}, C. and {Artero}, M. and {Asano}, K. and {Aubert}, P. and {Baack}, D. and {Babi{\'c}}, A. and {Baktash}, A. and {Bamba}, A. and {Baquero Larriva}, A. and {Baroncelli}, L. and {Barres de Almeida}, U. and {Barrio}, J.~A. and {Batkovi{\'c}}, I. and {Baxter}, J. and {Becerra Gonz{\'a}lez}, J. and {Bednarek}, W. and {Bernardini}, E. and {Bernardos}, M.~I. and {Bernete Medrano}, J. and {Berti}, A. and {Besenrieder}, J. and {Bhattacharjee}, P. and {Biederbeck}, N. and {Bigongiari}, C. and {Biland}, A. and {Bissaldi}, E. and {Blanch}, O. and {Bonnoli}, G. and {Bordas}, P. and {Bo{\v{s}}njak}, {\v{Z}}. and {Bulgarelli}, A. and {Burelli}, I. and {Burmistrov}, L. and {Buscemi}, M. and {Busetto}, G. and {Campoy Ordaz}, A. and {Cardillo}, M. and {Caroff}, S. and {Carosi}, A. and {Carosi}, R. and {Carrasco}, M.~S. and {Carretero-Castrillo}, M. and {Cassol}, F. and {Castro-Tirado}, A.~J. and {Cauz}, D. and {Cerasole}, D. and {Ceribella}, G. and {Chai}, Y. and {Cheng}, K. and {Chiavassa}, A. and {Chikawa}, M. and {Chytka}, L. and {Cifuentes}, A. and {Cikota}, S. and {Colombo}, E. and {Contreras}, J.~L. and {Cornelia}, A. and {Cortina}, J. and {Costantini}, H. and {Covino}, S. and {D'Amico}, G. and {D'Elia}, V. and {Da Vela}, P. and {Dalchenko}, M. and {Dazzi}, F. and {De Angelis}, A. and {de Bony de Lavergne}, M. and {De Lotto}, B. and {De Lucia}, M. and {de Menezes}, R. and {Del Peral}, L. and {Del Popolo}, A. and {Deleglise}, G. and {Delfino}, M. and {Delgado Mendez}, C. and {Delgado Mengual}, J. and {della Volpe}, D. and {Dellaiera}, M. and {Depaoli}, D. and {De Angelis}, A. and {Di Piano}, A. and {Di Pierro}, F. and {Di Pilato}, A. and {Di Tria}, R. and {Di Venere}, L. and {Dominik}, R.~M. and {Dominis Prester}, D. and {Donini}, A. and {Dorner}, D. and {Doro}, M. and {D{\'\i}az}, C. and {Eisenberger}, L. and {Els{\"a}sser}, D. and {Emery}, G. and {Escudero}, J. and {Fallah Ramazani}, V. and {Fari{\~n}a}, L. and {Fattorini}, A. and {Ferrara}, G. and {Ferrarotto}, F. and {Fiasson}, A. and {Foffano}, L. and {Font}, L. and {Freixas Coromina}, L. and {Fr{\"o}se}, S. and {Fukami}, S. and {Fukazawa}, Y. and {Garcia L{\'o}pez}, R.~J. and {Garcia}, E. and {Garczarczyk}, M. and {Garc{\'\i}a L{\'o}pez}, R.~J. and {Gasbarra}, C. and {Gasparrini}, D. and {Gasparyan}, S. and {Gaug}, M. and {Geyer}, D. and {Giesbrecht Paiva}, J.~G. and {Giglietto}, N. and {Giordano}, F. and {Gliwny}, P. and {Godinovi{\'c}}, N. and {Grau}, R. and {Green}, D. and {Green}, J.~G. and {Gunji}, S. and {G{\"u}nther}, P. and {Hackfeld}, J. and {Hadasch}, D. and {Hahn}, A. and {Hashiyama}, K. and {Hassan}, T. and {Hayashi}, K. and {Heckmann}, L. and {Heller}, M. and {Herrera Llorente}, J. and {Hirotani}, K. and {Hoffmann}, D. and {Horns}, D. and {Houles}, J. and {Hrabovsky}, M. and {Hrupec}, D. and {Hui}, D. and {H{\"u}tten}, M. and {Iarlori}, M. and {Imazawa}, R. and {Inada}, T. and {Inome}, Y. and {Ioka}, K. and {Iori}, M. and {Iotov}, R. and {Ishio}, K. and {Jacquemont}, M. and {Jim{\'e}nez Mart{\'\i}nez}, I. and {Jobst}, E. and {Jormanainen}, J. and {Jurysek}, J. and {Kagaya}, M. and {Karas}, V. and {Katagiri}, H. and {Kataoka}, J. and {Kerszberg}, D. and {Kluge}, G.~W. and {Kobayashi}, Y. and {Kohri}, K. and {Kong}, A. and {Kouch}, P.~M. and {Kubo}, H. and {Kushida}, J. and {Lainez}, M. and {Lamanna}, G. and {Lamastra}, A. and {Le Flour}, T. and {Leone}, F. and {Lindfors}, E. and {Linhoff}, L. and {Linhoff}, M. and {Lombardi}, S. and {Longo}, F. and {Loporchio}, S. and {Lorini}, A. and {Lozano Bahilo}, J. and {Luque-Escamilla}, P.~L. and {Lyard}, E. and {L{\'a}inez Lez{\'a}un}, M. and {L{\'o}pez-Coto}, R. and {L{\'o}pez-Moya}, M. and {L{\'o}pez-Oramas}, A. and {Machado de Oliveira Fraga}, B. and {Majumdar}, P. and {Makariev}, M. and {Mandat}, D. and {Maneva}, G. and {Manganaro}, M. and {Mangano}, S. and {Mang}, N. and {Manic{\`o}}, G. and {Mannheim}, K. and {Mariotti}, M. and {Marquez}, P. and {Marsella}, G. and {Martinez}, O. and {Mart{\'\i}nez}, G. and {Mart{\'\i}nez}, M. and {Mart{\'\i}}, J. and {Mas-Aguilar}, A. and {Maurin}, G. and {Mazin}, D. and {Menchiari}, S. and {Mender}, S. and {Mestre Guillen}, E. and {Micanovic}, S. and {Miceli}, D. and {Miener}, T. and {Miranda}, J.~M. and {Mirzoyan}, R. and {Mizuno}, T. and {Mi{\'c}anovi{\'c}}, S. and {Molero Gonz{\'a}lez}, M. and {Molina}, E. and {Mondal}, H.~A. and {Montaruli}, T. and {Monteiro}, I. and {Moralejo}, A. and {Morcuende}, D. and {Morselli}, A. and {Moya}, V. and {Muraishi}, H. and {Murase}, K. and {Nagataki}, S. and {Nakamori}, T. and {Nanci}, C. and {Neronov}, A. and {Neustroev}, V. and {Nickel}, L. and {Nievas Rosillo}, M. and {Nigro}, C. and {Nikoli{\'c}}, L. and {Nilsson}, K. and {Nishijima}, K. and {Njoh Ekoume}, T. and {Noda}, K. and {Nosek}, D. and {Nozaki}, S. and {Ohishi}, M. and {Ohtani}, Y. and {Oka}, T. and {Okumura}, A. and {Orito}, R. and {Otero-Santos}, J. and {Paiano}, S. and {Palatiello}, M. and {Paneque}, D. and {Pantaleo}, F.~R. and {Paoletti}, R. and {Paredes}, J.~M. and {Pavleti{\'c}}, L. and {Pech}, M. and {Pecimotika}, M. and {Peresano}, M. and {Persic}, M. and {Pfeiffle}, F. and {Pietropaolo}, E. and {Pihet}, M. and {Pirola}, G. and {Plard}, C. and {Podobnik}, F. and {Poireau}, V. and {Polo}, M. and {Pons}, E. and {Prada Moroni}, P.~G. and {Prandini}, E. and {Prast}, J. and {Principe}, G. and {Priyadarshi}, C. and {Prouza}, M. and {Rando}, R. and {Rhode}, W. and {Rib{\'o}}, M. and {Rico}, J. and {Righi}, C. and {Rizi}, V. and {Rodriguez Fernandez}, G. and {Rodr{\'\i}guez Fr{\'\i}as}, M.~D. and {Sahakyan}, N. and {Saito}, T. and {Sakurai}, S. and {Sanchez}, D.~A. and {Satalecka}, K. and {Sato}, M. and {Sato}, Y. and {Saturni}, F.~G. and {Savchenko}, V. and {Schleicher}, B. and {Schmidt}, K. and {Schmuckermaier}, F. and {Schubert}, J.~L. and {Schussler}, F. and {Schweizer}, T. and {Sciaccaluga}, A. and {Siegert}, T. and {Silvia}, R. and {Sitarek}, J. and {Sliusar}, V. and {Sobczynska}, D. and {Spolon}, A. and {Stamerra}, A. and {Stri{\v{s}}kovi{\'c}}, J. and {Strom}, D. and {Strzys}, M. and {Suda}, Y. and {Suutarinen}, S. and {{\v{S}}ari{\'c}}, T. and {Tajima}, H. and {Takahashi}, H. and {Takahashi}, M. and {Takata}, J. and {Takeishi}, R. and {Tam}, P.~H.~T. and {Tanaka}, S.~J. and {Tateishi}, D. and {Tavecchio}, F. and {Temnikov}, P. and {Terada}, Y. and {Terauchi}, K. and {Terzi{\'c}}, T. and {Teshima}, M. and {Tluczykont}, M. and {Tokanai}, F. and {Torres}, D.~F. and {Tosti}, L. and {Travnicek}, P. and {Truzzi}, S. and {Tutone}, A. and {Ubach}, S. and {Vacula}, M. and {Vallania}, P. and {van Scherpenberg}, J. and {Vazquez Acosta}, M. and {Ventura}, S. and {Verguilov}, V. and {Viale}, I. and {Vigliano}, A. and {Vigorito}, C.~F. and {Visentin}, E. and {Vitale}, V. and {Voutsinas}, G. and {Vovk}, I. and {Vuillaume}, T. and {V{\'a}zquez Acosta}, M. and {Walter}, R. and {Wei}, Z. and {Will}, M. and {Yamamoto}, T. and {Yamazaki}, R. and {Yoshida}, T. and {Yoshikoshi}, T. and {Zywucka}, N.},
        title = "{Performance of the joint LST-1 and MAGIC observations evaluated with Crab Nebula data}",
      journal = {Astronomy & Astrophysics},
     keywords = {instrumentation: detectors, methods: data analysis, gamma rays: general, Astrophysics - Instrumentation and Methods for Astrophysics, Astrophysics - High Energy Astrophysical Phenomena},
         year = 2023,
        month = dec,
       volume = {680},
          eid = {A66},
        pages = {A66},
          doi = {10.1051/0004-6361/202346927},
archivePrefix = {arXiv},
       eprint = {2310.01954},
 primaryClass = {astro-ph.IM},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2023A&A...680A..66A},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}

GitHub Events

Total
  • Create event: 36
  • Release event: 2
  • Issues event: 8
  • Watch event: 4
  • Delete event: 22
  • Member event: 2
  • Issue comment event: 76
  • Push event: 208
  • Pull request review comment event: 146
  • Pull request review event: 164
  • Pull request event: 50
  • Fork event: 1
Last Year
  • Create event: 36
  • Release event: 2
  • Issues event: 8
  • Watch event: 4
  • Delete event: 22
  • Member event: 2
  • Issue comment event: 76
  • Push event: 208
  • Pull request review comment event: 146
  • Pull request review event: 164
  • Pull request event: 50
  • Fork event: 1

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 1,331
  • Total Committers: 22
  • Avg Commits per committer: 60.5
  • Development Distribution Score (DDS): 0.683
Top Committers
Name Email Commits
Davide Depaoli d****i@t****t 422
YoshikiOhtani o****i@i****p 420
Alessio Berti a****0@g****m 343
Yoshiki Ohtani y****i@c****g 35
Elli Sophie Jobst e****t@g****e 20
Moritz Hütten m****n@m****e 15
Ievgen Vovk I****k@m****e 14
Gabriel Emery g****y@h****r 13
Julian Sitarek j****k@u****l 9
Alessio Berti a****i@m****e 7
Julian Sitarek j****k@c****g 6
g-elisabettamedi e****a@t****t 6
Federico Di Pierro d****r@H****3 4
Lea Heckmann h****n@p****e 4
Ievgen Vovk i****k@m****e 3
Elisa Visentin e****n@e****t 3
Elisabetta Medina e****a@u****t 2
Marcel Strzys s****s@i****p 1
Maximilian Nöthe m****e@t****e 1
Julian Sitarek j****k@c****g 1
imazawa i****o@g****m 1
g-federicodipier f****o@t****t 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 42
  • Total pull requests: 297
  • Average time to close issues: 3 months
  • Average time to close pull requests: 28 days
  • Total issue authors: 15
  • Total pull request authors: 16
  • Average comments per issue: 2.64
  • Average comments per pull request: 2.53
  • Merged pull requests: 242
  • Bot issues: 0
  • Bot pull requests: 11
Past Year
  • Issues: 7
  • Pull requests: 70
  • Average time to close issues: about 2 months
  • Average time to close pull requests: 15 days
  • Issue authors: 6
  • Pull request authors: 10
  • Average comments per issue: 1.14
  • Average comments per pull request: 2.61
  • Merged pull requests: 48
  • Bot issues: 0
  • Bot pull requests: 5
Top Authors
Issue Authors
  • YoshikiOhtani (11)
  • jsitarek (10)
  • aleberti (4)
  • joannaWojS (2)
  • gabemery (2)
  • moralejo (2)
  • Elisa-Visentin (2)
  • FedericoDevoto757 (2)
  • juanjq (1)
  • giorgio-pirola (1)
  • SeiyaNozaki (1)
  • ffriaslago (1)
  • abhradeep-1996 (1)
  • aaguasca (1)
  • morcuended (1)
Pull Request Authors
  • aleberti (77)
  • Elisa-Visentin (72)
  • jsitarek (48)
  • YoshikiOhtani (44)
  • dependabot[bot] (11)
  • joannaWojS (10)
  • gabemery (7)
  • nzywucka (7)
  • FedericoDevoto757 (4)
  • mpecimotika (4)
  • ellijobst (3)
  • ranieremenezes (3)
  • SeiyaNozaki (3)
  • Ryo-Imazawa (2)
  • SamantaMorales (1)
Top Labels
Issue Labels
question (1)
Pull Request Labels
maintenance (56) new functionality (20) fix (18) documentation-only (18) enhancement (13) dependencies (12) release (11) documentation (10) refactoring (4) bug (3) auto-MCP-only (3) optimization (2) tests (2) github_actions (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 329 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 17
  • Total maintainers: 1
pypi.org: magic-cta-pipe

pipeline for the analysis of joint MAGIC+LST-1 data

  • Versions: 17
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 329 Last month
Rankings
Dependent packages count: 7.3%
Forks count: 15.4%
Average: 21.5%
Dependent repos count: 22.1%
Downloads: 30.7%
Stargazers count: 32.0%
Maintainers (1)
Last synced: 6 months ago

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
setup.py pypi
  • astropy >=4.0.5,<5
  • ctapipe *
  • ctapipe_io_magic *
  • ctaplot *
  • eventio >=1.5.1,<2.0.0a0
  • gammapy *
  • h5py *
  • ipykernel *
  • joblib *
  • lstchain *
  • matplotlib >=3.5
  • numba *
  • numpy *
  • pandas *
  • pyirf *
  • scikit-learn *
  • scipy *
  • seaborn *
  • setuptools_scm *
  • tables *
  • toml *
  • traitlets *
  • uproot *
environment.yml conda
  • black
  • corsikaio
  • ctapipe 0.12.*
  • cython
  • gammapy 0.19.0.*
  • graphviz
  • iminuit >=2
  • joblib
  • jupyterlab 3.5.0.*
  • nbsphinx
  • numpy 1.21.*
  • numpydoc
  • pandas
  • pip
  • pre-commit
  • protozfits 2.0.*
  • psutil
  • pytest
  • pytest-cov
  • pytest-runner
  • python 3.8.*
  • pyyaml
  • scikit-learn
  • sphinx
  • sphinx-automodapi
  • sphinx_rtd_theme
  • uproot ~=4.1
pyproject.toml pypi
docs/requirements.txt pypi
  • sphinx ==7.1.2
  • sphinx-rtd-theme ==1.3.0rc1