Quickstart Setup

The best way to get started and learn Gammapy are the Tutorials. For convenience we provide a pre-defined conda environment file, so you can get additional useful packages together with Gammapy in a virtual isolated environment. First install Miniconda and then just execute the following commands in the terminal:

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

Note

On Windows, you have to open up the conda environment file and delete the lines with sherpa and healpy. Those are optional dependencies that currently aren’t available on Windows.

Note

For Apple silicon M1 (arm64) architectures you also have to open the environment file and delete the sherpa entry, as currently there are no conda packages available. However you can later install sherpa in the environment using python -m pip install sherpa.

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

$ conda activate gammapy-1.0

You can now proceed to download the Gammapy tutorial notebooks and the example datasets. The total size to download is ~180 MB. Select the location where you want to install the datasets and proceed with the following commands:

$ gammapy download notebooks
$ gammapy download datasets
$ export GAMMAPY_DATA=$PWD/gammapy-datasets/1.0

You might want to put the definition of the $GAMMAPY_DATA environment variable in your shell profile setup file that is executed when you open a new terminal (for example $HOME/.bash_profile).

Note

If you are not using the bash shell, handling of shell environment variables might be different, e.g. in some shells the command to use is set or something else instead of export, and also the profile setup file will be different. On Windows, you should set the GAMMAPY_DATA environment variable in the “Environment Variables” settings dialog, as explained e.g. here

Finally start a notebook server by executing:

$ cd notebooks
$ jupyter notebook

If you are new to conda, Python and Jupyter, maybe also read the Using Gammapy guide. If you encountered any issues you can check the Troubleshooting guide.