Installation¶

Requirements¶

Python >= 3.10
A SAGE26 or SAGE-PSO output directory (HDF5 format) and lhalo_binary merger trees

From source (recommended until v1.0 PyPI release)¶

git clone https://github.com/MBradley1985/SAGE-Viewer
cd SAGE-Viewer
pip install -e ".[dev]"

Verifying the install¶

sage-viewer --version

Remote / HPC installation¶

A helper script is included for module-system clusters (Slurm, PBS, etc.):

# Load a Python module first (name varies by cluster)
module load python/3.12.0

# Create a venv and install SAGE-Viewer in one step
./install_hpc.sh

# Optional: place the venv on scratch for faster I/O
./install_hpc.sh /scratch/$USER/sage-viewer-env

The install is editable (pip install -e .) so git pull updates the code immediately with no reinstall. ffmpeg is checked separately — load it via your module system if you need MOV recording.

In every subsequent session:

source .venv/bin/activate
sage-viewer --par /path/to/millennium.par --port 8080

Then use SSH port-forwarding to view in your local browser:

# In a local terminal
ssh -L 8080:localhost:8080 user@cluster
# Open http://localhost:8080

Dependencies¶

Package	Purpose
pyvista	3D rendering (VTK wrapper)
trame	Web UI server
trame-vtk	Streams PyVista render window to browser
trame-vuetify	Vuetify 3 UI components
h5py	Reads SAGE HDF5 galaxy output
numpy	Array operations
scipy	KDE density computation, KDTree navigation
joblib	Parallel halo file loading