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
+13-11Lines changed: 13 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,36 +9,31 @@ You can also edit the markdown files at github directly. With a delay of minutes
9
9
10
10
As a rule, the sector-specific text should be kept to a minimum and cover as much structure as possible by machine-readable code under [definitions](definitions/).
11
11
12
+
12
13
Setup
13
14
-----
14
15
15
16
Building the protocol requires:
16
17
17
-
-**git**: for version control
18
18
-**Python** (> 3.10)
19
-
-**curl**: for downloading nvm in the app Makefile
19
+
-**git** for version control
20
+
-**curl** for downloading `nvm`
20
21
21
22
The installation of Python (and its developing packages) differs from operating system to operating system. Instructions to setup Python for your system can be found [here](https://utils.isimip.org/prerequisites/).
22
23
23
-
If you work with different Python applications, we recommend to create a virtual environment for the protocol:
24
+
We recommend to create a virtual environment for the protocol:
24
25
25
26
```bash
26
27
python3 -m venv env
27
28
source env/bin/activate # the env needs to be sourced everytime you use a new terminal
28
29
```
29
30
30
-
The Python requirements are installed using:
31
+
The Python requirements can be installed using:
31
32
32
33
```bash
33
34
pip install -r requirements.txt
34
35
```
35
36
36
-
The JavaScript part of the protocol needs to be build using NodeJS and Webpack. For convenience this can be done by using only ([nvm]() and the Node dependencies are downloaded automatically, this requires `curl`):
37
-
38
-
```bash
39
-
make app
40
-
make watch # automatically rebuild when the source changes
41
-
```
42
37
43
38
Build
44
39
-----
@@ -49,7 +44,14 @@ The different `build` scripts can be run by using:
49
44
make
50
45
```
51
46
52
-
The output files are located in `output`. The files, e.g. `index.html` can opened with a web browser.
47
+
The output files are located in `output`.
48
+
49
+
The JavaScript part of the protocol needs to be build using NodeJS and Webpack. For convenience this can be done by using ([nvm](https://github.com/nvm-sh/nvm) and the Node dependencies are downloaded automatically, this requires `curl`):
50
+
51
+
```bash
52
+
make app
53
+
make watch # automatically rebuild when the source changes
0 commit comments