Installation

SedTRAILS is currently on its beta version. Users are welcome to test it, but compatibility might break in future versions. Its use in research requires discretion. We aim for an official release by February 2026.

Requirements:

SedTRAILS is tested on Python 3.13 and above, but it is likely to work with Python 3.10 and above.

Using pip

You can install the latest beta version directly from PyPI using pip. Check the releases page for the latest version (x).

pip install sedtrails=1.0.0-beta.x

From source

To install SedTRAILS from source, follow these steps:

  1. Clone the repository:

git clone https://github.com/sedtrails/sedtrails.git

  1. Change to the sedtrails directory:

cd sedtrails

  1. Install the package using pip or conda:

# For pip
pip install .

# For conda
# Create and activate the conda environment
conda env create -f environment.yml
conda activate sedtrails

Confirming the installation

Writing the following command in the terminal will show the installed SedTRAILS version:

sedtrails -v
# E.g.: SedTRAILS 1.0.0-beta.0

The following command provides help about the SedTRAILS commands:

sedtrails -h

Check the Simulations Guide to learn how to set up and run a simulation.