dorado’s Documentation

dorado is a python package developed to simulate the transport of passive particles in a flow field. Particle movement is simulated in a Lagrangian fashion using a weighted random walk formulation.

Getting Started

• Installation Instructions
  • Installation via pip
  • Installation via conda
  • Installation from source
  • Editable installation from source
• Quickstart
  • Demo 1- Using the High-Level API
  • Demo 2 - Using Lower-Level Functionality

Background

• Background
• Paper

User Guide

• User Guide
  • Overview
  • Defining the params
  • Defining the Particles
  • The High-Level API
  • The Lower-Level API

Examples

• Examples
  • Example 1 - Particles in Steady Flow (ANUGA)
  • Example 2 - Particles in Steady Flow (DeltaRCM)
  • Example 3 - Using the Built-In Animation Function
  • Example 4 - Toggling Steepest Descent
  • Example 5 - Visualizing Particle Travel Times
  • Example 6 - Set Travel Time Target
  • Example 7 - Drawing Particle Travel Paths (DeltaRCM)
  • Example 8 - Drawing Particle Travel Paths (ANUGA)
  • Example 9 - True Random Walk
  • Example 10 - Routing Particles in Parallel
  • Example 11 - The Travel Time Diffusion Coefficient
  • Example 12 - Unsteady Flow Fields
  • Example 13 - Using Unstructured Grids
  • Example 14 - Nourishment Area and Time Functions
  • External Examples

API Reference and Contributing Guidelines

• License
• Contributing
• API Reference

Funding Acknowledgments

• Acknowledgments