Virtual Environments

We recommend to create an isolated virtual environment for each version of Gammapy, so that you have full control over additional packages that you may use in your analysis. This will also help you on improving reproducibility within the user community.

Conda Environments

For convenience we provide, for each stable release of Gammapy, a pre-defined conda environment file, so you can get additional useful packages together with Gammapy in a virtual isolated environment. First install Miniforge, and then just execute the following commands in the terminal:

curl -O https://gammapy.org/download/install/gammapy-|release|-environment.yml
conda env create -f gammapy-|release|-environment.yml

Note

On Windows, you have to open up the conda environment file and delete the line with healpy. This is an optional dependency that currently isn’t available on Windows.

Note

To avoid some installation issues, sherpa is not part of the environment file provided. You can nevertheless install sherpa in your environment using python -m pip install sherpa.

Once the environment has been created you can activate it using:

conda activate gammapy-|release|

To create a new custom environment for your analysis with conda you can use:

conda env create -n my-gammapy-analysis

And activate it:

conda activate my-gammapy-analysis

After that you can install Gammapy using conda / mamba as well as other packages you may need.

conda install gammapy ipython jupyter

To leave the environment, you may activate another one or just type:

conda deactivate

If you want to remove an virtual environment again you can use the command below:

conda env remove -n my-gammapy-analysis

It also recommended to create a custom environment.yaml file, which lists all the dependencies and additional packages you like to use explicitly. More detailed instructions on how to work with conda environments can be found in the conda documentation for managing environments.

Venv Environments

You may prefer to create your virtual environments with Python venv command instead of using Anaconda. To create a virtual environment with venv (Python 3.5+ required) run the command:

python -m venv my-gammapy-analysis

which will create one in a my-gammapy-analysis folder. To activate it:

./my-gammapy-analysis/bin/activate

After that you can install Gammapy using pip as well as other packages you may need.

pip install gammapy ipython jupyter

To leave the environment, you may activate another one or just type:

deactivate

More detailed instructions on how to work with virtual environments you can find in the Python documentation.