Merge pull request #7 from ssciwr/add_conda_ci

Add conda CI and local use instructions, add buttons for colab/binder in quickstart

Author: lkeegan

.github/workflows/notebooks.yml

@@ -7,15 +7,39 @@ on:
     branches:
       - main
 jobs:
-  deploy:
-    runs-on: ubuntu-latest
+  pypi:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ["ubuntu-latest", "macos-latest", "windows-latest"]
+        python-version: ["3.11", "3.12", "3.13"]
+    runs-on: ${{ matrix.os }}
+    name: "${{ matrix.os }} :: pypi :: ${{ matrix.python-version }}"
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.12"
+          python-version: ${{ matrix.python-version }}
       - run : |
           pip install uv
           uv pip install --system -r requirements.txt
       - run: |
           jupyter execute notebooks/example.ipynb
+  conda-forge:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ["ubuntu-latest", "macos-latest"]
+    runs-on: ${{ matrix.os }}
+    name: "${{ matrix.os }} :: conda-forge"
+    timeout-minutes: 15
+    defaults:
+      run:
+        shell: bash -leo pipefail {0}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: mamba-org/setup-micromamba@v1
+        with:
+          environment-file: environment.yml
+      - run: |
+          jupyter execute notebooks/example.ipynb

docs/index.md

@@ -6,22 +6,56 @@ Some text about what this is...
 
 Our example notebook shows how you can download a dataset from heiData.
 
-### Online with Colab
+### Online
 
-You can run our example notebook online without installing anything locally using Google Colab (Google account required):
+You can run our example notebook online without installing anything on your computer.
 
-[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ssciwr/QHCC/blob/main/notebooks/example.ipynb)
+<div class="grid cards" markdown>
 
-### Online with Binder
+-   __Google Colab__
 
-Alternatively you can run it online using Binder:
+    ---
 
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ssciwr/QHCC/HEAD?labpath=notebooks%2Fexample.ipynb)
+	[Open In Colab](https://colab.research.google.com/github/ssciwr/QHCC/blob/main/notebooks/example.ipynb){ .md-button }
 
-### Locally with Docker
+    (Google account required)
 
-todo
+-   __Binder__
+
+    ---
+
+	[Open in Binder](https://mybinder.org/v2/gh/ssciwr/QHCC/HEAD?labpath=notebooks%2Fexample.ipynb){ .md-button }
+</div>
 
 ### Locally
 
-todo
+Alternatively you can run it on your computer.
+
+First clone the repository using git:
+
+```bash
+git clone https://github.com/ssciwr/QHCC
+cd QHCC
+```
+
+Then install the required Python libraries and launch JupyterLab:
+
+=== "pip"
+    ```bash
+    pip install -r requirements.txt
+    jupyter lab notebooks/example.ipynb
+    ```
+
+=== "conda"
+    ```bash
+    conda env create -f environment.yml
+    conda activate QHCC
+    jupyter lab notebooks/example.ipynb
+    ```
+
+=== "micromamba"
+    ```bash
+    micromamba env create -f environment.yml
+    micromamba activate QHCC
+    jupyter lab notebooks/example.ipynb
+    ```

environment.yml

@@ -0,0 +1,8 @@
+name: QHCC
+channels:
+  - conda-forge
+dependencies:
+  - python
+  - pooch
+  - pandas
+  - jupyter

mkdocs.yml

@@ -15,6 +15,8 @@ markdown_extensions:
   - pymdownx.inlinehilite
   - pymdownx.snippets
   - pymdownx.superfences
+  - attr_list
+  - md_in_html
 nav:
   - Home: index.md
   - Data: data.md