https://github.com/cta-observatory/iact-estimator

Estimate the observability properties of a source with an IACT system

https://github.com/cta-observatory/iact-estimator

Science Score: 13.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
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.3%) to scientific vocabulary

Keywords

iact observation proposals
Last synced: 9 months ago · JSON representation

Repository

Estimate the observability properties of a source with an IACT system

Basic Info
Statistics
  • Stars: 2
  • Watchers: 3
  • Forks: 0
  • Open Issues: 26
  • Releases: 0
Topics
iact observation proposals
Created over 2 years ago · Last pushed 12 months ago
Metadata Files
Readme Codeowners

README.md

IACT Telescopes estimator

CI

docs

iact-estimator is a Python3-based package that allows the estimation of the performance of an IACT telescope system to detect a gamma-ray source.

It started from legacy scripts which were developed by Dr. Julian Sitarek for the MAGIC telescopes to aid users in preparing their observational proposals.

Installation

For the moment there is no public packaged release.

  1. clone the repository
  2. (recommended) create a virtual environment (a conda environment file is provided)
  3. pip install -e . (if you are a developer add [dev])

Usage

You can use the package using the available command line entry points.

Assuming you are working from a directory called project

  1. get the default configuration file with iact-estimator config
  2. launch the estimation with iact-estimator run --config config.yml --source-name "Crab Nebula"

[!NOTE] Currently the source name must be a valid identifier from the SIMBAD, NED or VizieR databases.

For more details use the -h option to show the help menu.

The package is also a library, so you can use it to make your scripts or in a notebook (see example notebook in the documentation).

The packaged data can be extended to other IACT systems, provided the data has been published.

The support to load your own data files will be provided.

Documentation

Documentation can be compiled locally after a successful installation,

  1. make -C docs html
  2. open docs/build/html/index.html with your favourite browser

How to contribute

This project is public and everyone can contribute to it.

Instructions on how to contribute to the project are provided in the documentation.

Owner

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

open-source software for the CTA Consortium.

GitHub Events

Total
  • Issues event: 4
  • Delete event: 2
  • Issue comment event: 17
  • Push event: 44
  • Pull request review event: 2
  • Pull request review comment event: 5
  • Pull request event: 10
  • Create event: 7
Last Year
  • Issues event: 4
  • Delete event: 2
  • Issue comment event: 17
  • Push event: 44
  • Pull request review event: 2
  • Pull request review comment event: 5
  • Pull request event: 10
  • Create event: 7

Dependencies

.github/workflows/changelog.yml actions
  • actions/checkout v4 composite
  • andstor/file-existence-action v3 composite
.github/workflows/ci.yml actions
  • JamesIves/github-pages-deploy-action v4.5.0 composite
  • actions/checkout v4.1.1 composite
  • actions/checkout v4 composite
  • actions/setup-python v5.0.0 composite
  • actions/setup-python v5 composite
  • mamba-org/setup-micromamba v1 composite
  • pre-commit/action v3.0.1 composite
pyproject.toml pypi
  • astroplan *
  • astropy <6
  • gammapy *
  • scipy <1.12
  • seaborn *
environment.yml pypi