Skip to content

Commit 70e80a0

Browse files
committed
Added WSL instructions to readme
1 parent 38a05d3 commit 70e80a0

1 file changed

Lines changed: 29 additions & 2 deletions

File tree

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,34 @@ instructions for `Users` or `Developers` on how to run the model.
2626

2727
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.
2828

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 <a href="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
3057

3158
Follow the instructions below to install `PyStemmusScope`, `jupyterlab` and MATLAB Runtime.
3259

@@ -37,7 +64,7 @@ Run the commands below in a terminal:
3764

3865
```sh
3966
# will be replaced by `pip install pystemmusscope`
40-
pip install git+https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing.git@main
67+
pip install git+https://github.com/EcoExtreML/STEMMUS_SCOPE_Processing.git@main
4168
```
4269

4370
</details>

0 commit comments

Comments
 (0)