rivoli 0.1.0__tar.gz

rivoli-0.1.0/.copier-answers.yml

@@ -0,0 +1,29 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: v0.1.2
+_src_path: gh:fmargall/scientific-python-template
+author_email: fr.margall@proton.me
+author_family_names: Margall
+author_given_names: François
+author_orcid: https://orcid.org/0009-0004-0585-087X
+conduct_email: fr.margall@proton.me
+copyright_holder: François Margall
+copyright_year: '2026'
+creation_date: '2026-10-26'
+distribution_name: rivoli
+homepage_url: ''
+keywords:
+- interpolation
+- brdf
+- rbf
+- ebf
+- erbf
+- pbr
+- modeling
+license: AGPL-3.0-or-later
+package_name: rivoli
+project_description: Physically-based interpolation code by radial basis function
+    dedicated to BRDF, spherical or bispherical modeling functions and data reconstruction.
+project_name: RIVOLI
+python_min_version: '3.13'
+repository_url: https://github.com/fmargall/rivoli
+use_codecov: true

rivoli-0.1.0/.editorconfig

@@ -0,0 +1,27 @@
+# https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 4
+
+[*.py]
+max_line_length = 100
+
+[*.{yaml,yml,json,cff}]
+indent_size = 2
+
+[*.md]
+# Two trailing spaces are a hard line break in Markdown
+trim_trailing_whitespace = false
+indent_size = 2
+
+[*.{bat,cmd,ps1}]
+end_of_line = crlf
+
+[Makefile]
+indent_style = tab

rivoli-0.1.0/.git-blame-ignore-revs

@@ -0,0 +1,6 @@
+# Commits ignored by `git blame` (formatting-only changes).
+# Add the full 40-character hash of each such commit, one per line,
+# with a comment describing it.
+#
+# Enable locally with:
+#   git config blame.ignoreRevsFile .git-blame-ignore-revs

rivoli-0.1.0/.git_archival.txt

@@ -0,0 +1,3 @@
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$

rivoli-0.1.0/.gitattributes

@@ -0,0 +1,15 @@
+# Normalize line endings in the repository regardless of the OS
+* text=auto eol=lf
+
+*.bat text eol=crlf
+*.cmd text eol=crlf
+*.ps1 text eol=crlf
+
+*.png binary
+*.jpg binary
+*.npy binary
+*.npz binary
+*.exr binary
+
+# Let setuptools-scm read the version from git archives (GitHub, Zenodo)
+.git_archival.txt export-subst

rivoli-0.1.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,20 @@
+name: Bug report
+description: "Report something in RIVOLI that does not work as expected."
+labels: [bug]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Bug description
+      description: >-
+        What happens, and what you expected instead. A short example reproducing it and the
+        full error message help a lot, if you have them.
+    validations:
+      required: true
+
+  - type: textarea
+    id: system
+    attributes:
+      label: System information
+      description: "Versions of RIVOLI and Python, and operating system."
+      placeholder: "RIVOLI 0.1.0, Python 3.13, Ubuntu 24.04"

rivoli-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+# Settings of the "New issue" chooser page
+# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
+
+# The forms of this folder cover the usual cases (bugs, features, questions,
+# documentation), but a blank issue stays available for anything they do not fit.
+# The link to report a security vulnerability privately is added by GitHub itself,
+# from SECURITY.md
+blank_issues_enabled: true

rivoli-0.1.0/.github/ISSUE_TEMPLATE/documentation.yml

@@ -0,0 +1,17 @@
+name: Documentation
+description: "Report missing, incorrect or unclear documentation of RIVOLI."
+labels: [documentation]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Documentation issue
+      description: What is missing, incorrect or unclear, and where (a link to the page or section helps).
+    validations:
+      required: true
+
+  - type: textarea
+    id: suggestion
+    attributes:
+      label: Suggested improvement
+      description: How the documentation could be improved, if you have an idea.

rivoli-0.1.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,17 @@
+name: Feature request
+description: "Suggest a new feature or an improvement of RIVOLI."
+labels: [enhancement]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Feature description
+      description: What you would like, and the need behind it.
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Examples, alternatives you have considered, or references to papers or other tools.

rivoli-0.1.0/.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,17 @@
+name: Question
+description: "Ask a question about the usage of RIVOLI."
+labels: [question]
+body:
+  - type: textarea
+    id: question
+    attributes:
+      label: Question
+      description: What you would like to know.
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Context
+      description: What you are trying to achieve, what you have already tried, and the versions you use.

rivoli-0.1.0/.github/codecov.yml

@@ -0,0 +1,20 @@
+coverage:
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 1%
+    patch:
+      default:
+        # Same threshold as fail_under in [tool.coverage.report] of pyproject.toml
+        target: 90%
+
+codecov:
+  notify:
+    # Wait for the uploads of all the runs of the tests job of ci.yml. Computed
+    # from the Python versions by the template: `copier update` keeps it in sync
+    after_n_builds: 4
+
+comment:
+  # Same as codecov.notify.after_n_builds
+  after_n_builds: 4

rivoli-0.1.0/.github/dependabot.yml

@@ -0,0 +1,71 @@
+# Version updates of the dependencies, opened as pull requests by Dependabot
+# https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference
+#
+# Dependabot only opens PRs: nothing changes until one is merged.
+# In each ecosystem, an update goes into the first group it matches, so order
+# matters. Ungrouped updates (majors, unless stated otherwise) get one PR each,
+# so their release notes can be reviewed on their own.
+version: 2
+updates:
+  # GitHub Actions used in .github/workflows (pinned by SHA, version in trailing comment)
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    # Wait a week before proposing a new release, so compromised versions get pulled first
+    cooldown:
+      default-days: 7
+    # Follow the gitmoji + Conventional Commits convention: "⬆️ ci: bump ..."
+    commit-message:
+      prefix: "⬆️ ci"
+    groups:
+      # upload-artifact and download-artifact must share the same major version,
+      # so they always move together, majors included. They only run in release.yml,
+      # which does not run on PRs: a green CI does not prove they work.
+      artifacts:
+        patterns:
+          - "actions/upload-artifact"
+          - "actions/download-artifact"
+      # Every other action: minor and patch updates are batched into a single PR
+      actions:
+        patterns: ["*"]
+        update-types: ["minor", "patch"]
+
+  # Python dependencies of pyproject.toml, and their locked versions in uv.lock
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    # Wait a week before proposing a new release, so compromised versions get pulled first
+    cooldown:
+      default-days: 7
+    # Follow the gitmoji + Conventional Commits convention: "⬆️ build: bump ..."
+    commit-message:
+      prefix: "⬆️ build"
+    groups:
+      # Every dependency: minor and patch updates are batched into a single PR.
+      # This includes pyright, pinned in pyproject.toml: its PR is where a new
+      # release, which can add new errors, is deliberately accepted.
+      python:
+        patterns: ["*"]
+        update-types: ["minor", "patch"]
+
+  # Hooks of .pre-commit-config.yaml (rev of each hook repository)
+  - package-ecosystem: "pre-commit"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+    # Wait a week before proposing a new release, so compromised versions get pulled first
+    cooldown:
+      default-days: 7
+    # Follow the gitmoji + Conventional Commits convention: "⬆️ chore: bump ..."
+    commit-message:
+      prefix: "⬆️ chore"
+    groups:
+      # Every hook: minor and patch updates are batched into a single PR
+      hooks:
+        patterns: ["*"]
+        update-types: ["minor", "patch"]

rivoli-0.1.0/.github/pull_request_template.md

@@ -0,0 +1,16 @@
+<!--
+The title of the pull request follows gitmoji and Conventional Commits, for
+example "✨ feat(io): add the CSV export". It becomes the commit message of the
+squash merge, and it feeds the release notes.
+-->
+
+## Summary
+
+<!-- What does this change, and why? Link the issue or the ADR it implements. -->
+
+## Checklist
+
+- [ ] Tests cover the change.
+- [ ] `CHANGELOG.md` is updated, or the change is not visible to users.
+- [ ] A decision that deserves a record has one in `docs/adr/`.
+- [ ] Every ADR changed or added here has its final status, in its file and in the index.

rivoli-0.1.0/.github/rulesets/main.json

@@ -0,0 +1,53 @@
+{
+  "name": "main",
+  "target": "branch",
+  "enforcement": "active",
+  "conditions": {
+    "ref_name": {
+      "exclude": [],
+      "include": [
+        "~DEFAULT_BRANCH"
+      ]
+    }
+  },
+  "rules": [
+    {
+      "type": "deletion"
+    },
+    {
+      "type": "non_fast_forward"
+    },
+    {
+      "type": "required_linear_history"
+    },
+    {
+      "type": "pull_request",
+      "parameters": {
+        "required_approving_review_count": 0,
+        "dismiss_stale_reviews_on_push": false,
+        "required_reviewers": [],
+        "require_code_owner_review": false,
+        "require_last_push_approval": false,
+        "required_review_thread_resolution": false,
+        "require_extra_approval_for_unattributed_changes": true,
+        "allowed_merge_methods": [
+          "squash"
+        ]
+      }
+    },
+    {
+      "type": "required_status_checks",
+      "parameters": {
+        "strict_required_status_checks_policy": false,
+        "do_not_enforce_on_create": false,
+        "required_status_checks": [
+          {
+            "context": "ci-passed",
+            "integration_id": 15368
+          }
+        ]
+      }
+    }
+  ],
+  "bypass_actors": []
+}

rivoli-0.1.0/.github/rulesets/version-tags.json

@@ -0,0 +1,25 @@
+{
+  "name": "version-tags",
+  "target": "tag",
+  "enforcement": "active",
+  "conditions": {
+    "ref_name": {
+      "exclude": [],
+      "include": [
+        "refs/tags/v*"
+      ]
+    }
+  },
+  "rules": [
+    {
+      "type": "deletion"
+    },
+    {
+      "type": "non_fast_forward"
+    },
+    {
+      "type": "update"
+    }
+  ],
+  "bypass_actors": []
+}

rivoli-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,132 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  # Called by release.yml before publishing anything
+  workflow_call:
+  # Run by hand from the Actions tab, for example to check a branch again after
+  # a dependency release, without pushing anything
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
+      # pre-commit is run directly, not with pre-commit/action: that action calls
+      # actions/cache by tag, which the SHA pinning required by
+      # scripts/configure-github.sh rejects
+      - run: uvx pre-commit run --all-files --show-diff-on-failure
+        env:
+          # pyright needs the project installed: it runs in the typecheck job
+          SKIP: pyright
+
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          # setuptools-scm needs the tags to compute the version at install time
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
+        with:
+          # Oldest supported version, matching pythonVersion in [tool.pyright],
+          # so that dependencies are resolved as on that version
+          python-version: "3.13"
+      # --locked fails if uv.lock is out of date with pyproject.toml
+      - run: uv sync --locked
+      # --no-sync: uv run would otherwise sync the environment again
+      - run: uv run --no-sync pyright
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
+      - run: uv build
+      - run: uvx twine check --strict dist/*
+
+  tests:
+    runs-on: ubuntu-latest
+    # id-token lets the Codecov upload authenticate with a short-lived OIDC token
+    # instead of a stored secret. Job-level permissions replace the workflow-level
+    # ones, so contents: read must be granted again here.
+    permissions:
+      contents: read
+      id-token: write
+    strategy:
+      fail-fast: false
+      matrix:
+        # From python_min_version of .copier-answers.yml to the newest Python
+        # release: `copier update` adds each new release.
+        # Each run uploads a coverage report: after_n_builds of .github/codecov.yml is
+        # computed from this matrix by the template, and updated along with it.
+        python-version: ["3.13", "3.14", "3.15"]
+        deps: [locked]
+        include:
+          # The locked versions hide the breaking releases of the dependencies:
+          # one more run with their newest versions catches them before the users
+          - python-version: "3.15"
+            deps: latest
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
+        with:
+          python-version: ${{ matrix.python-version }}
+      # h5py publishes no wheels for Python 3.15 yet: it is built from source, which
+      # needs the HDF5 library of the system. Remove once h5py publishes them (#37)
+      - if: matrix.python-version == '3.15'
+        run: sudo apt-get update && sudo apt-get install --yes libhdf5-dev pkg-config
+      - if: matrix.deps == 'locked'
+        run: uv sync --locked --no-default-groups --group test
+      - if: matrix.deps == 'latest'
+        run: uv sync --upgrade --no-default-groups --group test
+      # Reminder of #37: warns in the checks once the installed h5py has wheels for
+      # Python 3.15, so that the installation of HDF5 above can be removed
+      - if: matrix.python-version == '3.15'
+        run: |
+          version=$(uv run --no-sync python -c "import importlib.metadata as m; print(m.version('h5py'))")
+          if curl --fail --silent --show-error "https://pypi.org/pypi/h5py/$version/json" | grep --quiet "cp315-"; then
+            echo "::warning::h5py $version has wheels for Python 3.15: remove the installation of HDF5 from the CI (#37)"
+          fi
+      - run: uv run --no-sync pytest --cov --cov-report=term --cov-report=xml
+      - uses: codecov/codecov-action@303a32d7a59b442fa8d48b6a1cc6825c09c847a5 # v7.1.1
+        with:
+          use_oidc: true
+          files: coverage.xml
+          disable_search: true
+          fail_ci_if_error: true
+
+  # Single required status check for the main branch ruleset: it passes only
+  # if every job below succeeded, so the matrix can change without updating
+  # the ruleset. Any new job must be added to `needs`, or its failure will not
+  # block merging.
+  ci-passed:
+    # A job whose dependency failed is skipped, and a skipped required check
+    # counts as passing: always() makes it run and report the real outcome
+    if: always()
+    needs: [lint, typecheck, build, tests]
+    runs-on: ubuntu-latest
+    steps:
+      # A cancelled job proved nothing, so it fails the check too
+      - if: contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')
+        run: exit 1

rivoli-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,129 @@
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions: {}
+
+jobs:
+  ci:
+    # "$/": the self-repository syntax always loads the workflow of this repository
+    # at the same commit, never a file of the workspace (unlike "./")
+    uses: $/.github/workflows/ci.yml
+    permissions:
+      contents: read
+      # The tests job of the CI uploads the coverage with an OIDC token
+      id-token: write
+
+  # A forgotten `scripts/release.py prepare` fails the release here, before
+  # anything is published: the changelog must have a section for the tag, and
+  # CITATION.cff its version and date. Pre-releases (a, b, rc) are not checked.
+  changelog:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      # The script only needs the standard library: the Python of the runner is enough
+      - run: |
+          if [[ "$GITHUB_REF_NAME" =~ (a|b|rc)[0-9]+$ ]]; then exit 0; fi
+          python3 scripts/release.py check "$GITHUB_REF_NAME"
+
+  build:
+    needs: [ci, changelog]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@1c37ad07a6a961277cf70c0d37d6f313000f5884 # v10.3.0
+        with:
+          # A cache restored in a release job could inject altered packages into
+          # the published distributions: build from a clean environment
+          enable-cache: false
+      - run: uv build
+      - run: uvx twine check --strict dist/*
+      - uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
+        with:
+          name: dist
+          path: dist/
+
+  publish-testpypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/project/rivoli/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+
+  publish-pypi:
+    needs: publish-testpypi
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/rivoli/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@7245906fb61fa33a13554f9d5fb856fe61758086 # v1.14.3
+
+  github-release:
+    needs: publish-pypi
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      # The notes of the release come from CHANGELOG.md. Checked out first: the
+      # checkout empties the working directory
+      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          persist-credentials: false
+      - uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
+        with:
+          name: dist
+          path: dist/
+      - uses: sigstore/gh-action-sigstore-python@790bc6befb9d733738f18d8f895854b453640ec9 # v3.5.0
+        with:
+          inputs: >-
+            ./dist/*.tar.gz
+            ./dist/*.whl
+      - env:
+          GH_TOKEN: ${{ github.token }}
+          # Passed through the environment, never interpolated in the script
+          PROJECT_NAME: "RIVOLI"
+        # The changelog section of the version becomes the notes of the release,
+        # and the description of its Zenodo record. Pre-releases have no section:
+        # their notes are generated from the merged pull requests instead
+        run: |
+          if [[ "$GITHUB_REF_NAME" =~ (a|b|rc)[0-9]+$ ]]; then
+            flags=(--prerelease --generate-notes)
+          else
+            python3 scripts/release.py notes "$GITHUB_REF_NAME" > "$RUNNER_TEMP/notes.md"
+            flags=(--notes-file "$RUNNER_TEMP/notes.md")
+          fi
+          gh release create "$GITHUB_REF_NAME" dist/* \
+            --repo "$GITHUB_REPOSITORY" \
+            --title "$PROJECT_NAME ${GITHUB_REF_NAME#v}" \
+            --verify-tag \
+            "${flags[@]}"