pyDeltaRCM

pyDeltaRCM: a flexible numerical delta model - Published in JOSS (2021)

https://github.com/deltarcm/pydeltarcm

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 13 DOI reference(s) in README and JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org
✓
Committers with academic emails
6 of 10 committers (60.0%) from academic institutions
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords from Contributors

numerical-modeling

Scientific Fields

Earth and Environmental Sciences Physical Sciences - 62% confidence

Last synced: 6 months ago · JSON representation

Repository

Delta model with a reduced-complexity approach

Basic Info

Host: GitHub
Owner: DeltaRCM
License: mit
Language: Python
Default Branch: develop
Homepage: https://deltarcm.org/pyDeltaRCM/
Size: 53.9 MB

Statistics

Stars: 20
Watchers: 3
Forks: 12
Open Issues: 30
Releases: 13

Created about 7 years ago · Last pushed 8 months ago

Metadata Files

Readme License Code of conduct

README.rst

**************
pyDeltaRCM
**************

.. image:: https://badge.fury.io/py/pyDeltaRCM.svg
    :target: https://badge.fury.io/py/pyDeltaRCM

.. image:: https://joss.theoj.org/papers/10.21105/joss.03398/status.svg
   :target: https://doi.org/10.21105/joss.03398

.. image:: https://github.com/DeltaRCM/pyDeltaRCM/actions/workflows/build.yml/badge.svg
    :target: https://github.com/DeltaRCM/pyDeltaRCM/actions

.. image:: https://codecov.io/gh/DeltaRCM/pyDeltaRCM/branch/develop/graph/badge.svg
    :target: https://codecov.io/gh/DeltaRCM/pyDeltaRCM

.. image:: https://app.codacy.com/project/badge/Grade/1c137d0227914741a9ba09f0b00a49a7
    :target: https://app.codacy.com/gh/DeltaRCM/pyDeltaRCM/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade




*pyDeltaRCM* is a computationally efficient, free and open source, and easy-to-customize numerical delta model based on the original DeltaRCM model design (`Matlab deltaRCM `_ model by Man Liang; `Liang et al., 2015 `_).
*pyDeltaRCM* delivers improved model stability and capabilities, infrastructure to support exploration with minimal boilerplate code, and establishes an approach to extending model capabilities that ensures reproducible and comparable studies.


.. figure:: https://deltarcm.org/pyDeltaRCM/_images/cover.png

    Weighted random walks for 20 water parcels, in a *pyDeltaRCM* model run with default parameters.


Documentation
#############

`Find the complete documentation here `_.

Documentation includes an `installation guide `_, a thorough `guide for users `_, detailed `API documentation for developers `_, a `plethora of examples `_ to use and develop pyDeltaRCM in novel scientific experiments, and more!


Installation
############

See our complete `installation guide `_, especially if you are a developer planning to modify or contribute code (`developer installation guide `_), or if you are new to managing Python `venv` or `conda` environments.

For a quick installation into an existing Python 3.x environment:

.. code:: console

    $ pip install pyDeltaRCM


Executing the model
###################

We recommend you check out our `pyDeltaRCM in 10 minutes tutorial `_, which is part of our documentation.

Beyond that brief tutorial, we have a comprehensive `User Documentation `_ and `Developer Documentation `_ to check out.


Citing pyDeltaRCM
#################

When citing *pyDeltaRCM*, please cite the `JOSS paper `_:

	Moodie et al., (2021). pyDeltaRCM: a flexible numerical delta model. Journal of Open Source Software, 6(64), 3398, https://doi.org/10.21105/joss.03398
	
If you use BibTeX, you can add *pyDeltaRCM* to your `.bib` file using the following code:

.. code:: console

	@article{Moodie2021,
	doi = {10.21105/joss.03398},
	url = {https://doi.org/10.21105/joss.03398},
	year = {2021},
	publisher = {The Open Journal},
	volume = {6},
	number = {64},
	pages = {3398},
	author = {Andrew J. Moodie and Jayaram Hariharan and Eric Barefoot and Paola Passalacqua},
	title = {*pyDeltaRCM*: a flexible numerical delta model},
	journal = {Journal of Open Source Software}
	}


Additional notes
################

This repository no longer includes the `Basic Model Interface (BMI) `_ wrapper to the DeltaRCM model.
*pyDeltaRCM* maintains BMI compatibility through another repository (`the BMI_pyDeltaRCM model `_).

Owner

Name: DeltaRCM
Login: DeltaRCM
Kind: organization

Website: deltarcm.org
Repositories: 3
Profile: https://github.com/DeltaRCM

A community of people working on modeling deltas with a reduced-complexity approach

JOSS Publication

pyDeltaRCM: a flexible numerical delta model

Published

August 26, 2021

DOI

10.21105/joss.03398

Volume 6, Issue 64, Page 3398

Authors

Andrew J. Moodie

Department of Civil, Architectural, and Environmental Engineering, University of Texas at Austin, Austin, TX, USA

Jayaram Hariharan

Department of Civil, Architectural, and Environmental Engineering, University of Texas at Austin, Austin, TX, USA

Eric Barefoot

Department of Earth, Environmental and Planetary Sciences, Rice University, Houston, TX, USA

Paola Passalacqua

Department of Civil, Architectural, and Environmental Engineering, University of Texas at Austin, Austin, TX, USA

Editor

Katy Barnhart

GitHub Events

Total

Create event: 1
Issues event: 2
Release event: 1
Watch event: 3
Issue comment event: 12
Push event: 9
Pull request event: 10
Fork event: 2

Last Year

Create event: 1
Issues event: 2
Release event: 1
Watch event: 3
Issue comment event: 12
Push event: 9
Pull request event: 10
Fork event: 2

Committers

Last synced: 7 months ago

All Time

Total Commits: 723
Total Committers: 10
Avg Commits per committer: 72.3
Development Distribution Score (DDS): 0.631

Past Year

Commits: 28
Committers: 1
Avg Commits per committer: 28.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
Andrew Moodie	a**e@u**u	267
amoodie	a**e@r**u	204
JayH	j**n@u**u	136
Eric Barefoot	e**t@g**m	49
Mariela Perignon	m**n@g**m	34
Mark Piper	m**r@c**u	13
Andrew Moodie	a**2@g**m	13
deltarcm-helper	d****r	4
Richard Barnes	r**s@u**u	2
Andrew Moodie	a**e@l**u	1

Committer Domains (Top 20 + Academic)

utexas.edu: 2 login3.stampede2.tacc.utexas.edu: 1 umn.edu: 1 colorado.edu: 1 rice.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 31
Total pull requests: 96
Average time to close issues: 7 months
Average time to close pull requests: about 1 month
Total issue authors: 9
Total pull request authors: 5
Average comments per issue: 1.19
Average comments per pull request: 1.38
Merged pull requests: 81
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 1
Pull requests: 12
Average time to close issues: N/A
Average time to close pull requests: 2 days
Issue authors: 1
Pull request authors: 2
Average comments per issue: 0.0
Average comments per pull request: 0.58
Merged pull requests: 8
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

amoodie (15)
elbeejay (10)
Xueyao-Chen (1)
paolaPassaH2O (1)
Lvulis (1)
jhnienhuis (1)
vsoch (1)
zsylvester (1)
kbarnhart (1)

Pull Request Authors

amoodie (73)
elbeejay (20)
r-barnes (3)
codacy-badger (1)
ericbarefoot (1)

Top Labels

Issue Labels

documentation (18) enhancement (6) good first issue (4) bug (4) help wanted (3) discussion (3) use case example (1) style (1)

Pull Request Labels

enhancement (16) bug (16) documentation (6) style (4) testing (4) discussion (1)

Packages

Total packages: 1
Total downloads:
- pypi 2,815 last-month

Total dependent packages: 0
Total dependent repositories: 1
Total versions: 12
Total maintainers: 1

pypi.org: pydeltarcm

Python version of original Matlab DeltaRCM

Homepage: https://github.com/DeltaRCM/pyDeltaRCM
Documentation: https://deltarcm.org/pyDeltaRCM
License: MIT
Latest release: 2.1.4
published over 3 years ago

Versions: 12
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 2,815 Last month

Rankings

Dependent packages count: 10.1%

Forks count: 11.9%

Stargazers count: 15.2%

Average: 16.4%

Dependent repos count: 21.6%

Downloads: 23.0%

Maintainers (1)

amoodie

Last synced: 6 months ago

Dependencies

requirements-docs.txt pypi

sphinx *

requirements-test.txt pypi

pytest * test
pytest-mpl * test

requirements.txt pypi

matplotlib *
netCDF4 *
numba *
numpy *
pyyaml >=5.1
scipy >=1.5

setup.py pypi

matplotlib *
netCDF4 *
numba *
numpy *
pyyaml *
scipy *

.github/workflows/build.yml actions

JamesIves/github-pages-deploy-action v4 composite
actions/checkout v4 composite
actions/setup-python v4 composite
actions/upload-artifact v3 composite
codecov/codecov-action v3 composite

.github/workflows/deploy.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite

pyDeltaRCM

Science Score: 95.0%

Keywords from Contributors

Scientific Fields

Repository

Basic Info

Statistics

Metadata Files

README.rst

Owner

JOSS Publication

pyDeltaRCM: a flexible numerical delta model

Authors

Editor

Tags

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: pydeltarcm

Rankings

Maintainers (1)

Dependencies