Publication-ready v2: GitHub Actions CI, Sphinx docs, PyPI publishing; drop Docker/Binder

.github/workflows/docs.yml

@@ -0,0 +1,65 @@
+name: Documentation
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+  workflow_dispatch:
+
+# Allow the deploy job to publish to GitHub Pages.
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# One concurrent Pages deployment; do not cancel a run in progress.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build Sphinx docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          cache: pip
+
+      - name: Install pycurious with docs extras
+        # examples + mapping are needed so the tutorial notebooks execute at
+        # build time (matplotlib/cartopy/pyproj/netCDF4).
+        run: python -m pip install -e ".[docs,examples,mapping]"
+
+      - name: Copy tutorial notebooks into the docs tree
+        run: python docs/copy_notebooks.py
+
+      - name: Build HTML
+        # Not -W: the function docstrings are pdoc-flavoured Markdown that emits
+        # cosmetic RST warnings under autodoc. The real quality gate is
+        # nb_execution_raise_on_error in conf.py — a tutorial that fails to
+        # execute fails the build.
+        run: sphinx-build -b html docs docs/_build/html
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_build/html
+
+  deploy:
+    name: Deploy to GitHub Pages
+    # Only publish from master; PRs build above but do not deploy.
+    if: github.ref == 'refs/heads/master' && github.event_name == 'push'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/publish.yml

@@ -0,0 +1,55 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build distributions
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Build sdist and wheel
+        run: |
+          python -m pip install --upgrade build twine
+          python -m build
+
+      - name: Check the distributions
+        run: python -m twine check dist/*
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    # Trusted Publishing: PyPI mints a short-lived token from this workflow's
+    # OIDC identity, so no password or API token is stored. Configure the
+    # trusted publisher once on PyPI (project pycurious): owner brmather,
+    # repository pycurious, workflow publish.yml, environment pypi.
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pycurious
+    permissions:
+      id-token: write
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/tests.yml

@@ -0,0 +1,40 @@
+name: Tests
+
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: pytest (Python ${{ matrix.python-version }} on ${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        include:
+          # one macOS leg on the newest interpreter, to catch platform issues
+          - os: macos-latest
+            python-version: "3.13"
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install pycurious with test extra
+        # The suite imports only pytest, numpy, scipy and pycurious itself;
+        # numpy/scipy are core dependencies and `import pycurious` stays light
+        # because mapping/download lazy-import their heavy deps. So the `test`
+        # extra (just pytest) is all that is needed to run everything.
+        run: python -m pip install -e ".[test]"
+
+      - name: Run the full test suite
+        run: pytest -v

.gitignore

@@ -1,8 +1,38 @@
-pycurious-src/pycurious/Examples/Notebooks/Bouligand/.ipynb_checkpoints/*
-pycurious-src/pycurious/Examples/Notebooks/Tanaka/.ipynb_checkpoints/*
-pycurious-src/pycurious/Examples/.ipynb_checkpoints/*
+# Python
 *.pyc
+__pycache__/
+*.so
 .eggs
-build
 *.egg-info
-*.so
+build
+dist
+.pytest_cache/
+
+# Jupyter
+.ipynb_checkpoints/
+
+# macOS
+.DS_Store
+
+# Datasets fetched by pycurious.download at notebook runtime. These are
+# hundreds of megabytes and are reproducible from their URL and checksum, so
+# they are cached locally rather than committed. Everything in Examples/data
+# is ignored except the small synthetic anomaly the tests rely on.
+Examples/data/*
+!Examples/data/test_mag_data.txt
+
+# Rasters and grids written by the notebooks themselves, e.g. the GeoTIFF
+# exported at the end of Ex5.
+*.tif
+*.tiff
+*.npz
+!tests/*.npz
+
+# Sphinx build output, and the tutorial notebooks + data fixture that
+# docs/copy_notebooks.py stages into the source tree on every build. These are
+# regenerated from Examples/, so they are never committed.
+docs/_build/
+docs/tutorials/bouligand/
+docs/tutorials/tanaka/
+docs/data/
+docs/api/generated/