s2conv 0.1.0__tar.gz

s2conv-0.1.0/.all-contributorsrc

@@ -0,0 +1,31 @@
+{
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "commitConvention": "angular",
+  "contributors": [
+    {
+      "login": "jasonmcewen",
+      "name": "Jason McEwen",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3181701?v=4",
+      "profile": "http://www.jasonmcewen.org",
+      "contributions": [
+        "code",
+        "ideas",
+        "research",
+        "doc",
+        "maintenance",
+        "review"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "skipCi": true,
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "projectName": "s2conv",
+  "projectOwner": "astro-informatics",
+  "commitType": "docs"
+}

s2conv-0.1.0/.coveragerc

@@ -0,0 +1,7 @@
+[report]
+omit =
+    *test_*
+    *_version.py
+exclude_also =
+    if TYPE_CHECKING:
+    raise NotImplementedError

s2conv-0.1.0/.github/workflows/build.yml

@@ -0,0 +1,71 @@
+name: Build (and upload to PyPI for published releases)
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
+  release:
+    types:
+      - published
+
+jobs:
+  build:
+    name: Build source distribution and wheel
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6.0.3
+        with:
+          # setuptools-scm needs the full history and the tags to determine the version
+          fetch-depth: 0
+          fetch-tags: true
+
+      # s2conv is pure Python, so a single wheel serves every platform
+      - name: Build sdist and wheel
+        run: pipx run build
+
+      - name: Check distributions
+        run: pipx run twine check --strict dist/*
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+
+  upload_test_pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: test-pypi
+    permissions:
+      id-token: write
+    # Try publishing to Test PyPI first: a problem then stops the release before PyPI.
+    # Development versions from pushes to main are uploaded only while the repository
+    # is public, since an upload publishes the source.
+    if: |
+      (github.event_name == 'release' && github.event.action == 'published') ||
+      (github.event_name == 'push' && github.ref == 'refs/heads/main' && !github.event.repository.private)
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist
+      - name: Publish package distributions to Test PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  upload_pypi:
+    needs: [build, upload_test_pypi]
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    if: github.event_name == 'release' && github.event.action == 'published'
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

s2conv-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,72 @@
+name: Docs
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - .github/workflows/docs.yml
+      - pyproject.toml
+      - s2conv/**
+      - docs/**
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v6.0.3
+        with:
+          # setuptools-scm needs the full history and the tags to determine the version
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+          cache: pip
+          cache-dependency-path: pyproject.toml
+
+      # The package is installed so that autodoc can import it
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install ".[docs]"
+
+      # Warnings are errors, so that pages whose API reference failed to import are
+      # never deployed
+      - name: Build documentation
+        run: |
+          cd docs
+          make html SPHINXOPTS="-W --keep-going"
+
+      - name: Upload built docs as artifact
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: docs/_build/html
+          retention-days: 30
+
+  deploy:
+    # Publish to GitHub Pages on pushes to main only.  This requires GitHub Pages
+    # to be enabled with "GitHub Actions" as the source in the repository settings.
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

s2conv-0.1.0/.github/workflows/linting.yml

@@ -0,0 +1,33 @@
+name: Linting
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  linting:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v6.0.3
+
+      - name: Cache pre-commit
+        uses: actions/cache@v5
+        with:
+          path: ~/.cache/pre-commit
+          key: pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+          cache: pip
+          cache-dependency-path: pyproject.toml
+
+      - name: Install dependencies
+        run: python -m pip install pre-commit
+
+      - name: Run pre-commit
+        run: pre-commit run --all-files --color always --verbose

s2conv-0.1.0/.github/workflows/tests.yml

@@ -0,0 +1,80 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    paths:
+      - .github/workflows/tests.yml
+      - pyproject.toml
+      - s2conv/**
+      - tests/**
+      - .coveragerc
+  schedule:
+    - cron: 0 0 * * 0
+  # Run on demand from the Actions tab, including the slow tests
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
+
+jobs:
+  tests:
+    runs-on: ${{ matrix.os }}
+    # id-token lets the Codecov step authenticate by OpenID Connect, without a token
+    permissions:
+      contents: read
+      id-token: write
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+        os: [ubuntu-latest, macos-latest]
+        s2fft: [latest]
+        # The oldest supported s2fft too, which pip would otherwise never install
+        # (on Python 3.13 it fails to import, so s2conv requires s2fft>=1.5.0 there)
+        include:
+          - python-version: "3.11"
+            os: ubuntu-latest
+            s2fft: "1.4.0"
+      fail-fast: false
+
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v6.0.3
+        with:
+          # setuptools-scm needs the full history and the tags to determine the version
+          fetch-depth: 0
+          fetch-tags: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+          cache-dependency-path: pyproject.toml
+
+      - name: Install dependencies
+        # The ssht extra (pyssht and ducc0) provides the "jax_ssht" backend, and
+        # pyssht has wheels for all of the platforms and Python versions above
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install ".[tests,ssht]"
+          if [ "${{ matrix.s2fft }}" != latest ]; then python -m pip install "s2fft==${{ matrix.s2fft }}"; fi
+
+      # Run as a module so that the working tree, rather than the installed copy of
+      # the package, is imported, and hence measured for coverage
+      - name: Run tests (skipping slow tests on pull requests)
+        if: github.event_name == 'pull_request'
+        run: python -m pytest --cov=s2conv --cov-report=xml --cov-config=.coveragerc -m "not slow"
+
+      - name: Run tests
+        if: github.event_name != 'pull_request'
+        run: python -m pytest --cov=s2conv --cov-report=xml --cov-config=.coveragerc
+
+      - name: Upload coverage reports to Codecov
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v6
+        with:
+          use_oidc: true

s2conv-0.1.0/.gitignore

@@ -0,0 +1,50 @@
+# Byte-compiled files and caches
+__pycache__/
+*.py[cod]
+*$py.class
+*.cache/
+
+# Packaging and build output
+build/
+dist/
+wheelhouse/
+*.egg-info/
+*.egg
+.eggs/
+
+# Version file written by setuptools_scm at build time
+s2conv/_version.py
+
+# Tests and coverage
+.pytest_cache/
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+.tox/
+
+# Linters and type checkers
+.ruff_cache/
+.mypy_cache/
+
+# Virtual environments
+.venv/
+venv/
+
+# Notebooks (Jupyter and Marimo)
+.ipynb_checkpoints/
+__marimo__/
+
+# Documentation build
+docs/_build/
+docs/api/generated/
+
+# Editors and operating system files
+.vscode/
+.idea/
+*.swp
+*~
+.DS_Store
+
+# Logs
+*.log

s2conv-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.9
+    hooks:
+      - id: ruff
+      - id: ruff-format

s2conv-0.1.0/CITATION.cff

@@ -0,0 +1,41 @@
+cff-version: 1.2.0
+title: >-
+  s2conv: differentiable and accelerated spherical convolutions
+message: >-
+  If you use this software, please cite it using the metadata from this file.
+type: software
+authors:
+  - given-names: Jason D.
+    family-names: McEwen
+    orcid: 'https://orcid.org/0000-0002-5852-8890'
+repository-code: 'https://github.com/astro-informatics/s2conv'
+license: MIT
+references:
+  - type: unpublished
+    authors:
+      - given-names: Jason D.
+        family-names: McEwen
+        orcid: 'https://orcid.org/0000-0002-5852-8890'
+    title: Unifying spherical convolutions through lifting
+    year: 2026
+    status: in-press
+    notes: >-
+      Forthcoming article describing the generalised lifted spherical
+      convolution implemented in s2conv.
+  - type: article
+    authors:
+      - given-names: Matthew A.
+        family-names: Price
+      - given-names: Jason
+        family-names: McEwen
+        orcid: 'https://orcid.org/0000-0002-5852-8890'
+    title: Differentiable and accelerated spherical harmonic and Wigner transforms
+    journal: Journal of Computational Physics
+    volume: 510
+    issue: 1
+    start: 113109
+    month: 8
+    year: 2024
+    doi: 10.1016/j.jcp.2024.113109
+    notes: >-
+      s2fft, the software on which the harmonic transforms of s2conv are built.

s2conv-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,109 @@
+# Contributing
+
+Thank you for your interest in contributing to s2conv!
+We welcome contributions of all forms, including bug reports, feature requests, documentation, tests and code.
+
+## Reporting bugs or requesting new features
+
+If you have a question, please first check the [documentation](https://astro-informatics.github.io/s2conv) and the [existing issues](https://github.com/astro-informatics/s2conv/issues).
+If neither answers it, please [raise an issue](https://github.com/astro-informatics/s2conv/issues/new).
+
+When reporting a bug, describe the behaviour you expected, what you observe instead, and provide enough information for someone else to reproduce the problem.
+Ideally this is a [_minimal reproducible example_](https://en.wikipedia.org/wiki/Minimal_reproducible_example): a short script that reproduces the error and is as small and simple as possible.
+Please include the versions of s2conv, s2fft, JAX and Python you are using.
+
+## Setting up a development environment
+
+Clone the repository and install the package in editable mode with the test and documentation dependencies:
+
+```bash
+git clone https://github.com/astro-informatics/s2conv.git
+cd s2conv
+pip install -e ".[tests,docs]"
+```
+
+The package version is determined from the git history by [setuptools-scm](https://setuptools-scm.readthedocs.io), so install from a clone of the repository rather than from an archive of the source files.
+
+Two further sets of optional dependencies are available:
+
+- `ssht` (pyssht and ducc0), required by the `"jax_ssht"` backend and by the tests marked `ssht`;
+- `notebooks` (marimo and matplotlib), required to run the notebook in `notebooks/`.
+
+## Running the tests
+
+Run the test suite from the root of the repository with
+
+```bash
+pytest
+```
+
+Some tests are slow or need optional dependencies, and are marked accordingly.
+You can deselect them with, for example,
+
+```bash
+pytest -m "not slow and not ssht"
+```
+
+New functionality should come with tests, and bug fixes with a test that fails without the fix.
+
+## Code style and linting
+
+The Python code in s2conv follows the [Black code style](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html), and we use [Ruff](https://docs.astral.sh/ruff/) to lint and autoformat it.
+The Ruff configuration is in `pyproject.toml`.
+The Marimo notebooks in `notebooks/` have their own format and are excluded from Ruff.
+
+We use [pre-commit](https://pre-commit.com/) hooks to check that changes respect the formatting and linting rules.
+You can install the hooks in your local repository by [installing pre-commit](https://pre-commit.com/#install) and running
+
+```bash
+pre-commit install
+```
+
+from the root of the repository.
+The hooks then run on any staged changes when you commit.
+If there are problems with the changes, these are reported in the terminal, and where possible they are fixed automatically, in which case the updated files need to be staged and committed again.
+You can also check every file in the repository with `pre-commit run --all-files`.
+
+## Building the documentation
+
+The documentation is built with [Sphinx](https://www.sphinx-doc.org).
+From the root of the repository, run
+
+```bash
+cd docs
+make html
+```
+
+and open `docs/_build/html/index.html` in a browser.
+
+## Proposing changes to the repository
+
+We use a branch and pull request model.
+Before opening a pull request that proposes substantial changes, for example a new feature or a change to the public interface, please first [raise an issue](https://github.com/astro-informatics/s2conv/issues/new) outlining the problem the changes would address, so that the problem and the proposed solution can be discussed before significant time is invested.
+
+If you have not made an open-source contribution via a pull request before, you may find this [detailed guide](https://www.asmeurer.com/git-workflow/) by [asmeurer](https://github.com/asmeurer) helpful.
+The main steps are as follows:
+
+1. Create a branch with a descriptive name.
+   Contributors without write access to the repository should first [fork the repository](https://github.com/astro-informatics/s2conv/fork) and create the branch in a local clone of their fork.
+2. Make the proposed changes on the branch, giving each commit a descriptive commit message.
+3. Push the branch to GitHub.
+4. Create a [pull request](https://github.com/astro-informatics/s2conv/compare) against `main`, giving it a descriptive title and explaining what you are changing and why.
+   If the pull request resolves a specific issue, use [keywords](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests) to link the issue.
+5. Make sure that all the automated checks (tests, linting and documentation build) pass on the pull request.
+6. Await a review by one of the maintainers and address any comments.
+7. Once the checks pass and a maintainer has approved the changes, the pull request can be (squash) merged.
+
+## Recognising contributions
+
+We recognise every kind of contribution, not just code, following the [all-contributors](https://allcontributors.org) specification: the contributors are listed in the [Contributors section of the README](https://github.com/astro-informatics/s2conv#contributors-), with an emoji for each [type of contribution](https://allcontributors.org/docs/en/emoji-key), for example code, documentation, tests, bug reports, ideas, research or review.
+
+To add someone, a maintainer comments on an issue or pull request with
+
+```text
+@all-contributors please add @<username> for <contributions>
+```
+
+for example `@all-contributors please add @jasonmcewen for code, doc`.
+The [all-contributors bot](https://allcontributors.org/docs/en/bot/overview) then opens a pull request that updates `.all-contributorsrc` and the table in `README.md`.
+If you think you or someone else should be listed, please say so in an issue or pull request.

s2conv-0.1.0/LICENCE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Authors & Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

s2conv-0.1.0/MANIFEST.in

@@ -0,0 +1,4 @@
+# The sdist takes every file tracked by git (setuptools-scm); leave out the
+# figures exported from the notebooks, which are rebuilt by
+# notebooks/export_real_fields_figures.py
+prune notebooks/figures