https://github.com/passaH2O/dorado

For shallow-water Lagrangian particle routing.
https://github.com/passaH2O/dorado

hydrodynamic-modeling lagrangian numerical-modeling numerical-modelling particle particle-routing particle-tracing particle-tracking particle-transport particles passive-tracers random-walk rivers simulator tracer

Last synced: 2 months ago
JSON representation

For shallow-water Lagrangian particle routing.

• Host: GitHub
• URL: https://github.com/passaH2O/dorado
• Owner: passaH2O
• License: mit
• Created: 2020-07-28T21:09:07.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-06-20T22:43:07.000Z (over 1 year ago)
• Last Synced: 2024-06-11T17:12:40.234Z (8 months ago)
• Topics: hydrodynamic-modeling, lagrangian, numerical-modeling, numerical-modelling, particle, particle-routing, particle-tracing, particle-tracking, particle-transport, particles, passive-tracers, random-walk, rivers, simulator, tracer
• Language: Python
• Homepage: https://passah2o.github.io/dorado
• Size: 84.9 MB
• Stars: 49
• Watchers: 3
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• open-sustainable-technology - dorado - Simulating passive Lagrangian particle transport over flow-fields from any 2D shallow-water hydrodynamic model using a weighted random walk methodology. (Hydrosphere / Waves and Currents)

README

        
# dorado - Lagrangian particle routing

![build](https://github.com/passaH2O/dorado/workflows/build/badge.svg)

[![codecov](https://codecov.io/gh/passaH2O/dorado/branch/master/graph/badge.svg?token=A4MWN4K1XJ)](https://codecov.io/gh/passaH2O/dorado)

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pydorado)

[![PyPI version](https://badge.fury.io/py/pydorado.svg)](https://badge.fury.io/py/pydorado)

[![status](https://joss.theoj.org/papers/f1f61292f998588ae06bb1cd14dd4063/status.svg)](https://joss.theoj.org/papers/f1f61292f998588ae06bb1cd14dd4063)



    



dorado is a Python package for simulating passive Lagrangian particle transport over flow-fields from any 2D shallow-water hydrodynamic model using a weighted random walk methodology.

For user guides and detailed examples, refer to the [documentation](https://passah2o.github.io/dorado/index.html).

### Example Uses:

### Particles on an Unsteady ANUGA Flow Field of the Wax Lake Delta



    



### Particles on a DeltaRCM Simulated Delta



    



## Installation:

dorado supports Python 2.7 as well as Python 3.5+. For the full distribution including examples, clone this repository using `git clone` and run `python setup.py install` from the cloned directory. To test this "full" installation, you must first install `pytest` via `pip install pytest`. Then from the cloned directory the command `pytest` can be run to ensure that your installed distribution passes all of the unit tests.

For a lightweight distribution including just the core functionality, use `pip` to install via PyPI:

    pip install pydorado

    

Installation using `conda` via `conda-forge` is also supported:

    conda install -c conda-forge pydorado

For additional installation options and instructions, refer to the [documentation](https://passah2o.github.io/dorado/install/index.html).

## Contributing

We welcome contributions to the dorado project. Please open an issue or a pull request if there is functionality you would like to see or propose. Refer to our [contributing guide](https://passah2o.github.io/dorado/misc/contributing.html) for more information.

## Citing

If you use this package and wish to cite it, please use the [Journal of Open Source Software article](https://joss.theoj.org/papers/10.21105/joss.02585#).

## Funding Acknowledgments

This work was supported in part by NSF EAR-1719670, the NSF GRFP under grant DGE-1610403 and the NASA Earth Venture Suborbital (EVS) award 17-EVS3-17_1-0009 in support of the DELTA-X project.