Wflow.jl icon indicating copy to clipboard operation
Wflow.jl copied to clipboard

DOC: install and running wflow

Open hboisgon opened this issue 1 year ago • 1 comments

Hi,

I tried to install and run wflow using julia with some new users and remarked that some things maybe were not too clear from the installation and running guide in the docs.

Installation When installing Julia, if we want to use it from command prompt, my feeling is that you should in the installer check the box Add Julia to PATH which is not ticked by default (same page as add icon to desktop etc) image

If this is correct, would be good to warn the users in the installation doc: https://github.com/Deltares/Wflow.jl/blob/7790afd8ce81ecbfda6310bec2301891384150b1/docs/src/user_guide/install.md?plain=1#L3-L12

Running Also for running it not clear to me from which command line prompt we should run this: https://github.com/Deltares/Wflow.jl/blob/7790afd8ce81ecbfda6310bec2301891384150b1/docs/src/user_guide/step4_running.md?plain=1#L5-L11

It does not work from the julia prompt and on Windows prompt, it throws an error if you did not add julia to PATH and if we use '. This worked: julia -e "using Wflow; Wflow.run()" path/to/config.toml

Finally from the julia prompt, the following worked: https://github.com/Deltares/Wflow.jl/blob/7790afd8ce81ecbfda6310bec2301891384150b1/docs/src/user_guide/step4_running.md?plain=1#L12-L18

But as I do not use Julia often would be nice to have an example for the syntax of toml_path: Wflow.run("D:\\wflow\\my_model\\wflow_sbm.toml")

For running with command line, I also usually prefer not to run from the wflow folder so an other option is to just run the following from Windows command prompt: "C:\Program Files\Deltares\wflow\wflow 0.6.2\wflow_cli\bin\wflow_cli.exe" "path\to\wflow_sbm.toml"

hboisgon avatar May 25 '23 08:05 hboisgon

Good suggestions! For the julia installation, I'd recommend installing julia from the microsoft store. This puts it on your path directly and allows you to upgrade and manage julia installs with juliaup.

Whilst it is more developer docs, some parts from here could be useful: https://deltares.github.io/Ribasim/contribute/core.html

visr avatar May 25 '23 19:05 visr