slugpy 3.0.2

Overview of SLUG

This is version 3 of the Stochastically Lighting Up Galaxies (SLUG) code.

SLUG is a stellar population synthesis (SPS) code, meaning that for an input star formation history, stellar initial mass function, and a set of evolutionary tracks and stellar atmospheres, it can predict the light output of the stellar population. The main difference between SLUG and conventional SPS codes is that, instead of the usual approach of assuming that all stellar masses and ages are fully populated, SLUG is capable of stochastically sampling from the stellar initial mass function and age distribution, and thereby predicting not just the mean light output, nucleosynthetic yields, and feedback power, but also the full distribution that results from stochastic sampling. This capability is critical in the regime of low star formation rates and total stellar masses, where finite sampling can lead to a distribution of properties that is extremely broad, and the mean values produced by other SPS codes are therefore of limited predictive power.

Installation

The easiest way to install SLUG is from PyPI, which provides both the slugpy Python package and the slug command-line executable:

pip install slugpy
python -m slugpy.download_data

The second command downloads the stellar tracks, spectral libraries, and other data files SLUG needs, which are too large to include in the package (several GB). Prebuilt wheels are available for Linux (x86_64 and aarch64) and macOS 14+ on Apple Silicon, for Python 3.12–3.14; on other platforms pip builds SLUG from source.

SLUG is also available as a container image, with MPI support, for use with Docker or Apptainer/Singularity:

docker pull ghcr.io/markkrumholz/slug3:latest
apptainer pull slug3.sif docker://ghcr.io/markkrumholz/slug3:latest

Finally, you can clone this repository and build SLUG from source with CMake, which requires a C++23 compiler, GSL, and HDF5.

See the installation instructions and the quickstart guide in the documentation for full details on all three options.

Version history

This is version 3 of SLUG. It is a complete rewrite of version 2, taking advantage of modern C++ and Python capabilities to significantly improve its usability. It also greatly expands the range of stellar tracks, atmospheres, nucleosynthetic yield tables, and feedback models available, incorporating advances that have occurred since the last release. Additional major improvements in this version include:

• The ability to drive SLUG entirely from Python, as well as the traditional command line interface.
• Metallicity is now a first-class variable, which can be treated stochastically and described by a distribution.
• Native support for hybrid MPI + OpenMP parallelism.
• A modernized build system that greatly reduces the number of external dependencies and makes building the code across platforms significantly easier.
• Output has been migrated from the FITS format used in version 2 to HDF5 format, allowing significantly faster and more flexible IO.
• The input format has been simplified and converted to the TOML standard, providing a more intuitive way of controlling the code.
• A larger, modernized set of stellar tracks, atmospheres, and photometric filters, and standardization of the formats for describing these and other data inputs so that users can easily add additional data without needing to alter the source code.

Version 2 of SLUG remains available at https://bitbucket.org/krumholz/slug2/. As of this writing there are some capabilities in SLUG version 2 that have not yet been re-implemented in this version, and while this remains true SLUG version 2 will continue to be maintained. However, version 2 is no longer being developed, and eventually all capabilities it provides will be migrated to this version, at which point maintenance on SLUG version 2 will be discontinued. Users are therefore encouraged to migrate to this version.

Documentation

See https://markkrumholz.github.io/slug3/ for full documentation, including detailed instructions on compiling and running the code.

Layout of this repository

This repository is structured as follows:

• .github: GitHub workflows
• cmake: helper CMake build files
• data: data files, divided by type of data
  • data/cloudy: template files for the SLUG-Cloudy interface
  • data/elem: elemental and atomic data
  • data/extinct: extinction curves
  • data/filters: filter response curves and similar data
  • data/imfs: stellar initial mass functions
  • data/nebular: tabulated nebular emission
  • data/spectra: stellar atmosphere and spectral library data
  • data/tools: scripts for fetching and manipulating data
  • data/tracks: libraries of stellar evolutionary tracks
  • data/yields: libraries of nucleosynthetic yields
• doc/sphinx: documentation
• examples: example applications of SLUG, each in a separate subdirectory
• slugpy: the Python frontend for SLUG
  • slugpy/cloudy: the interface between SLUG and Cloudy
• src: the main C++ codebase
  • src/core: the core C++ classes that run the simulation
  • src/elem: elemental, isotopic, and atomic data
  • src/extern: external dependencies
  • src/extinct: extinction physics
  • src/feedback: stellar feedback physics
  • src/interpolation: low-level interpolation machinery
  • src/io: input/output management
  • src/nebular: nebular emission physics
  • src/pdfs: low-level mathematical description of probability distribution functions
  • src/phot: photometry and filter calculations
  • src/pybind: C++ / Python binding layer
  • src/specsyn: spectral synthesis and stellar atmosphere routines
  • src/tracks: stellar evolutionary track routines
  • src/utils: miscellaneous utilities
  • src/yields: calculation of nucleosynthetic yields
• tests: unit tests; the subdirectory structure mirrors that of src (except for the vendored src/extern), plus tests/slugpy for the Python frontend and tests/mpi for end-to-end MPI tests

Contact

If you have questions about SLUG, have discovered any bugs, or want to contribute to ongoing development, please contact Mark Krumholz, mark.krumholz@anu.edu.au.