Metadata-Version: 2.1
Name: hydrolib-cmt
Version: 0.3.0.dev1
Summary: Case Management Tools for DHYDRO
Author: Daniel Tollenaar
Author-email: daniel@d2hydro.nl
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: docs
License-File: LICENSE

# Case Management Tools (hydrolib-cmt)

Open Source Case Management Tools for [D3DFM/D-HYDRO](https://www.deltares.nl/en/software/delft3d-flexible-mesh-suite/)

CMT includes:

* Generation of one or multiple cases for D-HYDRO using an uniform directory structure
* Generation of cases as part of a StochasticTool (HydroConsult) workflow
* Generation of rainfal events from STOWA parameters
* Run D-HYDRO scenarios in single or parallel mode
* On-the-fly post-processing of results on desired location.

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

---

**Documentation**: [https://d2hydro.github.io/HYDROLIB-CMT/](https://d2hydro.github.io/HYDROLIB-CMT/)

**Source Code**: [https://github.com/d2hydro/hydrolib-cmt](https://github.com/d2hydro/hydrolib-cmt)

---

## Installation

We recommend to build your environment using [Anaconda](https://www.anaconda.com/). You can build an environment ánd install CMT by conda in one go using this <a href="https://github.com/Deltares/HYDROLIB/blob/main/hydrolib/case_management_tools/envs/environment.yml" target="_blank">environment.yml</a> from the command-line:
```
conda env create -f environment.yml
```

After creating your environment you can activate it with:
```
conda activate hydrolib
```

In that activated environment you can add cmt with pip in the setup.py directory:
```
pip install .
```

## Get started

The repository contains a self-explanatory [Jupyter Notebook](/../notebooks/stochasten_workflow.ipynb) (in Dutch). You can open it in an activated environment in the notebooks directory by:

```
jupyter notebook stochasten_workflow.ipynb
```

## About

Case Management Tools is developed and maintained by [D2Hydro](https://d2hydro.nl/) and freely available under an Open Source <a href="https://github.com/Deltares/HYDROLIB/blob/main/hydrolib/case_management_tools/LICENSE" target="_blank">MIT license</a>.
