You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+29-2Lines changed: 29 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,34 @@ instructions for `Users` or `Developers` on how to run the model.
26
26
27
27
As a user, you don't need to have a MATLAB license to run the STEMMUS-SCOPE model. The workflow is executed using python and MATLAB Runtime on a Unix-like system.
28
28
29
-
### Installations
29
+
As the STEMMUS-Scope executable only supports Unix-like systems, Windows users cannot run STEMMUS-SCOPE natively.
30
+
However, users of Windows 10 and newer can use WSL (Windows Subsystem for Linux) to run the model.
31
+
32
+
<details>
33
+
<summary>WSL installation instructions.</summary>
34
+
Check the <ahref="https://docs.microsoft.com/en-us/windows/wsl/install">Microsoft Guide</a> for a compatibility information and for general WSL instructions.
35
+
36
+
If no installation exists, a Ubuntu distribution can be installed using the following commands:
37
+
```sh
38
+
wsl --install
39
+
```
40
+
41
+
After installation, you can start up the WSL instance and update the default software:
42
+
43
+
```sh
44
+
sudo apt update && sudo apt upgrade
45
+
```
46
+
47
+
You can now set up a python environment using either python's `venv`, or use Conda/Mamba.
48
+
49
+
Note that the command to run python and pip can be `python3` and `pip3` by default.
50
+
51
+
For the rest of the installation instructions simply follow the steps below.
52
+
Note that it is possible to access files from the Windows filesystem from within WSL, by accessing, e.g., `/mnt/c/` instead of `C:\`.
53
+
This means that large input data files can be stored on your Windows installation instead of inside the WSL distro.
54
+
</details>
55
+
56
+
### Installations
30
57
31
58
Follow the instructions below to install `PyStemmusScope`, `jupyterlab` and MATLAB Runtime.
32
59
@@ -37,7 +64,7 @@ Run the commands below in a terminal:
37
64
38
65
```sh
39
66
# will be replaced by `pip install pystemmusscope`
0 commit comments