Installation#

Requirements#

  • Python >= 3.11

  • pip, the Python package manager

It is always recommended to work from a virtual environment.

Users#

Important

This type of installation is not yet available. A Python package on PyPI and on the conda-forge channel are planned.

Developers#

  1. clone the project’s repository and enter it

  2. create a virtual environment

  3. install the package in development mode

    pip install -e '.[dev]'

Tip

Any Python virtual environment can be used.

If you like to use conda or mamba, (the miniforge distribution is recommended) you can create a virtual environment with the following environment file, which you can find also in the root of the cloned repository.

mamba env create -f environment.yml

# To create this environment:
# conda env create -f environment.yml
# or mamba env create -f environment.yml
name: iact-estimator
channels:
  - conda-forge
dependencies:
  - python
  - pip
  - astroplan
  - astropy<6 # see https://github.com/gammapy/gammapy/issues/4972
  - gammapy
  - seaborn
  - scipy=1.11* # see https://github.com/gammapy/gammapy/pull/4997
  # Documentation
  - furo
  - ipywidgets
  - myst-nb
  - numpydoc
  - rstcheck
  - sphinx-argparse
  - sphinx-autoapi
  - sphinx-copybutton
  - sphinxcontrib-towncrier
  # Testing
  - pytest
  - pytest-console-scripts
  # Development
  - pre-commit
  - ruff