Installation Instructions

jasercion edited this page Oct 29, 2018 · 15 revisions

The current version of the Fermitools is: 1.0.0 Release Date: 10/15/18

Introduction

As part of a major development cycle overhaul undertaken by the FSSC and the LAT software development team at SLAC the Fermitools (formally ScienceTools) will, as of release v11r06p03, be distributed via the Conda package management system. This decision was made to improve the user experience by allowing Conda to handle the installation and setup of third-party dependencies thereby greatly reducing the library mismatch and version incompatibility errors that make up a significant percentage of technical bug reports. Migrating to Conda also simplifies the Fermitools release process and allows users to update the tools via a simple update command as opposed to re-installing the entire package. Fermitools via Conda will facilitate a quicker software patch/release cycle and a smoother user experience.

Installing the Fermitools

In order to obtain the Fermitools you must first install and set up the Anaconda distribution of Python.

Setting up Conda

In order to obtain the Fermitools the Anaconda distribution of python first needs to be installed. Anaconda is distributed in two different formats: Anaconda and Miniconda. The FSSC recommends using Miniconda, as it is more lightweight, but either version will work.

Launch the downloaded installer and follow the instructions to install Anaconda on your system.

C Shell/TC Shell Users

After installation C Shell and TC Shell users must append the following to their ~/.cshrc or ~/.tcshrc file:

source </path/to/conda>/etc/profile.d/conda.csh

Where </path/to/conda> is replaced with the path to the top level directory of the Anaconda installation (typically named something like "Miniconda2"). The conda.csh script sourced in the above line will allow Conda environments to activate properly when run in C Shell/TC Shell. You will need to re-source your .cshrc or .tcshrc file to ensure that the change takes effect in your current terminal session.

Installing the Fermitools

The Fermitools are hosted on an Anaconda Cloud channel maintained by the Fermi team. They can be downloaded and installed into their own Conda environment via the command:

conda create -n fermi -c conda-forge -c fermi fermitools

This command will create a conda environment named fermi and will download/install precompiled binaries of the Fermitools and their dependencies into it. conda-forge and fermi are the names of the channels that host the software.

Once this process is complete, use the following command to activate the environment:

Bash Shell Csh/Tcsh
source activate fermi conda activate fermi

This command will activate the fermi environment in your shell with the Fermitools setup and ready to go. To exit the fermi environment use the following command:

Bash Shell Csh/Tcsh
source deactivate fermi conda deactivate fermi

NOTE: If you install any extra software into the fermi environment via conda install it will be isolated to this environment. Please keep this in mind. For more information, please read the Conda documentation on managing environments.

Obtaining a specific version

If you need to install a specific version of the Fermitools, you can specify the version by setting the name of the package equal to the version number, like so:

conda create -n fermi -c conda-forge -c fermi fermitools=<VERSION>
or
conda install -c conda-forge -c fermi fermitools=<VERSION>

Where <VERSION> is whatever version number you need to grab. Note that in order to obtain a specific version of the Fermitools in this manner it MUST be available in the fermi Anaconda Cloud channel.

Updating Existing Installation

To update an existing Fermitools installation simply activate the environment that the Fermitools are installed in (usually named fermi) and run the following 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.

Bash Shell Csh/Tcsh
source activate fermi conda activate fermi
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.