Skip to content

Commit b0d191b

Browse files
committed
revise the contributing guidelines
1 parent d3aa842 commit b0d191b

1 file changed

Lines changed: 11 additions & 19 deletions

File tree

docs/CONTRIBUTING.md

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
1-
# processing
1+
# STEMMUS_SCOPE processing
22

3-
This repositary includes python modules for running the STEMMUS-SCOPE model in a
4-
notebook.
3+
This document illustrates how to run the model STEMMUS_SCOPE as a developer.
4+
The workflow is executed using python and MATLAB on a Unix-like system where a MATLAB license is available.
5+
To run the STEMMUS_SCOPE, you need MATLAB version `>=2019`.
56

6-
The workflow is executed using python and MATLAB on a Unix-like system.
77
The python packages are listed in the
88
[`environment.yml`](https://github.com/EcoExtreML/processing/blob/main/environment.yml)
9-
file. Follow the instructions below to create conda environment and install
10-
MATLAB Runtime.
9+
file. Follow the instructions below to create conda environment.
1110

1211
<details>
1312
<summary>Create conda environment </summary>
@@ -37,29 +36,22 @@ mamba env create
3736
```
3837
</details>
3938

40-
<details>
41-
<summary>Use MATLAB </summary>
4239

43-
To run the STEMMUS_SCOPE, you need MATLAB version `>=2019`.
40+
# Run model in a Jupyter notebook
4441

4542
**On Snellius:**
4643

4744
[Snellius](https://servicedesk.surfsara.nl/wiki/display/WIKI/Snellius) is the
48-
Dutch National supercomputer hosted at SURF. MATLAB Runtime is installed on
49-
Snellius, see the script
50-
[`run_jupyter_lab_snellius_dev.sh`](https://github.com/EcoExtreML/processing/blob/main/run_jupyter_lab_snellius_dev.sh)
51-
on how to load the module.
52-
</details>
53-
54-
# Run jupyter notebook
55-
56-
**On Snellius:**
45+
Dutch National supercomputer hosted at SURF.
5746

47+
The notebook [run_model_in_notebook_dev.ipynb](./notebooks/run_model_in_notebook_dev.ipynb) shows how to run the model.
5848
Use the script
5949
[`run_jupyter_lab_snellius_dev.sh`](https://github.com/EcoExtreML/processing/blob/main/run_jupyter_lab_snellius_dev.sh)
60-
to create a jupyter lab server on Snellius for running the notebook
50+
to create a Jupyter lab server on Snellius for running the notebook
6151
interactively.
6252

53+
# Run model in a MATLAB script
54+
6355
**On CRIB:**
6456

6557
[CRIB](https://crib.utwente.nl/) is the ITC Geospatial Computing Platform.

0 commit comments

Comments
 (0)