op-engine 0.1.0__tar.gz

op_engine-0.1.0/.github/workflows/ci.yaml

@@ -0,0 +1,95 @@
+---
+name: 'CI'
+
+'on':
+  pull_request:
+    branches:
+      - 'main'
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: 'read'
+
+jobs:
+  build-check:
+    name: 'Build Check (${{ matrix.python-version }})'
+    runs-on: 'ubuntu-latest'
+    strategy:
+      matrix:
+        python-version:
+          - '3.12'
+    steps:
+      - name: 'Install just'
+        uses: 'extractions/setup-just@v3'
+      - name: 'Checkout repository'
+        uses: 'actions/checkout@v6'
+        with:
+          persist-credentials: false
+      - name: 'Setup uv with python ${{ matrix.python-version }}'
+        uses: 'astral-sh/setup-uv@v7.2.0'
+        with:
+          enable-cache: true
+          cache-dependency-glob: 'pyproject.toml'
+          python-version: '${{ matrix.python-version }}'
+      - name: 'Run Build Check'
+        run: 'just build-check'
+        env:
+          UV_PYTHON_VERSION: '${{ matrix.python-version }}'
+  ci:
+    name: 'CI (${{ matrix.python-version }})'
+    needs:
+      - 'docs'
+      - 'build-check'
+    runs-on: 'ubuntu-latest'
+    strategy:
+      matrix:
+        python-version:
+          - '3.11'
+          - '3.12'
+          - '3.13'
+          - '3.14'
+    steps:
+      - name: 'Install just'
+        uses: 'extractions/setup-just@v3'
+      - name: 'Checkout repository'
+        uses: 'actions/checkout@v6'
+        with:
+          persist-credentials: false
+      - name: 'Setup uv with python ${{ matrix.python-version }}'
+        uses: 'astral-sh/setup-uv@v7.2.0'
+        with:
+          enable-cache: true
+          cache-dependency-glob: 'pyproject.toml'
+          python-version: '${{ matrix.python-version }}'
+      - name: 'Run Checks'
+        run: 'just ci'
+        env:
+          UV_PYTHON_VERSION: '${{ matrix.python-version }}'
+  docs:
+    name: 'Docs (${{ matrix.python-version }})'
+    runs-on: 'ubuntu-latest'
+    strategy:
+      matrix:
+        python-version:
+          - '3.12'
+    steps:
+      - name: 'Install just'
+        uses: 'extractions/setup-just@v3'
+      - name: 'Checkout repository'
+        uses: 'actions/checkout@v6'
+        with:
+          persist-credentials: false
+      - name: 'Setup uv'
+        uses: 'astral-sh/setup-uv@v7.2.0'
+        with:
+          enable-cache: true
+          cache-dependency-glob: 'pyproject.toml'
+          python-version: '${{ matrix.python-version }}'
+      - name: 'Build Documentation'
+        run: 'just docs'
+        env:
+          UV_PYTHON_VERSION: '${{ matrix.python-version }}'

op_engine-0.1.0/.github/workflows/gh-pages.yaml

@@ -0,0 +1,108 @@
+---
+name: 'GitHub Pages Documentation'
+
+'on':
+  push:
+    branches:
+      - 'main'
+  workflow_call:
+    inputs:
+      deploy-mode:
+        description: 'Deployment mode used to determine docs aliases'
+        required: false
+        default: 'push'
+        type: 'string'
+  workflow_dispatch:
+    inputs:
+      deploy-mode:
+        description: 'Deployment mode used to determine docs aliases'
+        required: false
+        default: 'push'
+        type: 'choice'
+        options:
+          - 'push'
+          - 'release'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: 'read'
+
+jobs:
+  deploy:
+    name: 'Deploy Documentation to GitHub Pages'
+    runs-on: 'ubuntu-latest'
+    strategy:
+      matrix:
+        python-version:
+          - '3.12'
+    permissions:
+      contents: 'write'  # Needed to push to gh-pages
+    steps:
+      - name: 'Install just'
+        uses: 'extractions/setup-just@v3'
+      - name: 'Checkout repository'
+        uses: 'actions/checkout@v6'
+        with:
+          ref: 'main'
+          persist-credentials: true
+      - name: 'Fetch gh-pages branch'
+        run: |
+          git fetch origin gh-pages:gh-pages --depth=1
+          git config --global user.name "${ACTOR}"
+          git config --global user.email "${ACTOR}@users.noreply.github.com"
+        env:
+          ACTOR: "${{ github.actor }}"
+      - name: 'Setup uv with python ${{ matrix.python-version }}'
+        uses: 'astral-sh/setup-uv@v7.2.0'
+        with:
+          enable-cache: true
+          cache-dependency-glob: 'pyproject.toml'
+          python-version: '${{ matrix.python-version }}'
+      - name: 'Extract op_engine version'
+        id: extract-version
+        run: |
+          cat > version.py << EOF
+          import tomllib
+          with open('pyproject.toml', 'rb') as f:
+              data = tomllib.load(f)
+          version = data['project']['version']
+          version = '.'.join(version.split('.')[:2])
+          print(f"version={version}")
+          EOF
+          uv run -qq python version.py >> $GITHUB_OUTPUT
+          rm version.py
+      - name: 'Build API Reference'
+        run: 'just api-reference'
+      - name: 'Determine deploy mode'
+        id: determine-mode
+        run: |
+          if [ "${EVENT_NAME}" = "workflow_call" ]; then
+            echo "deploy-mode=${CALL_MODE}" >> "${GITHUB_OUTPUT}"
+          elif [ "${EVENT_NAME}" = "workflow_dispatch" ] \
+            && [ -n "${DISPATCH_MODE}" ]; then
+            echo "deploy-mode=${DISPATCH_MODE}" >> "${GITHUB_OUTPUT}"
+          else
+            echo "deploy-mode=push" >> "${GITHUB_OUTPUT}"
+          fi
+        env:
+          CALL_MODE: '${{ inputs.deploy-mode }}'
+          DISPATCH_MODE: '${{ github.event.inputs.deploy-mode }}'
+          EVENT_NAME: '${{ github.event_name }}'
+      - name: 'Deploy to GitHub Pages'
+        run: |
+          uv run mike set-default latest
+          if [ "${DEPLOY_MODE}" = "release" ] || [[ $VERSION == 0* ]]; then
+            ALIAS=latest
+          else
+            ALIAS=dev
+          fi
+          uv run mike deploy \
+            --push --update-aliases \
+            ${VERSION} ${ALIAS}
+        env:
+          DEPLOY_MODE: "${{ steps.determine-mode.outputs.deploy-mode }}"
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          VERSION: "${{ steps.extract-version.outputs.version }}"

op_engine-0.1.0/.github/workflows/release.yaml

@@ -0,0 +1,194 @@
+---
+name: 'Release'
+
+'on':
+  workflow_dispatch:
+    inputs:
+      publish-target:
+        description: 'Package publish target'
+        required: true
+        default: 'none'
+        type: 'choice'
+        options:
+          - 'none'
+          - 'testpypi'
+          - 'pypi'
+      create-github-release:
+        description: 'Create the GitHub release after publishing'
+        required: true
+        default: false
+        type: 'boolean'
+      deploy-docs:
+        description: 'Deploy versioned docs after creating the GitHub release'
+        required: true
+        default: false
+        type: 'boolean'
+
+permissions:
+  contents: 'read'
+
+jobs:
+  validate:
+    name: 'Validate release'
+    runs-on: 'ubuntu-latest'
+    outputs:
+      version: '${{ steps.validate-version.outputs.version }}'
+      docs-version: '${{ steps.validate-version.outputs.docs-version }}'
+      prerelease: '${{ steps.validate-version.outputs.prerelease }}'
+    steps:
+      - name: 'Install just'
+        uses: 'extractions/setup-just@v3'
+      - name: 'Checkout repository'
+        uses: 'actions/checkout@v6'
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - name: 'Setup uv with python 3.12'
+        uses: 'astral-sh/setup-uv@v7.2.0'
+        with:
+          enable-cache: true
+          cache-dependency-glob: |
+            pyproject.toml
+            flepimop2-op_engine/pyproject.toml
+          python-version: '3.12'
+      - name: 'Validate shared package version'
+        id: validate-version
+        run: 'uv run python scripts/release_validate.py --github-output "${GITHUB_OUTPUT}"'
+      - name: 'Run release build validation'
+        run: 'just build-all'
+        env:
+          UV_PYTHON_VERSION: '3.12'
+      - name: 'Build core release artifacts'
+        run: |
+          rm -rf release-dist
+          mkdir -p release-dist/op_engine
+          uv run --with build --with twine python -m build --outdir release-dist/op_engine
+          uv run --with twine python -m twine check --strict release-dist/op_engine/*
+      - name: 'Build provider release artifacts'
+        run: |
+          mkdir -p release-dist/flepimop2-op_engine
+          cd flepimop2-op_engine
+          uv run --with build --with twine python -m build --outdir ../release-dist/flepimop2-op_engine
+          uv run --with twine python -m twine check --strict ../release-dist/flepimop2-op_engine/*
+      - name: 'Upload core package artifacts'
+        uses: 'actions/upload-artifact@v7'
+        with:
+          name: 'op-engine-dist'
+          path: 'release-dist/op_engine/*'
+          if-no-files-found: 'error'
+      - name: 'Upload provider package artifacts'
+        uses: 'actions/upload-artifact@v7'
+        with:
+          name: 'flepimop2-op-engine-dist'
+          path: 'release-dist/flepimop2-op_engine/*'
+          if-no-files-found: 'error'
+
+  publish-core:
+    name: 'Publish op_engine'
+    needs:
+      - 'validate'
+    runs-on: 'ubuntu-latest'
+    permissions:
+      id-token: 'write'
+    steps:
+      - name: 'Skip core publish'
+        if: "${{ github.event.inputs.publish-target == 'none' }}"
+        run: 'echo "publish-target=none; skipping op_engine publish."'
+      - name: 'Download core package artifacts'
+        if: "${{ github.event.inputs.publish-target != 'none' }}"
+        uses: 'actions/download-artifact@v8'
+        with:
+          name: 'op-engine-dist'
+          path: 'dist'
+      - name: 'Publish core package to TestPyPI'
+        if: "${{ github.event.inputs.publish-target == 'testpypi' }}"
+        uses: 'pypa/gh-action-pypi-publish@release/v1'
+        with:
+          packages-dir: 'dist'
+          repository-url: 'https://test.pypi.org/legacy/'
+      - name: 'Publish core package to PyPI'
+        if: "${{ github.event.inputs.publish-target == 'pypi' }}"
+        uses: 'pypa/gh-action-pypi-publish@release/v1'
+        with:
+          packages-dir: 'dist'
+
+  publish-provider:
+    name: 'Publish flepimop2-op_engine'
+    needs:
+      - 'validate'
+      - 'publish-core'
+    runs-on: 'ubuntu-latest'
+    permissions:
+      id-token: 'write'
+    steps:
+      - name: 'Skip provider publish'
+        if: "${{ github.event.inputs.publish-target == 'none' }}"
+        run: 'echo "publish-target=none; skipping flepimop2-op_engine publish."'
+      - name: 'Download provider package artifacts'
+        if: "${{ github.event.inputs.publish-target != 'none' }}"
+        uses: 'actions/download-artifact@v8'
+        with:
+          name: 'flepimop2-op-engine-dist'
+          path: 'dist'
+      - name: 'Publish provider package to TestPyPI'
+        if: "${{ github.event.inputs.publish-target == 'testpypi' }}"
+        uses: 'pypa/gh-action-pypi-publish@release/v1'
+        with:
+          packages-dir: 'dist'
+          repository-url: 'https://test.pypi.org/legacy/'
+      - name: 'Publish provider package to PyPI'
+        if: "${{ github.event.inputs.publish-target == 'pypi' }}"
+        uses: 'pypa/gh-action-pypi-publish@release/v1'
+        with:
+          packages-dir: 'dist'
+
+  create-github-release:
+    name: 'Create GitHub release'
+    needs:
+      - 'validate'
+      - 'publish-provider'
+    if: >-
+      ${{
+        github.event.inputs.create-github-release == 'true' &&
+        (github.event.inputs.publish-target == 'none' ||
+        needs.publish-provider.result == 'success')
+      }}
+    runs-on: 'ubuntu-latest'
+    permissions:
+      contents: 'write'
+    steps:
+      - name: 'Create release'
+        run: |
+          ARGS=(
+            release create "v${VERSION}"
+            --repo "${GITHUB_REPOSITORY}"
+            --target "${GITHUB_SHA}"
+            --title "v${VERSION}"
+            --generate-notes
+          )
+          if [ "${PRERELEASE}" = 'true' ]; then
+            ARGS+=(--prerelease)
+          fi
+          gh "${ARGS[@]}"
+        env:
+          GH_TOKEN: '${{ secrets.GITHUB_TOKEN }}'
+          GITHUB_REPOSITORY: '${{ github.repository }}'
+          GITHUB_SHA: '${{ github.sha }}'
+          PRERELEASE: '${{ needs.validate.outputs.prerelease }}'
+          VERSION: '${{ needs.validate.outputs.version }}'
+
+  deploy-docs:
+    name: 'Deploy release docs'
+    needs:
+      - 'create-github-release'
+    if: >-
+      ${{
+        github.event.inputs.deploy-docs == 'true' &&
+        needs.create-github-release.result == 'success'
+      }}
+    permissions:
+      contents: 'write'
+    uses: './.github/workflows/gh-pages.yaml'
+    with:
+      deploy-mode: 'release'
+    secrets: 'inherit'

op_engine-0.1.0/.gitignore

@@ -0,0 +1,187 @@
+# ================================
+# Python bytecode / cache
+# ================================
+__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
+# ================================
+*.manifest
+*.spec
+
+# ================================
+# Logs / coverage / testing
+# ================================
+pip-log.txt
+pip-delete-this-directory.txt
+
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# ================================
+# Localization
+# ================================
+*.mo
+*.pot
+
+# ================================
+# Framework-specific
+# ================================
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+instance/
+.webassets-cache
+.scrapy
+
+docs/_build/
+
+.pybuilder/
+target/
+
+# ================================
+# Jupyter / IPython
+# ================================
+.ipynb_checkpoints
+profile_default/
+ipython_config.py
+
+# ================================
+# Python env managers
+# ================================
+.python-version
+
+# ================================
+# Dependency managers
+# ================================
+uv.lock
+
+.pdm-python
+.pdm-build/
+
+.pixi
+
+__pypackages__/
+
+# ================================
+# Runtime artifacts
+# ================================
+celerybeat-schedule
+celerybeat.pid
+
+*.sage.py
+
+# ================================
+# Virtual environments
+# ================================
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# ================================
+# IDEs / Editors
+# ================================
+.vscode/
+.spyderproject
+.spyproject
+.ropeproject
+
+/site
+
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+.pyre/
+.pytype/
+
+cython_debug/
+
+.ruff_cache/
+
+.pypirc
+
+.cursorignore
+.cursorindexingignore
+
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# ================================
+# macOS / Apple filesystem junk
+# ================================
+.DS_Store
+.AppleDouble
+.LSOverride
+._*
+.Spotlight-V100
+.Trashes
+.VolumeIcon.icns
+.fseventsd
+.Rhistory
+
+# ================================
+# Example output artifacts
+# ================================
+
+# Matplotlib / plotting outputs
+*.png
+*.pdf
+*.svg
+
+# Numpy saved arrays
+*.npy
+*.npz
+
+# CSV outputs from examples
+*.csv
+
+# Optional example output directory convention
+examples/output/
+

op_engine-0.1.0/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2026 Joshua Macdonald, Carl Pearson, and Timothy Willard
+
+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.