frgfp 0.1.0rc1__tar.gz

frgfp-0.1.0rc1/.devcontainer/devcontainer.json

@@ -0,0 +1,23 @@
+{
+  "name": "FRGfp dev",
+  "dockerComposeFile": ["../compose.yaml"],
+  "service": "dev",
+  "workspaceFolder": "/workspace",
+  "remoteUser": "dev",
+  "postCreateCommand": "python -c 'import frgfp' || pip install -e .",
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "ms-vscode.cpptools",
+        "ms-toolsai.jupyter"
+      ],
+      "settings": {
+        "python.defaultInterpreterPath": "/opt/venv/bin/python",
+        "python.testing.pytestEnabled": true,
+        "python.testing.pytestArgs": ["frgfp"]
+      }
+    }
+  }
+}

frgfp-0.1.0rc1/.dockerignore

@@ -0,0 +1,13 @@
+# Keep the image build context small: only requirements.txt and docker/ are used.
+.git/
+build/
+doc/build/
+.pytest_cache/
+.benchmarks/
+.venv/
+__pycache__/
+*.py[cod]
+*.so
+sandbox/
+.vscode/
+.idea/

frgfp-0.1.0rc1/.github/workflows/ci.yml

@@ -0,0 +1,210 @@
+name: CI
+
+# Pull requests into the two long-lived integration branches must build and test
+# the package on every supported OS/Python combination before they can be merged.
+on:
+  pull_request:
+    branches: [rc, main]
+    types: [opened, synchronize, reopened, ready_for_review]
+  push:
+    branches: [rc, main]
+  workflow_dispatch:
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
+permissions:
+  contents: read
+
+env:
+  # cibuildwheel's downloaded CPythons/tools live here so they can be cached.
+  CIBW_CACHE_PATH: ${{ github.workspace }}/.cibuildwheel-cache
+
+jobs:
+  # ---------------------------------------------------------------------------
+  # Build the wheel and run the test suite on every OS/architecture/CPython.
+  # cibuildwheel installs the freshly built wheel into a clean virtual
+  # environment and runs pytest from a temporary directory, so the tests always
+  # exercise the installed binary rather than the source tree.
+  # ---------------------------------------------------------------------------
+  wheels:
+    name: wheel · ${{ matrix.runner.name }} · cp${{ matrix.python }}
+    runs-on: ${{ matrix.runner.os }}
+    timeout-minutes: 60
+    strategy:
+      fail-fast: false
+      matrix:
+        python: ["310", "311", "312", "313", "314"]
+        # Runner labels are pinned deliberately: the build environment - and with
+        # it the Homebrew bottles that delocate has to accept - should only change
+        # when we bump them on purpose.  `macos-26` is the Apple Silicon image.
+        #
+        # macOS is Apple Silicon only: numba >= 0.63 and llvmlite >= 0.46 publish
+        # no Intel (x86_64) macOS wheels, so a test environment for an Intel wheel
+        # cannot even be created from PyPI.  Intel macOS users install from the
+        # sdist or use conda-forge; see RELEASING.md and the platform support table
+        # in doc/source/installation.rst.  The archs column drives CIBW_ARCHS.
+        runner:
+          - {name: linux-x86_64, os: ubuntu-24.04, archs: x86_64}
+          - {name: linux-aarch64, os: ubuntu-24.04-arm, archs: aarch64}
+          - {name: macos-arm64, os: macos-26, archs: arm64}
+          - {name: windows-amd64, os: windows-2022, archs: AMD64}
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          # setuptools_scm derives the version from the git history and tags.
+          fetch-depth: 0
+          fetch-tags: true
+
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
+
+      - name: Cache cibuildwheel's tool downloads
+        uses: actions/cache@v6
+        with:
+          path: |
+            ${{ env.CIBW_CACHE_PATH }}
+            ~/frgfp-libomp
+            ~/frgfp-libomp-tarball
+          key: cibw-${{ matrix.runner.name }}-${{ hashFiles('pyproject.toml', 'tools/ci/build_libomp.sh') }}
+
+      - name: Prepare the macOS OpenMP runtime
+        if: runner.os == 'macOS'
+        shell: bash
+        # The build links the libomp that before-all compiled for the wheel's
+        # deployment target and delocate bundles it into the wheel; the Homebrew
+        # keg is installed only as the fallback for the build (CMakeLists.txt).
+        #
+        # The tests must never load a *second* OpenMP runtime: the extension
+        # loads the bundled one, and if numba's omp layer additionally dlopens
+        # Homebrew's copy, the OpenMP runtime aborts the whole process ("OMP:
+        # Error #15 ... already initialized", which the runner reports as exit
+        # code -6).  Pinning numba to its dependency-free workqueue layer keeps
+        # exactly one runtime in the process; frgfp/lpa/_solver.py honours an
+        # explicit NUMBA_THREADING_LAYER.
+        run: |
+          brew list libomp >/dev/null 2>&1 || brew install libomp
+          echo "NUMBA_THREADING_LAYER=workqueue" >> "$GITHUB_ENV"
+
+      - name: Build the wheel and run pytest
+        uses: pypa/cibuildwheel@v4.2.1
+        env:
+          CIBW_BUILD: cp${{ matrix.python }}-*
+          CIBW_ARCHS: ${{ matrix.runner.archs }}
+          # macOS only: report a failing test run as a GitHub annotation.
+          # Annotations are readable without repository admin rights, so the real
+          # error is visible on the pull request rather than only in the
+          # (admin-only) job log.
+          CIBW_TEST_COMMAND_MACOS: >-
+            log=$(mktemp); python -m pytest --pyargs frgfp -m "not benchmark" -q >"$log" 2>&1
+            || { cat "$log"; echo "::error::pytest failed: $(tail -n 5 "$log" | tr '\n' ' ')"; exit 1; };
+            cat "$log"
+
+      - name: Upload the wheel
+        uses: actions/upload-artifact@v7
+        with:
+          name: wheel-cp${{ matrix.python }}-${{ matrix.runner.name }}
+          path: ./wheelhouse/*.whl
+          if-no-files-found: error
+
+
+  # ---------------------------------------------------------------------------
+  # The source distribution must be self-contained: build it, install it into a
+  # clean environment and run the same tests against it.
+  # ---------------------------------------------------------------------------
+  sdist:
+    name: sdist
+    runs-on: ubuntu-24.04
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
+
+      - name: Build the sdist
+        run: |
+          python -m pip install --upgrade build
+          python -m build --sdist --outdir dist
+
+      - name: Install the sdist and run pytest
+        run: |
+          python -m venv /tmp/sdist-venv
+          /tmp/sdist-venv/bin/python -m pip install "dist/frgfp-"*.tar.gz
+          /tmp/sdist-venv/bin/python -m pip install pytest pytest-benchmark
+          cd /tmp
+          /tmp/sdist-venv/bin/python -m pytest --pyargs frgfp -m "not benchmark" -q
+
+      - name: Upload the sdist
+        uses: actions/upload-artifact@v7
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+          if-no-files-found: error
+
+  # ---------------------------------------------------------------------------
+  # The documentation must build (warnings are errors) even before it is
+  # published.  It imports the package, so the prebuilt Linux wheel is reused
+  # instead of compiling the extension a second time.
+  # ---------------------------------------------------------------------------
+  docs:
+    name: docs
+    runs-on: ubuntu-24.04
+    timeout-minutes: 30
+    needs: [wheels]
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
+
+      - name: Fetch the Linux wheel built above
+        uses: actions/download-artifact@v8
+        with:
+          name: wheel-cp312-linux-x86_64
+          path: dist
+
+      - name: Install the wheel and the documentation toolchain
+        run: |
+          python -m pip install dist/*.whl
+          python -m pip install -r requirements.txt
+
+      - name: Build the documentation
+        run: sphinx-build -b html -W --keep-going doc/source doc/build/html
+
+      - name: Upload the documentation
+        uses: actions/upload-artifact@v7
+        with:
+          name: docs-html
+          path: doc/build/html
+          if-no-files-found: error
+
+  # ---------------------------------------------------------------------------
+  # Single required status check: enable only this job in the branch protection
+  # rules of `rc` and `main`, so the matrix can grow without touching settings.
+  # ---------------------------------------------------------------------------
+  ci:
+    name: ci
+    if: always()
+    needs: [wheels, sdist, docs]
+    runs-on: ubuntu-24.04
+    timeout-minutes: 5
+    steps:
+      - name: Fail if any required job failed
+        if: contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')
+        run: |
+          echo "::error::a required job failed or was cancelled"
+          exit 1
+
+      - name: Report success
+        run: echo "All required jobs succeeded."

frgfp-0.1.0rc1/.github/workflows/docs-dev.yml

@@ -0,0 +1,70 @@
+name: Docs preview (dev)
+
+# Publishes the documentation of the `develop` branch to /dev/ so the version
+# switcher always has a preview entry.  /latest/ is never touched from here.
+# Delete this file if you do not want a continuously updated preview.
+on:
+  push:
+    branches: [develop]
+  workflow_dispatch:
+
+concurrency:
+  group: docs-dev
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+env:
+  DOCS_BASE_URL: https://molbarnabas.github.io/frgfp/
+
+jobs:
+  dev-docs:
+    name: dev docs
+    runs-on: ubuntu-24.04
+    timeout-minutes: 30
+    permissions:
+      contents: write # the docs are committed to the gh-pages branch
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
+
+      - name: Install the package and the documentation toolchain
+        run: |
+          python -m pip install .
+          python -m pip install -r requirements.txt
+
+      - name: Build the documentation
+        env:
+          DOC_VERSION_MATCH: dev
+        run: sphinx-build -b html -W --keep-going doc/source doc/build/html
+
+      - name: Check out the published documentation branch
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          set -euo pipefail
+          git init -q _pages
+          git -C _pages remote add origin \
+            "https://x-access-token:${GH_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
+          if git -C _pages fetch --depth=1 origin gh-pages; then
+            git -C _pages checkout -q -B gh-pages FETCH_HEAD
+          else
+            git -C _pages checkout -q --orphan gh-pages
+          fi
+
+      - name: Publish the preview
+        run: |
+          python tools/ci/deploy_docs.py \
+            --pages-dir _pages \
+            --html-dir doc/build/html \
+            --version dev \
+            --target version \
+            --base-url "$DOCS_BASE_URL" \
+            --branch gh-pages