-
Notifications
You must be signed in to change notification settings - Fork 17
Quickstart Guide
The Fermitools and associated data files are distributed via precompiled packages which are hosted on an Anaconda Cloud channel named fermi_dev_externals. In order to obtain/run the Fermitools you must, at a minimum, have the following system requirements:
- OS: MacOS or Linux
- Anaconda Python 3 (either the full Anaconda Python distribution or the lightweight MiniConda distribution)
Fermitools have migrated to Python 3. If you are updating a current installation of the tools it is necessary to perform a fresh installation in a new Python 3 environment. Running update on an existing Python 2 based installation has been known to cause problems.
Once you have downloaded and installed Anaconda, use the following command to download and setup your Fermitools environment:
conda create -n fermi -c conda-forge -c fermi fermitools numpy=1.20
This command will create a conda environment named fermi and install the Fermitools and dependencies (including Fermitools-data) into the fermi environment. Specifying, the numpy version is currently required to avoid a problem with deprecated data types (see Issue 143).
To enable the Fermitools run:
conda activate fermi
This command activates the environment and runs the necessary activation scripts for the Fermitools. You will be dropped into the fermi conda environment with the Fermitools setup and ready to go!
If you are using the Fermitools within csh or tcsh you need to take an extra step to set up your conda environment. At the bottom of your ~/.cshrc or ~/.tcshrc file append the following command on a new line:
source </path/to/conda>/etc/profile.d/conda.csh
Where </path/to/conda> is replaced with the path to your installation of anaconda2 or miniconda (for example /foo/bar/anaconda2/ or /foo/bar/miniconda2/). You will need to re-source your .cshrc or .tcshrc file to make sure that the change takes effect in your current shell.
These instructions DO NOT APPLY when updating from Fermitools 1.* to Fermitools 2.*. Fermitools 2.* must be installed in a new Python 3 environment.
If you already have an existing installation of the Fermitools on your machine, you can update by activating the conda environment (usually named fermi) the tools are installed in and running the conda update command.
conda update -c conda-forge -c fermi fermitools
This will grab and install the most recent compatible version of Fermitools from the fermi release channel. After updating re-activate the conda environment to ensure that any changes to the activation script are properly sourced.
conda activate fermi
The IRFs and isotropic templates are stored in the fermitools-data package. If you need to update those then run the following command with your fermi environment activated:
conda update -c conda-forge -c fermi fermitools-data
If you have trouble with the installation, first check the troubleshooting page for possible solutions. If you continue to have problems please see the error reporting page for instructions on how to report the issue to the Fermitools team.