Getting Started

Dependencies

Package	Required	Notes
C99 compiler (gcc or clang)	Yes
GSL	Yes	required for tests
HDF5	Optional	HDF5 tree reading and output
MPI	Optional	parallel execution

Build

git clone https://github.com/MBradley1985/SAGE26.git
cd SAGE26
make                   # serial build -- produces ./sage and libsage.so
make USE-MPI=yes       # MPI-parallel build
make USE-HDF5=yes      # enable HDF5 support
make MEM-CHECK=yes     # address/UB sanitizers for debugging (gcc only)
make clean             # remove all build artefacts

First run

On a fresh clone, run first_run.sh to create the output directories and download the Mini-Millennium test trees (~50 MB):

./first_run.sh

Running the model

# Serial
./sage input/millennium.par

# MPI parallel
mpirun -np 4 ./sage input/millennium.par

# Run all microuchuu parameter variants in parallel (logs to logs/)
./run_microuchuu_local.sh

Output is written to the OutputDir specified in the parameter file (default output/millennium/). With OutputFormat sage_hdf5 each snapshot produces a model_N.hdf5 file containing one dataset per galaxy property.

Plotting

Python plotting scripts are in plotting/. Install dependencies with:

pip install -r requirements.txt

Then:

python plotting/allresults-local.py                       # z=0 diagnostics
python plotting/allresults-local.py path/to/output/       # specify output dir
python plotting/allresults-history.py                     # multi-redshift diagnostics
python plotting/paper_plots.py                            # all paper figures
python plotting/paper_plots.py 1 3 5                      # specific figure numbers

Tests

cd tests && make test               # build and run all suites
cd tests && make test_conservation  # conservation tests only (fastest)
cd tests && make quick              # single fastest check
bash tests/run_integration_tests.sh # full integration test (slower)

The regression baseline verifies that output is bit-identical across 5380 datasets:

bash tests/regression_baseline.sh

After any physics change, recapture the baseline with:

python3 tests/regression_baseline.py capture input/millennium.par