Merge pull request #1 from dirac-institute/cchris28/partitionindex

partition indexer

.copier-answers.yml

@@ -0,0 +1,16 @@
+# Changes here will be overwritten by Copier
+_commit: v1.4.0
+_src_path: gh:lincc-frameworks/python-project-template
+author_email: [email protected]
+author_name: LINCC Frameworks
+create_example_module: false
+custom_install: true
+include_docs: true
+include_notebooks: true
+mypy_type_checking: basic
+package_name: regionsearch
+preferred_linter: black
+project_license: BSD
+project_name: kbmod-regionsearch
+use_gitlfs: none
+use_isort: true

.github/pull_request_template.md

@@ -0,0 +1,63 @@
+<!-- 
+Thank you for your contribution to the repo :)
+
+Pull Request (PR) Instructions:
+Provide a general summary of your changes in the Title above. Fill out each section of the template, and replace the space with an `x` in all the boxes that apply. If you're unsure about any of these, don't hesitate to ask. We're here to help! Once you are satisfied with the pull request, click the "Create pull request" button to submit it for review.
+
+Before submitting this PR, please ensure that your input and responses are entered in the designated space provided below each section to keep all project-related information organized and easily accessible.
+ 
+How to link to a PR:
+https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue 
+-->
+
+## Change Description
+<!--- 
+Describe your changes in detail. In your description, you should answer questions like "Why is this change required? What problem does it solve?".
+
+If it fixes an open issue, please link to the issue here. If this PR closes an issue, put the word 'closes' before the issue link to auto-close the issue when the PR is merged.
+-->
+- [ ] My PR includes a link to the issue that I am addressing
+
+
+
+## Solution Description
+<!-- Please explain the technical solution that I have provided and how it addresses the issue or feature being implemented -->
+
+
+
+## Code Quality
+- [ ] I have read the Contribution Guide
+- [ ] My code follows the code style of this project
+- [ ] My code builds (or compiles) cleanly without any errors or warnings
+- [ ] My code contains relevant comments and necessary documentation
+
+## Project-Specific Pull Request Checklists
+<!--- Please only use the checklist that apply to your change type(s) -->
+
+### Bug Fix Checklist
+- [ ] My fix includes a new test that breaks as a result of the bug (if possible)
+- [ ] My change includes a breaking change
+  - [ ] My change includes backwards compatibility and deprecation warnings (if possible)
+
+### New Feature Checklist
+- [ ] I have added or updated the docstrings associated with my feature using the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html)
+- [ ] I have updated the tutorial to highlight my new feature (if appropriate)
+- [ ] I have added unit/End-to-End (E2E) test cases to cover my new feature
+- [ ] My change includes a breaking change
+  - [ ] My change includes backwards compatibility and deprecation warnings (if possible)
+
+### Documentation Change Checklist
+- [ ] Any updated docstrings use the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html)
+
+### Build/CI Change Checklist
+- [ ] If required or optional dependencies have changed (including version numbers), I have updated the README to reflect this
+- [ ] If this is a new CI setup, I have added the associated badge to the README
+
+<!-- ### Version Change Checklist [For Future Use] -->
+
+### Other Change Checklist
+- [ ] Any new or updated docstrings use the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html).
+- [ ] I have updated the tutorial to highlight my new feature (if appropriate)
+- [ ] I have added unit/End-to-End (E2E) test cases to cover any changes
+- [ ] My change includes a breaking change
+  - [ ] My change includes backwards compatibility and deprecation warnings (if possible)

.github/workflows/build-documentation.yml

@@ -0,0 +1,34 @@
+# This workflow will install Python dependencies, build the package and then build the documentation.
+
+name: Build documentation
+
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        python -m pip install --upgrade pip
+        if [ -f docs/requirements.txt ]; then pip install -r docs/requirements.txt; fi
+        pip install .
+    - name: Install notebook requirements
+      run: |
+        sudo apt-get install pandoc
+    - name: Build docs
+      run: |
+        sphinx-build -T -E -b html -d docs/build/doctrees ./docs docs/build/html

.github/workflows/linting.yml

@@ -0,0 +1,36 @@
+# This workflow will install Python dependencies, then perform static linting analysis.
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Lint
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8', '3.9', '3.10', '3.11']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        python -m pip install --upgrade pip
+        pip install .
+        pip install .[dev]
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Analyze code with linter
+
+      uses: psf/black@stable
+      with:
+        src: ./src

.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/smoke-test.yml

@@ -0,0 +1,38 @@
+# This workflow will run daily at 06:45.
+# It will install Python dependencies and run tests with a variety of Python versions.
+# See documentation for help debugging smoke test issues:
+#    https://lincc-ppt.readthedocs.io/en/latest/practices/ci_testing.html#version-culprit
+
+name: Unit test smoke test
+
+on:
+  schedule:
+    - cron: 45 6 * * *
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8', '3.9', '3.10', '3.11']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        python -m pip install --upgrade pip
+        pip install .
+        pip install .[dev]
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: List dependencies
+      run: |
+        pip list
+    - name: Run unit tests with pytest
+      run: |
+        python -m pytest tests

.github/workflows/testing-and-coverage.yml

@@ -0,0 +1,37 @@
+# This workflow will install Python dependencies, run tests and report code coverage with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Unit test and code coverage
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8', '3.9', '3.10', '3.11']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        python -m pip install --upgrade pip
+        pip install .
+        pip install .[dev]
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Run unit tests with pytest
+      run: |
+        python -m pytest tests --cov=regionsearch --cov-report=xml
+    - name: Upload coverage report to codecov
+      uses: codecov/codecov-action@v3

.github/workflows/type-checking.yml

@@ -0,0 +1,35 @@
+# This workflow will install Python dependencies, then perform static type checking analysis.
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: mypy Type checking
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8', '3.9', '3.10', '3.11']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        python -m pip install --upgrade pip
+        pip install .
+        pip install .[dev]
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Analyze code with mypy
+
+      run: |
+        mypy ./src ./tests --ignore-missing-imports