https://github.com/cta-observatory/cta-lstchain

LST prototype testbench chain

https://github.com/cta-observatory/cta-lstchain

Science Score: 59.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 5 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    13 of 37 committers (35.1%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.5%) to scientific vocabulary

Keywords from Contributors

astropy astronomy cta ctapipe lst-1 lstchain slurm particle agn blazar
Last synced: 6 months ago · JSON representation

Repository

LST prototype testbench chain

Basic Info
Statistics
  • Stars: 28
  • Watchers: 30
  • Forks: 78
  • Open Issues: 121
  • Releases: 72
Created almost 8 years ago · Last pushed 6 months ago
Metadata Files
Readme License

README.md

cta-lstchain CI DOI PyPI version Conda version

Repository for the low-level analysis of the LST up to DL3 level. The analysis is heavily based on ctapipe, adding custom code for mono reconstruction. Higher-level analysis starting from DL3 can be performed with Gammapy.

  • Source code: https://github.com/cta-observatory/cta-lstchain
  • Documentation: https://cta-observatory.github.io/cta-lstchain/

Note that notebooks are currently not tested and not guaranteed to be up-to-date.
In doubt, refer to tested code and scripts: basic functions of lstchain (reduction steps R0-->DL1, DL1-->DL2 and DL2-->DL3) are unit-tested and should be working as long as the build status is passing.

Install

You will need to install mamba/miniforge (recommended) or miniconda first.

As user

You can create an environment and install lstchain from conda-forge as: mamba create -c conda-forge -n lstchain-v0.10.7 python=3.11 lstchain=0.10.7

Alternatively, you can also install lstchain from PyPi with pip: LSTCHAIN_VER=0.10.7 (or the version you want to install - usually the latest release) wget https://raw.githubusercontent.com/cta-observatory/cta-lstchain/v$LSTCHAIN_VER/environment.yml conda env create -n lst -f environment.yml conda activate lst pip install lstchain==$LSTCHAIN_VER rm environment.yml

As developer

  • Create and activate the conda environment: git clone https://github.com/cta-observatory/cta-lstchain.git cd cta-lstchain conda env create -f environment.yml conda activate lst-dev

Note: To prevent packages you installed with pip install --user from taking precedence over the conda environment, run: conda env config vars set PYTHONNOUSERSITE=1 -n <environment_name>

To update the environment (e.g. when dependencies got updated), use: conda env update -n lst-dev -f environment.yml

  • Install lstchain in developer mode:

pip install -e .

To run some of the tests, some non-public test data files are needed. These tests will not be run locally if the test data is not available, but are always run in the CI.

To download the test files locally, run ./download_test_data.sh. It will ask for username and password and requires wget to be installed. Ask one of the project maintainers for the credentials. If you are a member of the LST collaboration you can also obtain them here:

https://ctaoobservatory.sharepoint.com/:i:/r/sites/ctan-onsite-it/Shared%20Documents/General/information_2.jpg?csf=1&web=1&e=suUkV6

To run the tests that need those private data files, add -m private_data to the pytest call, e.g.:

pytest -m private_data -v lstchain

To run all tests, run pytest -m 'private_data or not private_data' -v lstchain

Contributing

All contributions are welcomed.

Guidelines are the same as ctapipe's ones. See here for the general guidelines on how to make a pull request to contribute to the repository. Since the addition of the private data, the CI tests for Pull Requests from forks are not working, therefore we would like to ask you to push your modified branches directly to the main cta-lstchain repo. If you do not have writing permissions in the repo, please contact one of the main developers.

Report issue / Ask a question

Use GitHub Issues.

Cite

If you use lstchain in a publication, please cite the exact version you used from Zenodo Cite as, see https://doi.org/10.5281/zenodo.6344673

Please also cite the following proceedings by adding the bibtex entry:

@inproceedings{lstchain_adass_2020, author = "L\'opez-Coto, Rub\'en and others", collaboration = "CTA, LST Project", title = "{lstchain: An Analysis Pipeline for LST-1, the First Prototype Large-Sized Telescope of CTA}", journal = "ASP Conf. Ser.", volume = "532", pages = "357", year = "2022" }

Owner

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

open-source software for the CTA Consortium.

GitHub Events

Total
  • Fork event: 1
  • Create event: 48
  • Commit comment event: 3
  • Release event: 7
  • Issues event: 32
  • Watch event: 4
  • Delete event: 46
  • Member event: 3
  • Issue comment event: 238
  • Push event: 309
  • Pull request review comment event: 90
  • Pull request event: 81
  • Pull request review event: 146
Last Year
  • Fork event: 1
  • Create event: 48
  • Commit comment event: 3
  • Release event: 7
  • Issues event: 32
  • Watch event: 4
  • Delete event: 46
  • Member event: 3
  • Issue comment event: 238
  • Push event: 309
  • Pull request review comment event: 90
  • Pull request event: 81
  • Pull request review event: 146

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 3,862
  • Total Committers: 37
  • Avg Commits per committer: 104.378
  • Development Distribution Score (DDS): 0.807
Past Year
  • Commits: 394
  • Committers: 15
  • Avg Commits per committer: 26.267
  • Development Distribution Score (DDS): 0.82
Top Committers
Name Email Commits
Thomas Vuillaume t****e@l****r 746
Abelardo Moralejo Olaizola m****o@i****s 579
Ruben Lopez Coto r****o@g****m 507
Franca Cassol c****l@c****r 414
Maximilian Nöthe m****e@t****e 327
Chaitanya Priyadarshi c****i@i****s 258
Seiya Nozaki n****1@g****m 198
Daniel Morcuende d****n@u****s 184
Mab Bernardos m****s@g****m 129
Paweł Gliwny p****y@g****m 125
Gabriel Emery g****y@c****h 111
Maximilian Linhoff m****f@t****e 63
Jose Enrique Ruiz j****r@i****s 40
Enrique Garcia g****a@l****r 26
Luca Foffano l****o@c****h 24
Mykhailo Dalchenko m****o@c****h 20
Lab Saha l****a@u****s 13
Yves Renier y****r@u****h 11
Dominik Neise n****d@p****h 10
Lukas Nickel l****l@t****e 10
Mikael Jacquemont m****t@l****r 10
Daniel Morcuende d****e@i****s 9
Jouvin l****n@a****r 6
Thomas Gasparetto t****o@t****t 6
Julian Sitarek j****k@u****l 5
Roberta Pillera r****a@g****m 5
Cyril Alispach c****h@g****m 5
Franca Cassol f****l@c****g 4
Yukiho Kobayashi y****k@i****p 4
Andres Baquero o****o@u****s 3
and 7 more...

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 118
  • Total pull requests: 378
  • Average time to close issues: 4 months
  • Average time to close pull requests: 2 months
  • Total issue authors: 29
  • Total pull request authors: 24
  • Average comments per issue: 3.02
  • Average comments per pull request: 3.33
  • Merged pull requests: 297
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 34
  • Pull requests: 107
  • Average time to close issues: 16 days
  • Average time to close pull requests: 11 days
  • Issue authors: 12
  • Pull request authors: 10
  • Average comments per issue: 2.47
  • Average comments per pull request: 3.31
  • Merged pull requests: 79
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • morcuended (31)
  • moralejo (14)
  • vuillaut (13)
  • maxnoe (8)
  • gabemery (7)
  • SeiyaNozaki (7)
  • chaimain (4)
  • rlopezcoto (4)
  • LukasNickel (4)
  • mdebony (3)
  • katagirihide (2)
  • marialainez (2)
  • mireianievas (2)
  • FrancaCassol (2)
  • BastienLacave (1)
Pull Request Authors
  • moralejo (113)
  • morcuended (52)
  • maxnoe (37)
  • vuillaut (33)
  • FrancaCassol (25)
  • SeiyaNozaki (23)
  • gabemery (22)
  • chaimain (19)
  • rlopezcoto (14)
  • mdebony (6)
  • Bultako (5)
  • aaguasca (4)
  • Hckjs (4)
  • Mitsunari-Takahashi (3)
  • deborahDOR (3)
Top Labels
Issue Labels
bug (6) enhancement (5) good first issue (2) help wanted (2) question (1) duplicate (1) invalid (1)
Pull Request Labels
ready for review (13) bug (8) enhancement (4) maintenance (3) question (1) help wanted (1) workinprogress (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 2,750 last-month
  • Total dependent packages: 4
  • Total dependent repositories: 5
  • Total versions: 61
  • Total maintainers: 3
pypi.org: lstchain

Analysis chain for the CTA-LST prototype

  • Versions: 61
  • Dependent Packages: 4
  • Dependent Repositories: 5
  • Downloads: 2,750 Last month
Rankings
Dependent packages count: 2.4%
Forks count: 5.0%
Dependent repos count: 6.6%
Average: 7.1%
Downloads: 8.5%
Stargazers count: 12.9%
Last synced: 6 months ago

Dependencies

setup.py pypi
  • astropy *
  • bokeh *
  • ctapipe *
  • ctapipe_io_lst *
  • ctaplot *
  • eventio >=1.5.1,<2.0.0a0
  • gammapy *
  • h5py *
  • jinja2 *
  • joblib *
  • matplotlib *
  • numba *
  • numpy <1.22.0a0
  • pandas *
  • protobuf *
  • pyirf *
  • pymongo *
  • pyparsing *
  • scikit-learn *
  • scipy *
  • seaborn *
  • setuptools_scm *
  • tables *
  • toml *
.github/workflows/ci.yml actions
  • JamesIves/github-pages-deploy-action 3.7.1 composite
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v1 composite
  • mamba-org/provision-with-micromamba v14 composite
.github/workflows/deploy.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • pypa/gh-action-pypi-publish master composite
.github/workflows/release_drafter.yml actions
  • release-drafter/release-drafter v5 composite
pyproject.toml pypi
environment.yml pypi