Installing dwind

Installing dwind#

If you just want to use dwind and aren’t developing new models, you can install it from PyPI using pip:

pip install dwind

If you want to develop new models or contribute to dwind, you can install it from source.

Using Git, navigate to a local target directory and clone repository:
```
git clone https://github.com/NatLabRockies/dwind.git
```
Navigate to dwind
```
cd dwind
```
Create a conda environment and install dwind and all its dependencies
```
conda env create -f environment.yml
```

An additional step can be added if additional dependencies are required, or you plan to use this environment for development work.

This looks like the following for a developer installation:

pip install -e ".[dev]"

Using Git, navigate to a local target directory and clone repository:
```
git clone https://github.com/NatLabRockies/dwind.git
```
Navigate to dwind
```
cd dwind
```
Create a new virtual environment and change to it. Using Conda Python 3.11 (choose your favorite supported version) and naming it ‘dwind’ (choose your desired name):
```
conda create --name dwind python=3.11 -y
conda activate dwind
```
Install dwind and its dependencies:
- If you want to just use dwind:
```
pip install .
```
- If you also want development dependencies and documentation build tools:
```
pip install -e ".[dev]"
pre-commit install
```

Please see the Contributor’s Guide for notes on installation steps and general notes geared towards maintainers and contributors of the project.