SedTRAILS documentation

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.

• Quick Start
  • Installation
  • Test the installation
• What is SedTRAILS?
  • Why SedTRAILS?
  • Publications
  • MSc Theses

User Documentation

• Installation
  • Using pip
  • From source
  • Confirming the installation
• Simulations
  • Configuring a Simulation
    • Example Configuration File
  • Running a Simulation
• Simulation Output
  • Output File Inspection
  • Details of Output File Contents
    • Global Attributes:
    • Dimensions
    • Coordinates:
    • Data Variables:
  • Output Visualization
• Monitoring Dashboard
  • Navigating the Dashboard
  • Turning Off the Dashboard
• Seeding Strategies
  • Particle seeding in SedTRAILS

Tutorials

• Running a Basic Simulation

Developer Documentation

• Contributions
  • A. You have a question
  • B. You think you may have found a bug
  • C. You want to make changes to the code base
  • D. You want to improve the SedTRAILS documentation
• Development Setup
  • Simulation Test
• SedTRAILS Plugins
  • Creating a Plugin
  • Registering a Plugin
• Software Architecture
  • Table of Contents
  • System Context
  • Container View
  • Component Details
  • Architecture Principles
  • Technology Stack
  • Deployment and Usage

References

• Simulation Parameters
• API Reference

Indices and tables

• Index

• Module Index

• Search Page

ACKNOWLEDGEMENTS

SedTRAILS development has been funded in part through the Netherlands Organisation for Scientific Research (NWO) projects “TRAILS” (grant number 17600) in the research programme ‘Living Labs in the Dutch Delta’, “Revealing Hidden Networks of Coastal Sediment Pathways via Laboratory & Numerical Experiments” (grant number 21026), and SEAWAD (grant number 14489) in the research programme ‘Collaboration Program Water’. The SedTRAILS code was originally developed under the Deltares-USGS collaborative agreement as a coral larvae and sediment particle tracking module by Maarten van Ormondt, Edwin Elias, and Johan Reyns (Deltares/Deltares USA), Andrew Stevens and Curt Storlazzi from the US Geological Survey (USGS), and Stuart Pearson (TU Delft). It has since been further developed in part during the KPP Beheer en Onderhoud Kust en Kustgenese projects, in partnership between Deltares, Rijkswaterstaat, and TU Delft.

The Python version of SedTRAILS was supported by the Digital Competence Centre, Delft University of Technology.