Deltares / hydromt_wflow

Wflow plugin for HydroMT
https://deltares.github.io/hydromt_wflow/
GNU General Public License v3.0
20 stars 15 forks source link

Installation guide has wrong order #259

Closed PeterNelemans closed 7 months ago

PeterNelemans commented 8 months ago

HydroMT-Wflow version checks

Kind of issue

Docs are wrong

Location of the documentation

Installation guide of HydroMT-wflow, found here.

Documentation problem

I was installing HydroMT-wflow according to the installation guide. The installation guide tells you to create a specific environment for HydroMT-wflow and install all relevant packages using the following command: $ mamba create -n hydromt-wflow -c conda-forge hydromt_wflow

Then, it says:

Please take into account that gwwapi or hydroengine packages are not available from conda and therefore have to be installed from pypi separately.

and instructs you to install these packages using the following commands:

$ pip install gwwapi $ pip install hydroengine

However, these two packages (and their dependencies) now get installed into the base environment instead of the hydromt-wflow environment, because the latter hasn't been activated yet. That is actually the next step of the installation guide:

$ conda activate hydromt-wflow

However, this step should come (also) before install gwwapi and hydroengine, as to ensure these do not get installed in the base environment but in the hydromt-wflow environment.

Suggested fix for documentation

Move the instruction to activate the hydromt-wflow environment before the instruction to install gwwapi and hydroengine.