Remove environment file

iza-institute-of-labor-economics · Oct 4, 2024 · e8ae70e · e8ae70e
1 parent 07b0f5f
commit e8ae70e
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 19 deletions.
diff --git a/docs/gettsim_developer/how-to-contribute.md b/docs/gettsim_developer/how-to-contribute.md
@@ -19,9 +19,7 @@ To contribute to the project, adhere to the following process.
 - Make sure you have the following programs installed and that these can be found on
   your path:
 
-  - A [Miniconda](https://docs.conda.io/en/latest/miniconda.html) (recommended) or
-    [Anaconda](https://www.anaconda.com/products/distribution) Python distribution.
-  - [Git](https://git-scm.com/downloads)
+  - [pixi](https://prefix.dev/docs/pixi/overview#installation) (Python package manager)
   - A modern text editor (e.g. [VS Code](https://code.visualstudio.com/))
 
 - 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.
   $ git clone https://github.com/<user>/gettsim
   ```
 
-- In the next step, go into the GETTSIM folder and set up the Python environment with
-
-  ```shell-session
-  $ conda env create
-  ```
-
   Then, activate the environment and install the current GETTSIM version in the
   repository in development mode. Also, install pre-commits which are checks before a
   commit is accepted.
 
   ```shell-session
-  $ conda activate gettsim
-  $ pre-commit install
+  $ pixi run pre-commit install
   ```
 
 - 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.
   they pass our test suite which can be started with the following command.
 
   ```shell-session
-  $ pytest
+  $ pixi run pytest
   ```
 
   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.
   message.
 
   ```shell-session
-  $ git commit -am "Add new parameters for ges_rente_beitrag in 2024."
+  $ pixi run git commit -am "Add new parameters for ges_rente_beitrag in 2024."
   ```
 
   A commit starts the pre-commits which are additional checks, mostly formatting and

diff --git a/docs/installation.md b/docs/installation.md
@@ -1,19 +1,27 @@
 # Installation
 
-You can install GETTSIM easily using [conda](https://conda.io/), the standard package
-manager for scientific Python libraries. If conda is not installed on your machine,
-please follow conda's
-[installation instructions](https://docs.conda.io/projects/conda/en/latest/user-guide/install/).
+You can install GETTSIM easily using [conda](https://conda.io/) or
+[pixi](https://pixi.sh/latest/). If these are not installed on your machine, please
+follow conda's
+[installation instructions](https://docs.conda.io/projects/conda/en/latest/user-guide/install/)
+or pixi's
+[installation instructions](https://prefix.dev/docs/pixi/overview#installation).
 
-With conda available on your path, installing GETTSIM is as simple as typing
+With one of these available on your path, installing GETTSIM is as simple as typing
 
 ```shell-session
 $ conda install -c conda-forge gettsim
 ```
 
+or
+
+```shell-session
+$ pixi add gettsim
+```
+
 in a command shell.
 
-To validate the installation, start the conda Python interpreter and type
+To validate the installation, start the Python interpreter and type
 
 ```python
 import gettsim