pyfastmm 1.0.0__tar.gz

pyfastmm-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,107 @@
+name: Continuous Delivery
+
+# Tag-first release. semantic-release decides the version and creates the
+# tag + GitHub Release; the same commit's wheels then build (via the
+# reusable wheels.yml) and publish to PyPI. Mirrors pyMSTM's publish.yml
+# (github.com/arunoruto/pyMSTM) -- see that project for the fuller
+# rationale behind this design.
+#
+# NOTE: the filename `publish.yml` is load-bearing -- the PyPI trusted
+# publisher for `pyfastmm` is configured against this exact workflow
+# file. The job that calls pypa/gh-action-pypi-publish must stay in here.
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    uses: ./.github/workflows/test.yml
+
+  release:
+    name: Version, tag, and create the GitHub Release
+    runs-on: ubuntu-latest
+    needs: test
+    concurrency:
+      group: ${{ github.workflow }}-release-${{ github.ref_name }}
+      cancel-in-progress: false
+    permissions:
+      contents: write
+    outputs:
+      released: ${{ steps.release.outputs.released }}
+      tag: ${{ steps.release.outputs.tag }}
+    steps:
+      - name: Setup | Checkout Repository on Release Branch
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref_name }}
+          fetch-depth: 0
+          # No submodules: this job only versions/tags/releases, it never
+          # builds the extension. Wheels build in wheels.yml (with
+          # submodules), from the tag this job creates.
+
+      - name: Setup | Force release branch to be at workflow sha
+        run: git reset --hard ${{ github.sha }}
+
+      - name: Action | Semantic Version Release
+        # Computes the next version from Conventional Commits, bumps
+        # pyproject.toml + __init__.py (per [tool.semantic_release]),
+        # commits, tags, pushes, and creates the GitHub Release.
+        id: release
+        uses: python-semantic-release/python-semantic-release@v10.6.1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          git_committer_name: "github-actions"
+          git_committer_email: "actions@users.noreply.github.com"
+
+  wheels:
+    # Build the wheels + sdist for the tag release just created. Reuses
+    # the exact same build that's available on demand via wheels.yml.
+    needs: release
+    if: needs.release.outputs.released == 'true'
+    # GitHub validates a called reusable workflow's permission needs
+    # *statically*, across all its jobs, regardless of which actually run
+    # at runtime -- wheels.yml's check_comment job (skipped here, this is
+    # a workflow_call, not issue_comment) still declares issues:write/
+    # pull-requests:read, which this workflow's top-level permissions:
+    # contents: read alone doesn't cover. Without this override the whole
+    # run fails at dispatch time with "startup_failure", before any job
+    # even starts -- confirmed via a real failed dispatch.
+    permissions:
+      contents: read
+      issues: write
+      pull-requests: read
+    uses: ./.github/workflows/wheels.yml
+    with:
+      ref: ${{ needs.release.outputs.tag }}
+
+  publish:
+    name: Publish to PyPI and attach artifacts to the GitHub Release
+    runs-on: ubuntu-latest
+    needs:
+      - release
+      - wheels
+    if: needs.release.outputs.released == 'true'
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pyfastmm
+    permissions:
+      id-token: write # PyPI trusted publishing (OIDC)
+      contents: write # attach assets to the GitHub Release
+    steps:
+      - name: Download | All build artifacts (wheels + sdist)
+        uses: actions/download-artifact@v4
+        with:
+          pattern: cibw-*
+          path: dist
+          merge-multiple: true
+
+      - name: Publish | PyPI (trusted publishing, no token)
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: Publish | Attach wheels + sdist to the GitHub Release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: gh release upload ${{ needs.release.outputs.tag }} dist/* --repo ${{ github.repository }} --clobber

pyfastmm-1.0.0/.github/workflows/test.yml

@@ -0,0 +1,55 @@
+name: Testing
+on:
+  workflow_call:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches: [main]
+jobs:
+  unittest:
+    name: PyTest
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Install build dependencies
+        # gfortran/lapack/blas: needed for `uv sync` to build the f2py
+        # extension (meson-python drives numpy.f2py -c against
+        # external/fastmm2/, see meson.build). cmake/libhdf5-dev: only
+        # for the standalone CLI reference binary (make cli), which
+        # keeps building the *unmodified* upstream sources including
+        # io.f90/HDF5, unlike the Python extension itself.
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y gfortran liblapack-dev libblas-dev cmake libhdf5-dev
+      - name: Install uv
+        id: setup-python
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+      - name: Install dependencies (builds the f2py extension)
+        run: uv sync --extra dev
+      - name: Cache | FaSTMM2 CLI reference binary
+        id: cache-cli
+        uses: actions/cache@v4
+        with:
+          path: build/cli/FaSTMM2
+          # external/fastmm2 is a git submodule pinned to a fixed commit
+          # in .gitmodules -- it essentially never changes between runs,
+          # so hashing its checked-out content (plus the Makefile that
+          # drives the CMake build) is a reliable "did the CLI's own
+          # inputs change" key, letting most runs skip rebuilding it
+          # entirely (mirrors pyMSTM's identical CLI-caching setup).
+          key: ${{ runner.os }}-fastmm2-cli-${{ hashFiles('external/fastmm2/src/**', 'Makefile') }}
+      - name: Build the standalone FaSTMM2 CLI reference binary
+        # test_compatibility.py skips itself if this isn't present -- but
+        # we want that cross-check to actually run in CI, not silently
+        # skip. Skipped entirely on a cache hit above -- `make`'s own
+        # mtime-based staleness check isn't reliable here since a fresh
+        # checkout + cache restore don't produce trustworthy relative
+        # timestamps between sources and the cached binary.
+        if: steps.cache-cli.outputs.cache-hit != 'true'
+        run: make cli
+      - name: Test with pytest
+        run: uv run pytest tests/ -v

pyfastmm-1.0.0/.github/workflows/wheels.yml

@@ -0,0 +1,171 @@
+name: Wheels
+
+# Single source of truth for *how* pyfastmm's wheels + sdist are built.
+# Mirrors pyMSTM's wheels.yml (github.com/arunoruto/pyMSTM) -- see that
+# project for the fuller rationale behind this design.
+#
+# Deliberately not triggered automatically at all (no PR push, no push to
+# main) -- cibuildwheel across cp311-cp314 is slow enough, and this
+# project small/quiet enough, that it isn't worth building on every
+# commit or every merge. Runs on demand instead:
+#   - workflow_dispatch: Actions tab, or `gh workflow run wheels.yml --ref
+#     <branch>` -- run manually whenever you actually want to validate a
+#     build (e.g. right before merging a PR you're unsure about).
+#   - Commenting `/build-wheels` on a PR.
+#   - Called by publish.yml (workflow_call) with the freshly-created tag
+#     at actual release time.
+#
+# Tradeoff worth knowing: publish.yml's `release` job tags before this
+# workflow ever builds anything (tag-first), so if a release's build
+# fails here, the tag/GitHub Release already exist -- a phantom release
+# with no wheels, needing manual cleanup (`gh release delete <tag>
+# --cleanup-tag`). There's no automatic pre-release validation to catch
+# this ahead of time; the mitigation is manual -- run workflow_dispatch
+# or `/build-wheels` on a PR you're unsure about before merging/releasing.
+#
+# All cibuildwheel configuration lives in pyproject.toml's
+# [tool.cibuildwheel] -- deliberately not here as CIBW_* env vars, so this
+# stays a bare `uses:` and the exact same build is reproducible locally
+# with the `cibuildwheel` CLI.
+
+on:
+  workflow_call:
+    inputs:
+      ref:
+        description: "Git ref (tag) to build. Empty builds the triggering commit."
+        type: string
+        required: false
+        default: ""
+  workflow_dispatch:
+    inputs:
+      ref:
+        description: "Ref to build (defaults to whatever branch this is run against)."
+        type: string
+        required: false
+        default: ""
+  issue_comment:
+    types: [created]
+
+permissions:
+  contents: read
+
+jobs:
+  # Only relevant for the issue_comment trigger: gates /build-wheels on
+  # the commenter actually having write access (issue_comment fires for
+  # *any* comment from *anyone* on a public repo -- without this, anyone
+  # could burn CI minutes triggering the wheel matrix on an arbitrary PR),
+  # and resolves the PR's head SHA (issue_comment's payload doesn't
+  # include PR ref info directly, only the issue/PR number).
+  check_comment:
+    if: >
+      github.event_name == 'issue_comment' &&
+      github.event.issue.pull_request != null &&
+      contains(github.event.comment.body, '/build-wheels')
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read # to resolve the PR's head SHA
+      issues: write # to react to the triggering comment (PR comments are "issues" API-wise)
+    outputs:
+      authorized: ${{ steps.check.outputs.authorized }}
+      sha: ${{ steps.pr.outputs.sha }}
+    steps:
+      - name: Check commenter has write access
+        id: check
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const { data } = await github.rest.repos.getCollaboratorPermissionLevel({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              username: context.payload.comment.user.login,
+            });
+            const authorized = ["admin", "write"].includes(data.permission);
+            core.setOutput("authorized", authorized);
+            await github.rest.reactions.createForIssueComment({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              comment_id: context.payload.comment.id,
+              content: authorized ? "rocket" : "-1",
+            });
+            if (!authorized) {
+              core.setFailed(`@${context.payload.comment.user.login} does not have write access -- not triggering the wheel build.`);
+            }
+
+      - name: Resolve PR head SHA
+        id: pr
+        if: steps.check.outputs.authorized == 'true'
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const { data } = await github.rest.pulls.get({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: context.issue.number,
+            });
+            core.setOutput("sha", data.head.sha);
+
+  build_wheels:
+    name: Wheels on ${{ matrix.os }}
+    needs: [check_comment]
+    # always(): check_comment is skipped entirely for every trigger except
+    # issue_comment, and a skipped need must not block this job -- but a
+    # *failed* (unauthorized) check_comment must.
+    if: >
+      always() &&
+      needs.check_comment.result != 'failure' &&
+      (github.event_name != 'issue_comment' || needs.check_comment.outputs.authorized == 'true')
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        # A matrix of one for now -- kept a matrix so macOS/Windows are a
+        # one-line add later (their cibuildwheel settings are already
+        # staged in pyproject.toml's [tool.cibuildwheel.macos]).
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # check_comment's resolved SHA on a /build-wheels comment;
+          # inputs.ref on workflow_call/workflow_dispatch (empty checks
+          # out whatever ref the dispatch/call itself targeted).
+          ref: ${{ needs.check_comment.outputs.sha || inputs.ref }}
+          submodules: recursive
+
+      - uses: pypa/cibuildwheel@v4.1.0
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: cibw-wheels-${{ matrix.os }}
+          path: ./wheelhouse/*.whl
+
+  build_sdist:
+    name: sdist
+    needs: [check_comment]
+    if: >
+      always() &&
+      needs.check_comment.result != 'failure' &&
+      (github.event_name != 'issue_comment' || needs.check_comment.outputs.authorized == 'true')
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ needs.check_comment.outputs.sha || inputs.ref }}
+          submodules: recursive
+
+      - name: Install gfortran
+        # meson-python's sdist build runs `meson setup`, which requires a
+        # Fortran compiler to be found -- even though producing the sdist
+        # (a source tarball) compiles nothing itself. LAPACK/BLAS aren't
+        # needed here: meson.build never declares them as meson
+        # dependencies, only tools/build_f2py_ext.py links them directly
+        # at actual compile time.
+        run: sudo apt-get update && sudo apt-get install -y gfortran
+
+      - name: Build sdist
+        run: pipx run build --sdist
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: cibw-sdist
+          path: ./dist/*.tar.gz

pyfastmm-1.0.0/.gitignore

@@ -0,0 +1,303 @@
+build/
+
+## Devenv
+.devenv*
+devenv.local.nix
+devenv.local.yaml
+
+# direnv
+.direnv
+
+# pre-commit
+.pre-commit-config.yaml
+
+## Python
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+## C++
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Linker files
+*.ilk
+
+# Debugger Files
+*.pdb
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+*.so.*
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+
+# Build directories
+build/
+Build/
+build-*/
+
+# CMake generated files
+CMakeFiles/
+CMakeCache.txt
+cmake_install.cmake
+install_manifest.txt
+compile_commands.json
+
+# Temporary files
+*.tmp
+*.log
+*.bak
+*.swp
+
+# vcpkg
+vcpkg_installed/
+
+# debug information files
+*.dwo
+
+# test output & cache
+Testing/
+.cache/

pyfastmm-1.0.0/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "external/fastmm2"]
+	path = external/fastmm2
+	url = https://bitbucket.org/planetarysystemresearch/fastmm2/

pyfastmm-1.0.0/.python-version

@@ -0,0 +1 @@
+3.14

pyfastmm-1.0.0/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG
+
+<!-- version list -->
+
+## v1.0.0 (2026-07-14)
+
+- Initial Release