dorado

Simulating passive Lagrangian particle transport over flow-fields from any 2D shallow-water hydrodynamic model using a weighted random walk methodology.
https://github.com/passaH2O/dorado

Category: Hydrosphere
Sub Category: Waves and Currents

Keywords

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: about 6 hours ago
JSON representation

Repository metadata

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 5 years ago)
Default Branch: master
Last Pushed: 2025-08-20T01:39:30.000Z (4 months ago)
Last Synced: 2025-12-17T05:54:17.838Z (10 days 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: 87.5 MB
Stars: 63
Watchers: 2
Forks: 11
Open Issues: 6
Releases: 18
Metadata Files:
- Readme: README.md
- License: LICENSE

README.md

dorado - Lagrangian particle routing

PyPI - Python Version

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.

Example Uses:

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

Particles on a DeltaRCM Simulated Delta

Installation:

dorado supports Python 3.11+. 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.

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 for more information.

Citing

If you use this package and wish to cite it, please use the Journal of Open Source Software article.

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.

Owner metadata

Name: PassaH2O Group
Login: passaH2O
Email:
Kind: organization
Description:
Website: https://sites.google.com/site/passalacquagroup/home
Location:
Twitter:
Company:
Icon url: https://avatars.githubusercontent.com/u/30088719?v=4
Repositories: 10
Last ynced at: 2024-04-16T03:09:36.925Z
Profile URL: https://github.com/passaH2O

GitHub Events

Total

Create event: 10
Release event: 6
Issues event: 8
Watch event: 7
Delete event: 3
Issue comment event: 11
Push event: 17
Pull request review event: 6
Pull request review comment event: 15
Pull request event: 12
Fork event: 1

Last Year

Create event: 10
Release event: 6
Issues event: 8
Watch event: 3
Delete event: 3
Issue comment event: 11
Push event: 17
Pull request review event: 6
Pull request review comment event: 15
Pull request event: 12

Committers metadata

Last synced: 12 days ago

Total Commits: 338
Total Committers: 6
Avg Commits per committer: 56.333
Development Distribution Score (DDS): 0.331

Commits in past year: 29
Committers in past year: 3
Avg Commits per committer in past year: 9.667
Development Distribution Score (DDS) in past year: 0.345

Name	Email	Commits
JayH	j**n@u**u	226
wrightky	k**t@u**u	50
Wright	k**5@a**u	39
caitlinturner	7****r	19
Katherine Barnhart	k**t@u**v	3
Paola Passalacqua	p**a@a**u	1

Committer domains:

Issue and Pull Request metadata

Last synced: 4 months ago

Total issues: 21
Total pull requests: 42
Average time to close issues: 3 months
Average time to close pull requests: about 1 month
Total issue authors: 5
Total pull request authors: 4
Average comments per issue: 1.0
Average comments per pull request: 1.88
Merged pull request: 39
Bot issues: 0
Bot pull requests: 0

Past year issues: 5
Past year pull requests: 12
Past year average time to close issues: 19 days
Past year average time to close pull requests: 5 days
Past year issue authors: 2
Past year pull request authors: 2
Past year average comments per issue: 0.0
Past year average comments per pull request: 2.5
Past year merged pull request: 10
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/passaH2O/dorado

Top Issue Authors

elbeejay (13)
kbarnhart (3)
gassmoeller (2)
caitlinturner (2)
wrightky (1)

Top Pull Request Authors

elbeejay (29)
wrightky (7)
caitlinturner (3)
kbarnhart (1)

Top Issue Labels

enhancement (2)
good first issue (2)
documentation (2)
bug (1)

Top Pull Request Labels

Package metadata

Total packages: 3
Total downloads:
- pypi: 67 last-month
Total dependent packages: 0 (may contain duplicates)
Total dependent repositories: 1 (may contain duplicates)
Total versions: 51
Total maintainers: 2

proxy.golang.org: github.com/passaH2O/dorado

Homepage:
Documentation: https://pkg.go.dev/github.com/passaH2O/dorado#section-documentation
Licenses: mit
Latest release: v2.6.0+incompatible (published 4 months ago)
Last Synced: 2025-12-21T10:45:48.155Z (5 days ago)
Versions: 17
Dependent Packages: 0
Dependent Repositories: 0
Rankings:
- Dependent packages count: 5.395%
- Average: 5.576%
- Dependent repos count: 5.758%

proxy.golang.org: github.com/passah2o/dorado

Homepage:
Documentation: https://pkg.go.dev/github.com/passah2o/dorado#section-documentation
Licenses: mit
Latest release: v2.6.0+incompatible (published 4 months ago)
Last Synced: 2025-12-21T10:45:48.040Z (5 days ago)
Versions: 17
Dependent Packages: 0
Dependent Repositories: 0
Rankings:
- Dependent packages count: 5.395%
- Average: 5.576%
- Dependent repos count: 5.758%

pypi.org: pydorado

dorado - Lagrangian particle routing routine via weighted random walks

Homepage: https://github.com/passaH2O/dorado
Documentation: https://pydorado.readthedocs.io/
Licenses: MIT License Copyright (c) 2020 Passalacqua Group Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Latest release: 2.6.0 (published 4 months ago)
Last Synced: 2025-12-21T10:45:46.879Z (5 days ago)
Versions: 17
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 67 Last month
Rankings:
- Dependent packages count: 7.31%
- Stargazers count: 9.797%
- Forks count: 12.604%
- Average: 15.146%
- Dependent repos count: 22.088%
- Downloads: 23.93%
Maintainers (2)
- jhariharan
- wrightky

Dependencies

requirements.txt pypi

future *
matplotlib *
numpy *
scipy *
tqdm *

.github/workflows/build.yml actions

JamesIves/github-pages-deploy-action 3.7.1 composite
actions/checkout v2 composite
actions/setup-python v2 composite
codecov/codecov-action v1 composite

.github/workflows/deploy.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite
elbeejay/conda-publish-action v1.5 composite

pyproject.toml pypi

Score: 10.274361215874674

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology