Skip to main content

Python version of original Matlab DeltaRCM

Project description

https://badge.fury.io/py/pyDeltaRCM.svg https://joss.theoj.org/papers/10.21105/joss.03398/status.svg https://github.com/DeltaRCM/pyDeltaRCM/actions/workflows/build.yml/badge.svg https://codecov.io/gh/DeltaRCM/pyDeltaRCM/branch/develop/graph/badge.svg https://app.codacy.com/project/badge/Grade/1c137d0227914741a9ba09f0b00a49a7

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.

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:

$ 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.

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).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyDeltaRCM-2.1.4.tar.gz (738.0 kB view hashes)

Uploaded source

Built Distribution

pyDeltaRCM-2.1.4-py3-none-any.whl (72.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page