Skip to content

Commit e8ae70e

Browse files
committed
Remove environment file
1 parent 07b0f5f commit e8ae70e

File tree

2 files changed

+18
-19
lines changed

2 files changed

+18
-19
lines changed

docs/gettsim_developer/how-to-contribute.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,7 @@ To contribute to the project, adhere to the following process.
1919
- Make sure you have the following programs installed and that these can be found on
2020
your path:
2121

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)
2523
- A modern text editor (e.g. [VS Code](https://code.visualstudio.com/))
2624

2725
- 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.
4341
$ git clone https://github.com/<user>/gettsim
4442
```
4543

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-
5244
Then, activate the environment and install the current GETTSIM version in the
5345
repository in development mode. Also, install pre-commits which are checks before a
5446
commit is accepted.
5547

5648
```shell-session
57-
$ conda activate gettsim
58-
$ pre-commit install
49+
$ pixi run pre-commit install
5950
```
6051

6152
- 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.
7869
they pass our test suite which can be started with the following command.
7970

8071
```shell-session
81-
$ pytest
72+
$ pixi run pytest
8273
```
8374

8475
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.
8879
message.
8980

9081
```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."
9283
```
9384

9485
A commit starts the pre-commits which are additional checks, mostly formatting and

docs/installation.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,27 @@
11
# Installation
22

3-
You can install GETTSIM easily using [conda](https://conda.io/), the standard package
4-
manager for scientific Python libraries. If conda is not installed on your machine,
5-
please follow conda's
6-
[installation instructions](https://docs.conda.io/projects/conda/en/latest/user-guide/install/).
3+
You can install GETTSIM easily using [conda](https://conda.io/) or
4+
[pixi](https://pixi.sh/latest/). If these are not installed on your machine, please
5+
follow conda's
6+
[installation instructions](https://docs.conda.io/projects/conda/en/latest/user-guide/install/)
7+
or pixi's
8+
[installation instructions](https://prefix.dev/docs/pixi/overview#installation).
79

8-
With conda available on your path, installing GETTSIM is as simple as typing
10+
With one of these available on your path, installing GETTSIM is as simple as typing
911

1012
```shell-session
1113
$ conda install -c conda-forge gettsim
1214
```
1315

16+
or
17+
18+
```shell-session
19+
$ pixi add gettsim
20+
```
21+
1422
in a command shell.
1523

16-
To validate the installation, start the conda Python interpreter and type
24+
To validate the installation, start the Python interpreter and type
1725

1826
```python
1927
import gettsim

0 commit comments

Comments
 (0)