Create a conda environment from the env.yml
file and activate it. This may be faster with mamba.
conda env create -f env.yml
Note: M1 Mac users should change the Python version to 3.9 in env.yml
Activate the conda environment
conda activate HOwDI
Install an editable version of HOwDI in your HOwDI environment with pip.
pip install -e .
If you have already installed HOwDI but would like to update the dependencies:
conda env update --file env.yml --prune
Within a directory that contains a subdirectory named "inputs" (that contains the necessary inputs), run the model:
(HOwDI) ~ ls
inputs
(HOwDI) ~ HOwDI run
Use HOwDI run -h
for a list of options.
HOwDI has several postprocessing tools. Use HOwDI help
for a full list.
Create a figure: HOwDI create_fig
Traceback: HOwDI traceback
Traceforward: HOwDI traceforward
HOwDI uses the Black code style. Please format your code accordingly before making a pull request.
Adjust the config without worrying about git tracking by creating a file called HOwDI/config_local.yml
. Add key db
and follow with db path.