trap-hci 2.1.0__tar.gz

trap_hci-2.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: 🐞 Bug Report
+about: Report something that's not working correctly
+title: "[Bug]: "
+labels: bug
+assignees: ''
+---
+
+### 🐞 Describe the Bug
+
+A clear and concise description of what the bug is.
+
+### 🔍 Steps to Reproduce
+
+A step-by-step description of how to reproduce the bug,
+
+### ❌ Expected Behavior
+
+A clear description of what you expected to happen.
+
+### 📸 Screenshots / Logs
+
+If applicable, add screenshots or log outputs to help explain your problem.
+
+### 💻 Environment
+
+- **OS:** [e.g., Ubuntu, macOS, Windows]
+- **Python Version:** [e.g., 3.11]
+- **Project Version:** [e.g., v1.0.2]
+
+### 🛠 Additional context
+
+Add any other context about the problem here.

trap_hci-2.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Ask a question or seek support
+    url: https://github.com/m-samland/trap/discussions
+    about: Use Discussions for questions, support, or other topics.

trap_hci-2.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: ✨ Feature Request
+about: Suggest a new feature or improvement
+title: "[Feature]: "
+labels: enhancement
+assignees: ''
+---
+
+### ✨ Description of the Feature
+
+Clearly and concisely describe the feature you'd like.
+
+### 🚩 Problem or Motivation
+
+Explain the problem or use case this feature addresses.
+
+### 🔖 Proposed Solution
+
+Briefly outline a possible solution or how the feature could work.
+
+### 📝 Additional Information
+
+Add any additional context, references, screenshots, or mock-ups here.

trap_hci-2.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,40 @@
+### 📌 Description
+
+Provide a clear, concise description of the pull request's purpose and the changes made.
+
+### 📌 Type of change
+
+Please delete options that are not relevant (and this line).
+
+- Bug fix (non-breaking change which fixes an issue)
+- New feature (non-breaking change which adds functionality)
+- Breaking change (fix or feature that would cause existing functionality to not work as expected)
+
+### 🚨 Motivation and Context
+
+Why is this change required? Explain the problem it solves or the feature it adds.
+
+### ✅ Checklist
+
+- [ ] I’ve tested the changes locally.
+- [ ] I’ve updated documentation as necessary.
+- [ ] My changes follow the project's coding style and conventions.
+- [ ] All tests pass successfully.
+
+### 🔍 How to test/review
+
+Describe steps for testing or reviewing your PR:
+
+1. Step one
+2. Step two
+3. ...
+
+### 📸 Screenshots (if applicable)
+
+Add screenshots or GIFs that show your feature working or illustrate changes.
+
+### 🔖 Related Issues/Tickets
+
+List any related issues, tickets, or tasks here:
+- Closes #<issue_number>
+- Relates to #<issue_number>

trap_hci-2.1.0/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    target-branch: "develop"
+    schedule:
+      interval: "monthly"
+    groups:
+      actions:
+        patterns: ["*"]

trap_hci-2.1.0/.github/workflows/ci.yml

@@ -0,0 +1,93 @@
+name: CI
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+  # Dependencies float within their ranges, so a new upstream release can break
+  # the package while the repo is quiet. GitHub runs scheduled workflows on the
+  # default branch only.
+  schedule:
+    - cron: "0 6 * * 1"  # Mondays 06:00 UTC
+  workflow_dispatch:
+
+jobs:
+
+  lint:
+    name: 🧹 Lint with Ruff
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
+
+      - name: Install Ruff
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+
+      - name: Run Ruff check
+        run: |
+          ruff check .
+
+  test:
+    name: 🧪 Test with pytest (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    needs: lint  # Ensures linting passes before running tests
+
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      # Only the declared dependencies plus the test tools, so test_imports.py
+      # catches a module that needs a package only an optional extra provides.
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[test]"
+
+      # The suite builds synthetic data: no network, no species grids, no examples/.
+      - name: Run pytest
+        run: |
+          pytest
+
+  e2e:
+    name: 🔭 End-to-end on 51 Eri b
+    runs-on: ubuntu-latest
+    # Only spend the minutes once the cheap checks pass.
+    needs: [lint, test]
+    timeout-minutes: 30
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[test]"
+
+      # Real IRDIS data from examples/test_data; a few minutes on the runner's 4 CPUs.
+      - name: Run the end-to-end test
+        run: |
+          pytest -m e2e

trap_hci-2.1.0/.github/workflows/publish.yml

@@ -0,0 +1,108 @@
+name: Publish
+
+# Every run builds and checks the package. Uploads use Trusted Publishing (no tokens),
+# configured on PyPI and TestPyPI for this file name and the environments below:
+# - a published GitHub release uploads to PyPI (environment `pypi`: v* tags only,
+#   waits for a maintainer's approval);
+# - a manual run uploads a dev version to TestPyPI (environment `testpypi`).
+# Renaming this file or an environment breaks publishing until the trusted publishers on
+# PyPI and TestPyPI are updated. The release steps are in RELEASING.md.
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+
+  build:
+    name: 📦 Build and check
+    runs-on: ubuntu-latest
+
+    steps:
+      # setuptools_scm needs the tags; a shallow clone builds version 0.1.dev1.
+      - name: Checkout
+        uses: actions/checkout@v7
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
+
+      # PyPI rejects local versions (+g<hash>), which every build between tags carries.
+      - name: Build sdist and wheel
+        env:
+          SETUPTOOLS_SCM_OVERRIDES_FOR_TRAP_HCI: '{local_scheme = "no-local-version"}'
+        run: |
+          python -m pip install --upgrade pip build twine
+          python -m build
+          twine check --strict dist/*
+
+      # An upload can never be replaced, so install the wheel on its own before it goes out.
+      - name: Smoke test the wheel
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+        run: |
+          python -m venv "$RUNNER_TEMP/smoke"
+          "$RUNNER_TEMP/smoke/bin/pip" install dist/*.whl
+          cd "$RUNNER_TEMP"
+          "$RUNNER_TEMP/smoke/bin/python" -c "
+          import os, trap
+          print('trap', trap.__version__)
+          tag = os.environ['RELEASE_TAG']
+          assert not tag or trap.__version__ == tag.removeprefix('v'), f'version {trap.__version__} does not match tag {tag}'
+          "
+
+      - name: Upload the distributions
+        uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+
+  testpypi:
+    name: 🧪 Upload to TestPyPI
+    if: github.event_name == 'workflow_dispatch'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/trap-hci
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  pypi:
+    name: 🚀 Upload to PyPI
+    if: github.event_name == 'release'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/trap-hci
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

trap_hci-2.1.0/.gitignore

@@ -0,0 +1,132 @@
+.DS_Store
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+*_version.py
+
+# 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
+.hypothesis/
+.pytest_cache/
+
+# 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/
+docs/api/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/