Switch to pixi (#74)

.github/depandabot.yml

@@ -0,0 +1,11 @@
+---
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly  # or daily, weekly
+    groups:
+      dependencies:
+        patterns:
+          - '*'

.github/workflows/main.yml

@@ -23,30 +23,35 @@ jobs:
           - macos-latest
           - windows-latest
         python-version:
-          - '3.11'
+          - '3.12'
     steps:
-      - uses: actions/checkout@v3
-      - name: create test environment
-        uses: mamba-org/setup-micromamba@v1
+      - uses: actions/checkout@v4
+      - uses: prefix-dev/setup-pixi@v0.8.0
         with:
-          environment-file: ./.envs/testenv.yml
-          environment-name: lcm
-          cache-environment: true
-          create-args: >-
-            python=${{ matrix.python-version }}
+          pixi-version: v0.23.0
+          cache: true
+          cache-write: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
+          environments: test-cpu
+          activate-environment: true
       - name: Run pytest
         shell: bash -l {0}
-        run: |
-          micromamba activate lcm
-          pytest --cov-report=xml --cov=./
+        run: pixi run -e test-cpu tests
       - name: Upload coverage report
-        if: runner.os == 'Linux' && matrix.python-version == '3.11'
-        uses: codecov/codecov-action@v3
+        if: runner.os == 'Linux' && matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v4
+  run-mypy:
+    name: Run mypy on Python 3.12
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v4
+      - uses: prefix-dev/setup-pixi@v0.8.0
         with:
-          token: ${{ secrets.CODECOV_TOKEN }}
+          pixi-version: v0.23.0
+          cache: true
+          cache-write: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
+          environments: mypy
       - name: Run mypy
         shell: bash -l {0}
-        if: runner.os == 'Linux' && matrix.python-version == '3.11'
-        run: |-
-          micromamba activate lcm
-          mypy src
+        run: pixi run mypy

.gitignore

@@ -126,6 +126,5 @@ venv.bak/
 
 
 .pytask.sqlite3
-
-
 src/lcm/_version.py
+.pixi

.pre-commit-config.yaml

@@ -9,6 +9,16 @@ repos:
     rev: 1.16.0
     hooks:
       - id: yamlfix
+  - repo: local
+    hooks:
+      - id: check-nbqa-version-mismatch
+        name: Check for version mismatch between black, ruff, and nbQA
+        entry: python scripts/check_nbqa_version_mismatch.py
+        language: python
+        always_run: true
+        require_serial: true
+        additional_dependencies:
+          - pyyaml
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.6.0
     hooks:
@@ -49,13 +59,13 @@ repos:
     rev: 24.4.2
     hooks:
       - id: black
-        language_version: python3.11
+        language_version: python3.12
   - repo: https://github.com/asottile/blacken-docs
     rev: 1.16.0
     hooks:
       - id: blacken-docs
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.4.4
+    rev: v0.4.6
     hooks:
       - id: ruff
       #   args:
@@ -65,10 +75,10 @@ repos:
     hooks:
       - id: nbqa-black
         additional_dependencies:
-          - black==24.4.0
+          - black==24.4.2
       - id: nbqa-ruff
         additional_dependencies:
-          - ruff==v0.3.7
+          - ruff==v0.4.6
   - repo: https://github.com/executablebooks/mdformat
     rev: 0.7.17
     hooks:
@@ -80,14 +90,5 @@ repos:
           - --wrap
           - '88'
         files: (README\.md)
-  - repo: https://github.com/mgedmin/check-manifest
-    rev: '0.49'
-    hooks:
-      - id: check-manifest
-        args:
-          - --no-build-isolation
-        additional_dependencies:
-          - setuptools-scm
-          - toml
 ci:
   autoupdate_schedule: monthly

README.md

@@ -6,3 +6,13 @@
 
 This package aims to generalize and facilitate the specification, solution, and
 estimation of dynamic choice models.
+
+## Installation
+
+`LCM` currently needs to be installed from GitHub and requires `jax` and `jaxlib`. If
+you aim to run `LCM` on a GPU, you need to install `jaxlib` with CUDA support (for
+Linux) or with support for AMD GPUs / ARM-based Silicon GPUs (for MacOS). In any case,
+for installation of `jax` and `jaxlib`, please consult the `jax`
+[docs](https://jax.readthedocs.io/en/latest/installation.html#supported-platforms).
+
+> **Note:** We currently test GPU support for `LCM` only on Linux with CUDA 12.