Skip to content

Quickstart Guide

Jump to bottom
jasercion edited this page Jun 1, 2018 · 34 revisions

Fermitools 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:

System Requirements

  • OS: MacOS or Linux (Currently the FSSC supports MacOS Sierra/High Sierra, Ubuntu XX.XX, Fedora XX.XX and Scientific Linux XX
  • Anaconda Python 2.7 version 4.4.0 or above (Full Anaconda Python distribution can be obtained here or the lightweight MiniConda distribution can be obtained here)

Addendum for csh/tcsh Users

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

Once you have downloaded and installed Anaconda, use the following two commands to download and setup your Fermitools environment:

conda create -n fermi -c conda-forge -c fermi_dev_externals fermitools
source activate fermi (csh/tcsh users use conda activate fermi)

The first command will create a conda environment named fermi and install the Fermitools and the Fermitool's dependencies (including Fermitools-data) into the fermi environment. The second 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!

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 on Conda environments please read the documentation located here.

Clone this wiki locally