Skip to content

Commit 894969d

Browse files
committed
Start of user manual, and some more README fixes
1 parent efe5a88 commit 894969d

File tree

6 files changed

+30
-5
lines changed

6 files changed

+30
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,19 +49,19 @@ This tool is implemented as a Flask (Python) web application. It is currently pr
4949

5050
1. Install Julia dependencies.
5151

52-
`~/AppData/Local/Programs/Julia-1.9.0/bin/julia.exe -e 'using Pkg; Pkg.add(url="https://github.com/spine-tools/SpineInterface.jl.git")'`
52+
`~/AppData/Local/julias/bin/julia.cmd -e 'using Pkg; Pkg.add(url="https://github.com/spine-tools/SpineInterface.jl.git")'`
5353

54-
`~/AppData/Local/Programs/Julia-1.9.0/bin/julia.exe -e 'using Pkg; Pkg.add(url="https://github.com/spine-tools/SpineOpt.jl.git")'`
54+
`~/AppData/Local/julias/bin/julia.cmd -e 'using Pkg; Pkg.add(url="https://github.com/spine-tools/SpineOpt.jl.git")'`
5555

56-
`~/AppData/Local/Programs/Julia-1.9.0/bin/julia.exe -e 'using Pkg; Pkg.add(["XLSX", "DataFrames", "Distributions", "CSV", "Revise", "Cbc", "Clp"])'`
56+
`~/AppData/Local/julias/bin/julia.cmd -e 'using Pkg; Pkg.add(["XLSX", "DataFrames", "Distributions", "CSV", "Revise", "Cbc", "Clp"])'`
5757

5858
1. Run Spine Toolbox to initialize configuration. You can close it after it opens.
5959

60-
`python -m toolbox &`
60+
`python -m spinetoolbox &`
6161

6262
1. Configure Spine Toolbox's Julia paths.
6363

64-
`python venv/src/spinetoolbox/bin/configure_julia.py "C:/Users/$(whoami)/AppData/Local/Programs/Julia-1.9.0/bin/julia.exe" ""`
64+
`python venv/src/spinetoolbox/bin/configure_julia.py "C:/Users/$(whoami)/AppData/Local/julias/bin/julia.cmd" ""`
6565

6666
1. Create `config/local.json` and override default config settings as needed. At a minimum, override `"app_secret_key"` with a random string.
6767

63.5 KB
Loading
18.9 KB
Loading
198 KB
Loading
231 KB
Loading

docs/user_manual/user_manual.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# ResDEEDS User Manual
2+
3+
## Troubleshooting
4+
### Spine Toolbox Workflow
5+
Errors in the Spine Toolbox workflow may not be directly visible in the application or console output. To troubleshoot issues with the Spine workflow, try opening Spine Toolbox by invoking the Python module directly:
6+
7+
python -m spinetoolbox &
8+
9+
This will open the Spine Toolbox window:
10+
11+
![Spine Toolbox window](img/spine_toolbox_01.png)
12+
13+
From here, select File->Open project. In the file picker, select `ResDEEDS/spine/projects/<PROJECT>`, where PROJECT is some project that you have created in the ResDEEDS web interface.
14+
15+
![Spine project file picker](img/spine_toolbox_02.png)
16+
17+
With the project open, you either run the whole workflow and see where it stops, or you can select and run just part of the workflow. For example, if you suspected there was an issue with the `apply_hazards` step, you could select that step and then click the Run Selection button:
18+
19+
![Running part of the Toolbox workflow](img/spine_toolbox_03.png)
20+
21+
After running all or part of the workflow, you can view the console output of a particular step by selecting it in the GUI. For example, you can see the Julia output of the `apply_hazards` step by selecting it:
22+
23+
![Viewing output of a Toolbox step](img/spine_toolbox_04.png)
24+
25+
This allows you to debug issues with the Spine Toolbox workflow.

0 commit comments

Comments
 (0)