deltacd 0.9.2

DeltaCD, Delta Channel Depletion Model

DeltaCD is a numerical model to estimate the Delta channel depletion. DeltaCD is a successor of DETAW-DCD, re-written in pure Python. More information about DeltaCD can be found at Chapter 3 of one of our Annual Reports.

An online documentation is available at https://cadwrdeltamodeling.github.io/deltacd/.

Installation

Developer Installation

For developer to use the source code directly, follow this section.

First, clone the DeltaCD repository from GitHub, navigate into it.

Create an environment with a suitable name, for example, deltacd:

conda create -n deltacd python=3.11

Once a new environment is created, activate it:

conda activate deltacd

Install DeltaCD with -e, editable option:

pip install -e .

Usage

DeltaCD package has two models, DETAW and DCD. They can be launched from the command line (after a Python environment with DeltaCD is activated).

DETAW needs to run first, for example:

detaw detaw_dsm2.yaml

Followed by DCD:

dcd dcd_dsm2.yaml

Example yaml and input files are provided in the examples directory in DeltaCD package.

While not required, it would be a good practice to make a copy of the examples directory to a project or working directory and rename it suitably.

Getting Help

Any questions and issues? We would like to help and improve the package.

For any questions, please contact DeltaCD developers. Please report bugs and issues at GitHub issues.