@@ -19,9 +19,7 @@ To contribute to the project, adhere to the following process.
19
19
- Make sure you have the following programs installed and that these can be found on
20
20
your path:
21
21
22
- - A [ Miniconda] ( https://docs.conda.io/en/latest/miniconda.html ) (recommended) or
23
- [ Anaconda] ( https://www.anaconda.com/products/distribution ) Python distribution.
24
- - [ Git] ( https://git-scm.com/downloads )
22
+ - [ pixi] ( https://prefix.dev/docs/pixi/overview#installation ) (Python package manager)
25
23
- A modern text editor (e.g. [ VS Code] ( https://code.visualstudio.com/ ) )
26
24
27
25
- Cloning the repository works differently for regular contributors and newcomers. As a
@@ -43,19 +41,12 @@ To contribute to the project, adhere to the following process.
43
41
$ git clone https://github.com/<user>/gettsim
44
42
```
45
43
46
- - In the next step, go into the GETTSIM folder and set up the Python environment with
47
-
48
- ``` shell-session
49
- $ conda env create
50
- ```
51
-
52
44
Then, activate the environment and install the current GETTSIM version in the
53
45
repository in development mode. Also, install pre-commits which are checks before a
54
46
commit is accepted.
55
47
56
48
``` shell-session
57
- $ conda activate gettsim
58
- $ pre-commit install
49
+ $ pixi run pre-commit install
59
50
```
60
51
61
52
- Under Windows, yaml-files are by default not loaded with the correct encoding (UTF-8).
@@ -78,7 +69,7 @@ To contribute to the project, adhere to the following process.
78
69
they pass our test suite which can be started with the following command.
79
70
80
71
``` shell-session
81
- $ pytest
72
+ $ pixi run pytest
82
73
```
83
74
84
75
Sometimes you want to push changes even if the tests fail because you need feedback.
@@ -88,7 +79,7 @@ To contribute to the project, adhere to the following process.
88
79
message.
89
80
90
81
``` shell-session
91
- $ git commit -am "Add new parameters for ges_rente_beitrag in 2024."
82
+ $ pixi run git commit -am "Add new parameters for ges_rente_beitrag in 2024."
92
83
```
93
84
94
85
A commit starts the pre-commits which are additional checks, mostly formatting and
0 commit comments