Dev (#31)

* convert readme directions into checklist

* add instructions for installing packages via conda for nox test

* use mamba for creating environment in ci workflow

* add api rst file

Author: mdtanker

.github/workflows/ci.yml

@@ -17,6 +17,10 @@ env:
   # for libraries that care about the value set.
   FORCE_COLOR: 3
 
+defaults:
+  run:
+    shell: bash -el {0}
+
 jobs:
   lint:
     name: Pylint
@@ -47,29 +51,35 @@ jobs:
         python-version: ["3.11", "3.12", "3.13"]
         runs-on: [ubuntu-latest, windows-latest, macos-14]
 
-        include:
-          - python-version: "pypy-3.11"
-            runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@v5
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-          allow-prereleases: true
+      - name: Switch to Current Branch
+        run: git checkout ${{ env.BRANCH }}
 
-      - uses: astral-sh/setup-uv@v6
+      - name: Get current week number of year
+        id: date
+        run: echo "date=$(date +%Y-W%W)" >> $GITHUB_OUTPUT # e.g., 2024-W19
+
+      # Install Micromamba with conda-forge dependencies
+      - name: Setup Micromamba
+        uses: mamba-org/setup-micromamba@v2
+        with:
+          environment-file: environment.yml
+          post-cleanup: "all"
+          cache-downloads: false
+          # environment cache is persistent for one week.
+          cache-environment-key:
+            micromamba-environment-${{ steps.date.outputs.date }}
 
       - name: Install package
-        run: uv sync
+        run: pip install --no-deps -e .
 
       - name: Run the tests
         run: >-
-          uv run pytest -ra --cov --cov-report=xml --cov-report=term
-          --durations=20
+          pytest -ra --cov --cov-report=xml --cov-report=term --durations=20
 
       - name: Upload coverage report
         uses: codecov/codecov-action@v5