SedTRAILS

Sediment TRAnsport vIsualization and Lagrangian Simulator.

SedTRAILS is an open-source Python package for modeling sediment transport that uses Lagrangian particle tracking to simulate sediment pathways in coastal and estuarine environments. The current version is a beta release, bugs and issues are expected. Please report any problems you encounter on the GitHub Issues page

Features

• Lagrangian particle tracking for sediment transport simulation.
• Dashboard for interactive visualization of simulation results in real-time.
• Support for Delft3D Flexible Mesh (D3D-FM) hydrodynamic model outputs.
• Support for various physics convertion methods.
• Terminal user interface (CLI) for easy setup and execution of simulations.
• Modular design for easy integration and extension.
• Comprehensive documentation and examples.

Installation

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

2. Change to the sedtrails directory:

cd sedtrails

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

4. Verify the installation by running:

sedtrails --version

# You should see the installed version number.
# E.g.: SedTRAILS 1.0.0-beta.0

Contributing Guidelines

We welcome contributions from the community! Read the contributing guidelines to know how can you take part in developing SedTRAILS.

License

SetTRAILS is licensed under the MIT License. © (2025) SedTRAILS Team, Delft, The Netherlands.

Citation

Pearson, S. G., Reyns, J., Garcia Alvarez, M. G., Urhan, A., van Westen, B., Pannozzo, N., & Shafiei, H. SedTRAILS (Version 1.0.0-beta.0) [Computer software]

Author Contributions

Role	Author
Conceptualization	Garcia Alvarez, M., Pannozzo N., Pearson, S. G., Reyns J., Shafiei, H., Urhan, A., & van Westen, B.
Project management	Garcia Alvarez, M., & Pearson, S. G.
Investigation	Pannozzo N., Pearson, S. G., Reyns J., Shafiei, H., & van Westen, B.
Software	Garcia Alvarez, M., Pannozzo N., Pearson, S. G., Reyns J., Shafiei, H., Urhan, A., & van Westen, B.
Visualization	Pearson, S. G., & van Westen, B.
Supervision	Garcia Alvarez, M., Pearson, S., & Reyns, J.
Funding acquisition	Pearson, S. G., & Reyns J.

Acknowlegdements

• The design and development of SedTRAILS Software was supported by the Digital Competence Centre, Delft University of Technology.
• We want to thank Monica Aguilera Chaves from Deltares for partcipating in the initial design discussions of SedTRAILS.