SedTRAILS Logo
  • 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
      • Announce your plan
      • Set up a local development environment to work on your changes
      • Develop your contribution
      • Submitting your contribution
      • Using keywords in issues and pull requests
    • 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
      • Key Elements
    • Container View
      • Core Containers
        • 1. SedTRAILS Application Interface
        • 2. Simulation Orchestrator
        • 3. Lagrangian Particle Tracer
        • 4. Transport Converter
        • 5. Data Management Module
        • 6. Simulation Dashboard
        • 7. Pathway Visualizer
        • 8. Simulation Analysis Application
        • 9. Simulation Cache and Recovery
        • 10. SedTRAILS Logger
      • Data Flow
    • Component Details
      • Application Interface
      • Simulation Orchestrator
      • Transport Converter
      • Lagrangian Particle Tracer
      • Data Management Module
      • Simulation Analysis Application
      • Simulation Cache and Recovery
    • Architecture Principles
      • 1. Modularity
      • 2. Plugin Architecture
      • 3. Performance Optimization
      • 4. Configuration-Driven
      • 5. Data Flow Optimization
      • 6. Resilience
    • Technology Stack
    • Deployment and Usage

References

  • Simulation Parameters
    • Table of Contents
    • General Settings
      • Input Model Configuration
    • Input Configuration
    • Domain Definition
      • Flow Field Data Configuration
        • D-Flow FM Settings (fm)
        • Delft3D-4 Settings (delft3d4)
    • Time Configuration
    • Physics Parameters
      • Physical Constants
      • Bed Shear Stress
      • Bed Slope Effects
    • Particle Populations
      • Population Definition
      • Particle Characteristics
        • Passive Particles
        • Sand Particles
        • Mud Particles
        • Bio Particles
        • Gravel Particles
      • Tracer Methods
        • Van Westen Method
        • Soulsby Method
      • Particle Seeding
        • Burial Depth
        • Release Strategies
      • Barriers
      • Population Example
    • Pathway Analysis
    • Output Settings
    • Visualization
      • Dashboard Settings
      • General Plotting Settings
      • Validation Plotting
    • Complete Example Configuration
    • Tips and Best Practices
      • Time Step Selection
      • Domain Definition
      • Output Management
      • Performance Optimization
      • Validation
    • Schema Validation
  • API Reference
    • sedtrails
      • Subpackages
        • sedtrails.exceptions
        • sedtrails.transport_converter
        • sedtrails.simulation_orchestrator
        • sedtrails.cache_recovery
        • sedtrails.application_interfaces
        • sedtrails.logger
        • sedtrails.simulation_analysis
        • sedtrails.particle_tracer
        • sedtrails.data_manager
        • sedtrails.pathway_visualizer
      • Submodules
        • sedtrails.__version__
      • Package Contents
        • Data
        • API
SedTRAILS
  • Search

© Copyright 2025, SedTRAILS Team.

Built with Sphinx using a theme provided by Read the Docs.