Science Score: 67.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
Found 5 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.6%) to scientific vocabulary
Repository
Analysis Software for GAmma-Ray Data in Python
Basic Info
- Host: GitHub
- Owner: chaimain
- License: apache-2.0
- Language: Jupyter Notebook
- Default Branch: main
- Homepage: https://asgardpy.readthedocs.io/en/latest/
- Size: 69.5 MB
Statistics
- Stars: 22
- Watchers: 1
- Forks: 0
- Open Issues: 1
- Releases: 17
Metadata Files
README.md
Agardpy: Analysis Software for GAmma-Ray Data in Python
'User-friendly' configuration-centred pipeline built over Gammapy to allow for easy simultaneous analysis of various datasets of different formats.
Example: 3D Fermi-LAT (with various source models in the Region of Interest stored in XML file) + 1D energy-dependent directional cuts MAGIC/LST [PointSkyRegion geometry for ON region] + 1D global directional cut VERITAS [CircleSkyRegion geometry for ON region].
Follow the documentation at https://asgardpy.readthedocs.io/en/latest/ for the main functionality of this pipeline. Follow the Gammapy v1.3 documentation for understanding the core Gammapy objects.
Check this documentation page for seeing the list of reasons to use Asgardpy over Gammapy v1.3 and this documentation page for seeing an extended example of the usage of Asgardpy in analyzing multi-instrument data of Crab Nebula.
The various Data Levels used here follow the descriptions suggested by GADF v0.3 and CTAO Data Model.
NOTE
For requiring support only for Gammapy v1.1, one may follow the latest Hotfix release v0.4.4 which benefits from the correct usage of getting EBL-deabsorbed data products as included in v0.5.0. This can be done by using
bash
git fetch --tags
git switch -c tags/v0.4.4
For creating a conda environment, for this Hotfix release, one can use
bash
conda env create -f environment_0.4.4.yml
and in general, for the latest release,
bash
conda env create -f environment.yml
This method was included after v0.5.0, and for earlier (<v0.4.4) releases, one can simply use the gammapy conda environment and install asgardpy on top of it.
Pipeline development
The pipeline was developed with first testing with Fermi-LAT (enrico and fermipy) files and LST-1 (cta-lstchain) DL3 files (with energy-dependent and global directional cuts) for point-like sources. It also allows for a preliminary analysis of HAWC datasets (stored in Gammapy-readable data). The pipeline can be further expanded to support more types of DL3 files of gamma-ray instruments.
Examples with Data
An example of configuration file that can be used with asgardpy can be found at asgardpy/config/template.yaml
For working with some public data to check the pipeline functionality, one should first download the public dataset available with Gammapy as indicated in Gammapy v1.3 Introduction and then run the scripts/download_asgardpy_data.sh script to add datasets for the full usage of the pipeline.
Examples of usage of Asgardpy is shown in jupyter notebooks.
Cite
If you use Asgardpy in a publication, please cite the exact version you used from Zenodo Cite as https://doi.org/10.5281/zenodo.8106369
Pipeline Template
Pipeline generated based on the template by python-package-template with additional standards being followed -
Owner
- Name: Chaitanya Priyadarshi
- Login: chaimain
- Kind: user
- Location: Barcelona, Spain
- Company: IFAE
- Website: https://orcid.org/0000-0002-9160-9617
- Repositories: 7
- Profile: https://github.com/chaimain
PhD researcher, MAGIC and CTA-LST @cta-observatory
Citation (CITATION.cff)
# Metadata for citation of this software according to the CFF format (https://citation-file-format.github.io/) cff-version: 1.2.0 title: 'Asgardpy: Gammapy-based pipeline to support high-level analysis for multi-instruments joint datasets' abstract: 'User-friendly configuration-centred pipeline built over Gammapy to allow for easy simultaneous analysis of various datasets of different formats. Example: 3D Fermi-LAT (with various source models in the Region of Interest stored in XML file) + 1D energy-dependent directional cuts MAGIC/LST [PointSkyRegion geometry for ON region] + 1D global directional cut VERITAS [CircleSkyRegion geometry for ON region]' type: software message: "If you use this software, please cite it using the metadata from this file." url: "https://asgardpy.readthedocs.io/en/latest/" doi: 10.5281/zenodo.8106369 keywords: - Astronomy - "Gamma-rays" - "Data analysis" version: v0.5.3 repository-code: "https://github.com/chaimain/asgardpy" license: Apache-2.0 contact: - email: chaitanya.p.astrphys@gmail.com name: "Project manager" authors: - given-names: Chaitanya family-names: Priyadarshi affiliation: "Instytut Fizyki Jądrowej - Polskiej Akademii Nauk, Kraków, Poland" orcid: "https://orcid.org/0000-0002-9160-9617" - given-names: Mireia family-names: Nievas Rosillo affiliation: "Instituto de Astrofísica de Canarias, San Cristobal de La Laguna, Canarias, Spain" orcid: "https://orcid.org/0000-0002-8321-9168" data_released: 2024-10-29
GitHub Events
Total
- Create event: 13
- Release event: 2
- Issues event: 18
- Watch event: 1
- Delete event: 12
- Issue comment event: 28
- Push event: 35
- Pull request event: 31
Last Year
- Create event: 13
- Release event: 2
- Issues event: 18
- Watch event: 1
- Delete event: 12
- Issue comment event: 28
- Push event: 35
- Pull request event: 31
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 30
- Total pull requests: 204
- Average time to close issues: about 1 month
- Average time to close pull requests: 6 days
- Total issue authors: 3
- Total pull request authors: 2
- Average comments per issue: 0.3
- Average comments per pull request: 0.75
- Merged pull requests: 180
- Bot issues: 0
- Bot pull requests: 48
Past Year
- Issues: 8
- Pull requests: 32
- Average time to close issues: 30 days
- Average time to close pull requests: 1 day
- Issue authors: 1
- Pull request authors: 2
- Average comments per issue: 0.5
- Average comments per pull request: 0.94
- Merged pull requests: 29
- Bot issues: 0
- Bot pull requests: 3
Top Authors
Issue Authors
- chaimain (28)
- mireianievas (1)
- moralejo (1)
Pull Request Authors
- chaimain (156)
- dependabot[bot] (48)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 124 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 16
- Total maintainers: 1
pypi.org: asgardpy
Gammapy-based pipeline for easy joint analysis of different gamma-ray datasets
- Homepage: https://github.com/chaimain/asgardpy
- Documentation: https://asgardpy.readthedocs.io/en/latest/
- License: Apache-2.0
-
Latest release: 0.5.3
published about 1 year ago
Rankings
Maintainers (1)
Dependencies
- actions/cache v2 composite
- actions/setup-python v4 composite
- ./.github/actions/setup-venv * composite
- actions/checkout v3 composite
- actions/download-artifact v3 composite
- actions/setup-python v4 composite
- actions/upload-artifact v3 composite
- softprops/action-gh-release v1 composite
- actions/checkout v3 composite
- release-drafter/release-drafter v5 composite
- actions/checkout v4 composite
- andstor/file-existence-action v2 composite