Quick Start

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:

  • Python 3.10 and above. Python 3.13 is recommended.

  • Operating system: Windows, macOS, or Linux.

Installation

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

Test 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.