Developer Install#

Important

The following commands will install bmi-wavewatch3 into your current environment. Although not necessary, we highly recommend you install bmi-wavewatch3 into its own virtual environment.

If you will be modifying code or contributing new code to bmi-wavewatch3, you will first need to get bmi-wavewatch3’s source code and then install bmi-wavewatch3 from that code.

Source Install#

bmi-wavewatch3 is actively being developed on GitHub, where the code is freely available. If you would like to modify or contribute code, you can either clone our repository

git clone git://github.com/csdms/bmi-wavewatch3.git

or download the zip file:

curl -OL https://github.com/csdms/bmi-wavewatch3/archive/refs/heads/main.zip

Once you have a copy of the source code, you can install it into your current Python environment,

mamba

cd bmi-wavewatch3
mamba install --file=requirements-conda.in
pip install -e .

conda

cd bmi-wavewatch3
conda install --file=requirements-conda.in
pip install -e .

pip

cd bmi-wavewatch3
pip install -e .