Installation

FASTSim is available as a package for use in Python 3.10 through 3.15.

For the quickest start, install from PyPI. Install from source if you are developing FASTSim or need unreleased changes.

Install from PyPI (recommended)¶

In an active Python environment, run:

pip install fastsim

This will install the latest release of FASTSim as a Python package.

See Next Steps for further resources.

Install from Source (advanced)¶

First, clone the repository:

git clone https://github.com/NatLabRockies/fastsim.git
cd fastsim

Then, install Rust and build FASTSim. FASTSim’s backend is written entirely in Rust, so it is required to build from source.

• Option A: Pixi (recommended)

  Pixi manages the Rust toolchain and Python dependencies for you. After installing pixi, compile FASTSim with a release profile build and an editable Python package:

  pixi install

  Run pixi install -e dev instead to use the developer environment, which compiles faster using the debug profile, at the cost of runtime performance.

• Option B: Manual

  Install Python using your environment manager of choice, then install the Rust toolchain, e.g. using rustup:

  curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

  Then, compile FASTSim with maturin via pip.

  pip install -e .

  Run pip install -e . --group dev instead to install with developer dependencies.

For more detail on developer builds or alternate pixi environments, see Environment Setup.

Next Steps¶

See the following resources: