Deltares / hydromt_wflow

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

Installation guide not up-to-date #206

Closed hboisgon closed 9 months ago

hboisgon commented 1 year ago

HydroMT-Wflow version checks

Kind of issue

Docs are wrong

Location of the documentation

HydroMT-wflow was simplified with make_env.py but docs were not updated accordingly:

https://deltares.github.io/hydromt_wflow/latest/getting_started/installation.html

https://deltares.github.io/hydromt_wflow/latest/getting_started/example_index.html

https://deltares.github.io/hydromt_wflow/latest/dev_guide/dev_install.html

The second one is also not clear because if people install from conda-forge plotting dependencies as well as jupyter lab wont be installed.

The third link, how to install make is not mentioned.

Documentation problem

As of now people cannot install hydromt-wflow with the recommended install

Suggested fix for documentation

Update with steps from make_env.py

hboisgon commented 1 year ago

On a personal note, I'm still not sure if asking people who may not be too familiar with python to create their own env using make works nicely. For developper's okay but for people to run the examples I still think a ready to use environment.yml file would be better and more easy than first installing make and tomli.

Maybe for hydromt-wflow takes this out of the installation guide and put it in the examples only.