sedtrails 1.0.0a2

Sediment TRAnsport vIsualization and Lagrangian Simulator.

SedTRAILS

Sediment TRAnsport vIsualization and Lagrangian Simulator.

Installation

SedTRAILS requires Python 3.12 and above, but it is likely to work with Python 3.10 and above.

1. Clone the repository:

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

2. Change the directory:

cd sedtrails

3. Install the dependencies:

pip install .

Software Architecture

The diagrams/c4 directory was obtained from the C4-PlantUML GitHub repository. The directory contains some of the files required to run PlantUML, as well as a short README.md that explains how to use the library.

Requirements

• Java
• GraphViz

You can read more about the PlantUML syntax on the PlantUML documentation. They provide extensive support, which may be an overkill at the moment.

• If you have the requirements already installed, you can simply clone the repository and get started.
• TL;DR: the basic command to save your diagram to a PNG file:

  # Bash terminal
  plantuml -tpng <file.puml>
  

Contributing Guidelines

Read the contributing guidelines to know how can you take part in this project.

License

SetTRAILS is licensed under the MIT License.

© (2025) SedTRAILS Team, Delft, The Netherlands.

Citation

Pannozzo, N., Shafiei, H., van Westen, B., Pearson, S. G., Reyns, J., & Aguilera Chaves, M. SedTRAILS (Version 0.1) [Computer software]

Author Contributions:

Role	Author
Conceptualization
Funding acquisition
Project management
Research
Software
Supervision

Acknowlegdements

The development of SedTRAILS Software was supported by the Digital Competence Centre, Delft University of Technology.