Quick Start: Installation

  1. Create a virtual environment - choose one of the following options:

    Option A: Python venv

    python3 -m venv mydsi
    source mydsi/bin/activate           # start here if virtual environment exists
    pip install --upgrade pip
    

    Option B: Miniconda3

    . ~/miniconda3/bin/activate
    conda create -n mydsi python=3.11
    conda activate mydsi                # start here if virtual environment exists
    

    Option C: uv

    uv venv
    source .venv/bin/activate
    
  2. Install DSI

    Option A: Alpha version (From source)

    git clone https://github.com/lanl/dsi.git
    cd dsi
    
    pip install . -r requirements.txt
    
    # uv alternative
    uv pip install . -r requirements.txt
    

    Option B: Supported release

    Published versions are available on PyPI:

    pip install dsi-workflow
    
    # uv alternative
    uv pip install dsi-workflow
    
  3. (Optional) Install additional dependencies

    pip install -r requirements.extras.txt
    pip install -r requirements.heavy.txt
    
    # uv alternative
    uv pip install -r requirements.extras.txt
    uv pip install -r requirements.heavy.txt
    
  4. Deactivate the environment

    deactivate