roman-snpit-snappl 0.2.2__tar.gz

roman_snpit_snappl-0.2.2/.cruft.json

@@ -0,0 +1,34 @@
+{
+  "template": "https://github.com/Roman-Supernova-PIT/package-template",
+  "commit": "9d156bb4c476043b6c616e3e41047b68d4d89cdd",
+  "checkout": null,
+  "context": {
+    "cookiecutter": {
+      "package_name": "roman_snpit_snappl",
+      "module_name": "snappl",
+      "short_description": "Photometry utilities for the Roman SNPIT",
+      "author_name": "Roman SN PIT",
+      "author_email": "raknop@lbl.gov",
+      "github_username": "rknop",
+      "minimum_python_version": "3.11",
+      "use_compiled_extensions": "n",
+      "include_example_code": "n",
+      "include_github_workflows": "y",
+      "_project_url": "https://github.com/Roman-Supernova-PIT",
+      "_pit_github_org": "Roman-Supernova-PIT",
+      "_pit_name": "Roman Supernove Project Infrastructure Team",
+      "_sphinx_theme": "alabaster",
+      "_parent_project": "",
+      "install_requires": "",
+      "_copy_without_render": [
+        "docs/_templates",
+        "docs/_static",
+        ".github/workflows",
+        ".github/"
+      ],
+      "_template": "https://github.com/Roman-Supernova-PIT/package-template",
+      "_commit": "9d156bb4c476043b6c616e3e41047b68d4d89cdd"
+    }
+  },
+  "directory": null
+}

roman_snpit_snappl-0.2.2/.github/CODEOWNERS

@@ -0,0 +1,9 @@
+# automatically requests pull request reviews for files matching the given pattern; the last match takes precendence. Make sure the software-admin team has write on your repo
+
+*       @rknop @Roman-Supernova-Pit/software-admins
+
+# maintainers, add specifics of what you want to maintain for your package
+# the software-admins should remain owners of everything as above
+
+/docs/** @rknop
+/changes/** @rknop

roman_snpit_snappl-0.2.2/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,21 @@
+---
+name: "Feature request"
+about: Suggest an idea for this project
+title: "[New Feature]: "
+labels: enhancement, needs triage
+assignees: ''
+---
+
+## Is your feature request related to a problem? Please describe.
+<!--A clear and concise description of what the problem is. 
+Ex. I'm always frustrated when [...] -->
+
+## Describe the solution you'd like
+<!--A clear and concise description of what you want to happen.-->
+
+## Describe alternatives you've considered
+<!--A clear and concise description of any alternative solutions or features you've considered.-->
+
+## Additional context
+<!--Add any other context or screenshots about the feature request here.-->
+

roman_snpit_snappl-0.2.2/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md

@@ -0,0 +1,47 @@
+---
+name: "🐞 Issue report for roman_snpit_snappl"
+about: Create a report describing unexpected or incorrect behavior.
+title: "[Issue]: <title>"
+labels: bug
+assignees: ''
+---
+
+<!--
+Thanks for taking the time to fill out this report!
+Please have a search on our repository to see if a similar
+issue has already been posted. If a similar issue is closed, have a
+quick look to see if you are satisfied by the resolution.
+
+If not please go ahead and open an issue!
+-->
+
+### Current Behavior:
+<!-- A concise description of what you're experiencing. -->
+
+### Expected Behavior:
+<!-- A concise description of what you expected to happen. -->
+
+### Steps To Reproduce:
+<!--
+Example: steps to reproduce the behavior:
+1. In this environment...
+1. With this config...
+1. Run '...'
+1. See error...
+-->
+
+### Environment:
+<!--
+Example:
+- OS: Ubuntu 20.04
+- Node: 13.14.0
+- npm: 7.6.3
+- python: 3.13
+- numpy: 2.0
+-->
+
+### Anything else:
+<!--
+Links? References? Anything that will give us more context about the issue that you are encountering!
+-->
+

roman_snpit_snappl-0.2.2/.github/ISSUE_TEMPLATE/PR_TEMPLATE.md

@@ -0,0 +1,39 @@
+---
+name: "Pull Request for roman_snpit_snappl"
+about: Create a pull request to submit new or updated code to the repository
+title: "[PR]: "
+labels: possible solution
+assignees: ''
+---
+## What type of PR is this? (check all applicable)
+
+- [ ] Refactor
+- [ ] Feature
+- [ ] Bug Fix
+- [ ] Optimization
+- [ ] Documentation Update
+- [ ] Have you followed the guidelines in our Contributing document?
+- [ ] Have you checked to ensure there aren't other open [Pull Requests](../../../pulls) for the same update/change?
+
+<!-- describe the changes included with this PR here -->
+This PR addresses ...
+
+<!-- If this PR closes a GitHub issue, reference it here by its number -->
+Closes #
+
+
+<!-- if you can't perform these tasks due to permissions, please ask a maintainer to do them -->
+## Tasks
+- [ ] **request a review from someone specific**, to avoid making the maintainers review every PR
+- [ ] Does this PR change user-facing code / API? (if not, label with `no-changelog-entry-needed`)
+  - [ ] write news fragment(s) in `changes/`: `echo "changed something" > changes/<PR#>.<changetype>.rst` (see expansion below for change types) 
+  - [ ] update or add relevant tests
+  - [ ] update relevant docstrings and / or `docs/` page
+    - [ ] Do truth files need to be updated?
+
+
+<details><summary>news fragment change types...</summary>
+
+- ``changes/<PR#>.general.rst``: infrastructure or miscellaneous change
+- ``changes/<PR#>.docs.rst``: updates for documentation
+</details>

roman_snpit_snappl-0.2.2/.github/dependabot.yml

@@ -0,0 +1,38 @@
+name: "Dependabot Checks"
+version: 2
+updates:
+
+# maintain dependencies for pip
+# this should help with pyproject.toml
+- package-ecosystem: pip
+  directory: "/"
+  target-branch: "main"
+  schedule:
+    interval: weekly
+  open-pull-requests-limit: 10
+  reviewers:
+    - "rknop"
+  allow:
+    - dependency-type: direct
+    - dependency-type: indirect
+  commit-message:
+    prefix: "fix: "
+  labels:
+    - "CI/CD"
+
+# maintain dependencies for github-actions
+- package-ecosystem: "github-actions"
+  directory: ".github/workflows"
+  target-branch: "main"
+  reviewers:
+    - "rknop"
+  schedule:
+    interval: monthly
+  commit-message:
+    prefix: "fix: "
+  labels:
+    - "CI/CD"
+  groups:
+      actions:
+        patterns:
+          - "*"

roman_snpit_snappl-0.2.2/.github/labeler.yml

@@ -0,0 +1,34 @@
+# needs pull_request_target to label forks
+documentation:
+  - changed-files:
+    - all-globs-to-any-file: ['*.rst', '!CHANGES.rst', '!licenses/LICENSE']
+    - any-glob-to-any-file:
+      - 'docs/**/*'
+      - '*.md'
+      - '.readthedocs.yaml'
+      - 'CITATION.cff'
+
+installation:
+  - changed-files:
+    - any-glob-to-any-file:
+      - 'pyproject.toml'
+      - 'setup.*'
+      - 'requirements*.txt'
+      - 'MANIFEST.in'
+
+# --------------------------------------- testing ---------------------------------------
+
+automation:
+  - changed-files:
+    - any-glob-to-any-file:
+      - '.github/**'
+      - '.bandit.yaml'
+      - '.codecov.yml'
+
+testing:
+  - changed-files:
+    - any-glob-to-any-file:
+      - '**/tests/**'
+      - '.github/workflows/*ci*.yml'
+      - 'conftest.py'
+      - 'tox.ini'

roman_snpit_snappl-0.2.2/.github/workflows/changelog.yml

@@ -0,0 +1,37 @@
+name: changelog
+
+on:
+  pull_request:
+    types:
+      - labeled
+      - unlabeled
+      - opened
+      - synchronize
+      - reopened
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b  # v5.3.0
+        with:
+          python-version: 3
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
+        with:
+          fetch-depth: 0
+      - run: pip install .
+      - run: pip install towncrier
+      - run: towncrier check
+      - run: towncrier build --draft | grep -P '#${{ github.event.number }}'
+  prevent_manually_editing_changlog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
+        with:
+          fetch-depth: 0
+      - name: prevent direct changes to `CHANGES.rst`
+        run: git diff HEAD ${{ github.event.pull_request.base.sha }} --no-patch --exit-code CHANGES.rst

roman_snpit_snappl-0.2.2/.github/workflows/run_labeler.yml

@@ -0,0 +1,22 @@
+name: Label pull request
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - synchronized
+      - reopened
+
+jobs:
+  labeler:
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9  # v5.0.0
+          with:
+            repo-token: "${{ secrets.GITHUB_TOKEN }}"
+            sync-labels: true  # removes labels when files reverted
+            configuration-path: .github/labeler.yml
+          

roman_snpit_snappl-0.2.2/.github/workflows/run_snappl_tests.yml

@@ -0,0 +1,49 @@
+name: Run SNAPPL Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  tests:
+    name: run snappl tests in docker container
+    runs-on: ubuntu-latest
+    env:
+      COMPOSE_FILE: snappl/tests/docker-compose.yaml
+
+    steps:
+      - name: Dump docker logs on failure
+        if: failure()
+        uses: jwalton/gh-docker-logs@v2
+
+      - name: checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: log into github container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: cleanup
+        run: |
+          # try to save HDD space on the runner by removing some unneeded stuff
+          # ref: https://github.com/actions/runner-images/issues/2840#issuecomment-790492173
+          sudo rm -rf /usr/share/dotnet
+          sudo rm -rf /opt/ghc
+          sudo rm -rf "/usr/local/share/boost"
+          sudo rm -rf "$AGENT_TOOLSDIRECTORY"
+
+      - name: pull latest SNPIT cpu image
+        run: |
+          docker pull rknop/roman-snpit-env:cpu
+
+      - name: run test
+        run: |
+          docker compose run runtests

roman_snpit_snappl-0.2.2/.github/workflows/sphinx-deploy.yml

@@ -0,0 +1,27 @@
+name: "Deploy Package Documentation to Pages"
+
+on:
+  push:
+    branches: [main] # branch to trigger deployment
+
+  workflow_dispatch:
+
+jobs:
+  pages:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - id: deployment
+      uses: sphinx-notes/pages@3a7b173ecba074b270b37c64007c1edfd8465892  # v3.1
+      with:
+        publish: false
+        documentation_path: ./docs
+        pyproject_extras: docs
+    - uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e  # v4.0.0
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ${{ steps.deployment.outputs.artifact }} 
+        publish_branch: gh-pages  # default: gh-pages
+        commit_message: ${{ github.event.head_commit.message }}
+

roman_snpit_snappl-0.2.2/.github/workflows/sub_package_update.yml

@@ -0,0 +1,84 @@
+# This template is taken from the cruft example code, for further information please see:
+# https://cruft.github.io/cruft/#automating-updates-with-github-actions
+name: Automatic Update from package template
+permissions:
+    contents: write
+    pull-requests: write
+
+on:
+  # Allow manual runs through the web UI
+  workflow_dispatch:
+  schedule:
+    #        ┌───────── minute (0 - 59)
+    #        │ ┌───────── hour (0 - 23)
+    #        │ │ ┌───────── day of the month (1 - 31)
+    #        │ │ │ ┌───────── month (1 - 12 or JAN-DEC)
+    #        │ │ │ │ ┌───────── day of the week (0 - 6 or SUN-SAT)
+    - cron: '0 7 1 * *'  # Every first day of the month 7am UTC
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        include:
+          - add-paths: .
+            body: apply the changes to this repo.
+            branch: cruft/update
+            commit-message: "Automatic package template update"
+            title: Updates from the package template
+          - add-paths: .cruft.json
+            body: reject these changes for this repo.
+            branch: cruft/reject
+            commit-message: "Reject this package template update"
+            title: Reject new updates from package template
+
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683. # v4.2.2
+
+      - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b. # v5.3.0
+        with:
+          python-version: "3.11"
+
+      - name: Install Cruft
+        run: python -m pip install cruft
+
+      - name: Check if update is available
+        continue-on-error: false
+        id: check
+        run: |
+          CHANGES=0
+          if [ -f .cruft.json ]; then
+            if ! cruft check; then
+              CHANGES=1
+            fi
+          else
+            echo "No .cruft.json file"
+          fi
+
+          echo "has_changes=$CHANGES" >> "$GITHUB_OUTPUT"
+
+      - name: Run update if available
+        if: steps.check.outputs.has_changes == '1'
+        run: |
+          git config --global user.email "${{ github.actor }}@users.noreply.github.com"
+          git config --global user.name "${{ github.actor }}"
+
+          cruft update --skip-apply-ask --refresh-private-variables
+          git restore --staged .
+
+      - name: Create pull request
+        if: steps.check.outputs.has_changes == '1'
+        uses: peter-evans/create-pull-request@5e914681df9dc83aa4e4905692ca88beb2f9e91f. #v7.0.5
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          add-paths: ${{ matrix.add-paths }}
+          commit-message: ${{ matrix.commit-message }}
+          branch: ${{ matrix.branch }}
+          delete-branch: true
+          branch-suffix: timestamp
+          title: ${{ matrix.title }}
+          body: |
+            This is an autogenerated PR, which will ${{ matrix.body }}.
+            [Cruft](https://cruft.github.io/cruft/) has detected updates from the Package Template

roman_snpit_snappl-0.2.2/.gitignore

@@ -0,0 +1,172 @@
+# Emcas backup files
+**~
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+.DS_Store
+.project
+.pydevproject
+.vscode
+*code-workspace
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+pip-wheel-metadata/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+snappl/_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
+.tmp/
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.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
+*/.ipynb_checkpoints/*.ipynb
+
+# 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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.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
+
+# 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/
+
+# 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/

roman_snpit_snappl-0.2.2/.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-case-conflict
+      - id: trailing-whitespace
+      - id: check-added-large-files
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      # Ignore the template for checks which will be confused by jinja syntax
+      - id: check-ast
+        exclude: "roman_snpit_snappl"
+      - id: check-yaml
+        exclude: "roman_snpit_snappl"
+      - id: debug-statements
+        exclude: "roman_snpit_snappl"

roman_snpit_snappl-0.2.2/CHANGES.rst

@@ -0,0 +1,4 @@
+.. towncrier release notes start
+
+Package development begun 2025-04-22
+=====================================================

roman_snpit_snappl-0.2.2/CITATION.cff

@@ -0,0 +1,11 @@
+cff-version: 1.2.0
+message: "If you use this software in your work, please cite it using the following metadata."
+authors:
+- family-names: "Sosey"
+  given-names: "Megan"
+  orcid: "https://orcid.org/0000-0002-4206-6492"
+title: roman_snpit_snappl
+version: 0.0
+doi: 
+date-released: 
+url: "https://github.com/Roman-Supernova-PIT/roman_snpit_snappl"

roman_snpit_snappl-0.2.2/CODE_OF_CONDUCT.md

@@ -0,0 +1,24 @@
+# Roman Supernova PIT Open Source Code of Conduct
+
+We expect all "Roman Supernova PIT" organization projects to adopt a code of conduct that ensures a productive, respectful environment for all open source contributors and participants. We are committed to providing a strong and enforced code of conduct and expect everyone in our community to follow these guidelines when interacting with others in all forums. Our goal is to keep ours a positive, successful, and growing community. The community of participants in open source Astronomy projects is made up of members from around the globe with a diverse set of skills and experience. It is through these differences that our community experiences success and continued growth.
+
+
+As members of the community,
+
+- We pledge to treat all people with respect and provide a harassment- and bullying-free environment. In particular, sexual language and imagery, sexist, racist, or otherwise exclusionary jokes are not appropriate.
+
+- We pledge to respect the work of others by recognizing acknowledgment/citation requests of original authors. As authors, we pledge to be explicit about how we want our own work to be cited or acknowledged.
+
+- We pledge to welcome those interested in joining the community, and realize that including people with a variety of opinions and backgrounds will only serve to enrich our community. In particular, discussions relating to pros/cons of various technologies, programming languages, and so on are welcome, but these should be done with respect, taking proactive measure to ensure that all participants are heard and feel confident that they can freely express their opinions.
+
+- We pledge to welcome questions and answer them respectfully, paying particular attention to those new to the community. We pledge to provide respectful criticisms and feedback in forums, especially in discussion threads resulting from code contributions.
+
+- We pledge to be conscientious of the perceptions of the wider community and to respond to criticism respectfully. We will strive to model behaviors that encourage productive debate and disagreement, both within our community and where we are criticized. We will treat those outside our community with the same respect as people within our community.
+
+- We pledge to help the entire community follow the code of conduct, and to not remain silent when we see violations of the code of conduct. We will take action when members of our community violate this code such as talking privately with the person. The following email may be used to report any issue romansnpit@gmail.com. All emails sent to this address will be treated with the strictest confidence.
+
+This code of conduct applies to all community situations online and offline, including mailing lists, forums, social media, conferences, meetings, associated social events, and one-to-one interactions.
+
+Parts of this code of conduct have been adapted from the Astropy and Numfocus codes of conduct.
+http://www.astropy.org/code_of_conduct.html
+https://www.numfocus.org/about/code-of-conduct/