Installation

Stable (with Anaconda)

This is our recommend installation method! Follow the steps below to start using Spotlight!

1. You will need the Anaconda environment software. To download Anaconda follow the instructions here: https://docs.anaconda.com/anaconda/install/

2. Download the environment_rietveld.yaml file from our repository.

3. Create a new conda environment using the environment_rietveld.yaml file. There are two important things to note during this step. You will also need to set MAUD_PATH to our MAUD installation in order to do the parts of this tutorial that use MILK and MAUD.

   # /bin/bash
   
   set -e 
   
   # install and load Anaconda env
   conda env create -f environment_rietveld.yaml
   conda activate spotlight-rietveld
   
   # set path to MAUD for MILK
   export MAUD_PATH=/path/to/my/Maud.app
   

4. Activate the environment by running the following command.

   conda activate spotlight-rietveld
   

You should have Spotlight installed now! Following the remainder of this tutorial to become familiar with using Spotlight.

Development (from GitHub)

Warning

This will retrieve the latest version under development. Use at your own risk!

1. The latest development version is available directly from our `GitHub Repo<https://github.com/lanl/spotlight>`_. First, clone the repository like the following.

   git clone https://github.com/lanl/spotlight
   cd spotlight
   

2. Next, we recommend that you create a Conda environment since you will still need the dependencies. You can create an empty Anaconda by running the following.

   conda create --name spotlight-rietveld
   

3. And then activate the environment with the following.

   conda activate spotlight-rietveld
   

4. Now install Spotlight using pip like the following.

   pip install .
   

You should have Spotlight installed now!