SIT-2 Release [main]

.all-contributorsrc

@@ -0,0 +1,104 @@
+{
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "commitType": "docs",
+  "commitConvention": "angular",
+  "contributors": [
+    {
+      "login": "greglucas",
+      "name": "Greg Lucas",
+      "avatar_url": "https://avatars.githubusercontent.com/u/12417828?v=4",
+      "profile": "http://greglucas.github.io",
+      "contributions": [
+        "code",
+        "doc",
+        "ideas",
+        "infra",
+        "maintenance",
+        "review"
+      ]
+    },
+    {
+      "login": "tech3371",
+      "name": "Tenzin Choedon",
+      "avatar_url": "https://avatars.githubusercontent.com/u/36522642?v=4",
+      "profile": "https://github.com/tech3371",
+      "contributions": [
+        "code",
+        "ideas",
+        "infra",
+        "example",
+        "maintenance",
+        "review"
+      ]
+    },
+    {
+      "login": "laspsandoval",
+      "name": "Laura Sandoval",
+      "avatar_url": "https://avatars.githubusercontent.com/u/46567335?v=4",
+      "profile": "https://github.com/laspsandoval",
+      "contributions": [
+        "review"
+     ]
+    },
+    {
+      "login": "sdhoyt",
+      "name": "Sean Hoyt",
+      "avatar_url": "https://avatars.githubusercontent.com/u/7146374?v=4",
+      "profile": "https://github.com/sdhoyt",
+      "contributions": [
+        "code",
+        "ideas",
+        "infra",
+        "review"
+      ]
+    },
+    {
+      "login": "GFMoraga",
+      "name": "Gabriel M.",
+      "avatar_url": "https://avatars.githubusercontent.com/u/104743000?v=4",
+      "profile": "https://github.com/GFMoraga",
+      "contributions": [
+        "code",
+        "ideas",
+        "infra",
+        "review"
+      ]
+    },
+    {
+      "login": "bourque",
+      "name": "Matthew Bourque",
+      "avatar_url": "https://avatars.githubusercontent.com/u/2250769?v=4",
+      "profile": "https://github.com/bourque",
+      "contributions": [
+        "code",
+        "doc",
+        "ideas",
+        "infra",
+        "review"
+      ]
+    },
+    {
+      "login": "maxinelasp",
+      "name": "Maxine Hartnett",
+      "avatar_url": "https://avatars.githubusercontent.com/u/117409426?v=4",
+      "profile": "https://github.com/maxinelasp",
+      "contributions": [
+        "code",
+        "ideas",
+        "infra",
+        "review",
+        "doc"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "skipCi": true,
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "projectName": "imap_processing",
+  "projectOwner": "IMAP-Science-Operations-Center"
+}

.github/issue_templates/Algorithim_development.md

@@ -0,0 +1,30 @@
+### Algorithm Description:
+
+### Requirements:
+
+> **Specify: (optional)**
+
+### Algorithm Code Information:
+> Input data:
+> > **Specify details:**
+>
+> Algorithim steps/psuedocode:
+> > **Specify details:**
+>
+> Output data:
+> > **Specify details:**
+
+
+### Code:
+
+```python
+# Code
+```
+
+#### Specify if any dependicies were added
+
+
+
+### Other Notes:
+
+### Related Issues/PRs:

.github/issue_templates/Bug_reporting.md

@@ -0,0 +1,23 @@
+## Description of the issue
+
+### Steps to reproduce the issue
+
+    1.
+    2.
+    3.
+
+### Code Snippet:
+
+```python
+# Code
+```
+
+### Expected behavior (What should happen)
+
+### Actual behavior (What does happen)
+
+#### Additional notes
+
+### Affected areas (code, data, or process)
+
+### Suggested fix?

.github/issue_templates/General_issue.md

@@ -0,0 +1,17 @@
+### Topic:
+
+### Description:
+
+### Requirements
+
+> **Specify: (optional)**
+
+### Code Snippet (optional):
+
+    ```python
+    # Code
+    ```
+
+### Related (optional):
+
+### Follow-up comments:

.github/workflows/docs.yml

@@ -0,0 +1,56 @@
+name: "Documentation Build"
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}
+  cancel-in-progress: true
+on:
+- pull_request
+- release
+
+jobs:
+  docs:
+    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 .[doc]
+
+    - name: Build documentation
+      run: |
+        make -C docs html
+
+    - uses: actions/upload-artifact@v2
+      with:
+        name: DocumentationHTML
+        path: docs/build/html/
+
+    # Publish built docs to gh-pages branch
+    - name: Commit documentation changes
+      # push docs only when a GitHub Release is made
+      if: github.event_name == 'release' && github.event.action == 'published'
+      run: |
+        git clone https://github.com/IMAP-Science-Operations-Center/imap_processing.git --branch gh-pages --single-branch gh-pages
+        cp -r docs/build/html/* gh-pages/
+        cd gh-pages
+        git config --local user.email "[email protected]"
+        git config --local user.name "GitHub Action"
+        git add .
+        git commit -m "Update documentation" -a || true
+        # The above command will fail if no changes were present, so we ignore that.
+
+    - name: Publish docs
+      # push docs only when a GitHub Release is made
+      if: github.event_name == 'release' && github.event.action == 'published'
+
+      uses: ad-m/github-push-action@master
+      with:
+        branch: gh-pages
+        directory: gh-pages
+        github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,68 @@
+name: Build and upload to PyPI
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}
+  cancel-in-progress: true
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+
+  build_sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    outputs:
+      SDIST_NAME: ${{ steps.sdist.outputs.SDIST_NAME }}
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # We need the full history to generate the proper version number
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v4
+        name: Install Python
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: python -m pip install build twine
+
+      - name: Build sdist
+        id: sdist
+        run: |
+          python -m build --sdist
+          # Get the name of the build sdist file for later use
+          echo "SDIST_NAME=$(ls -1 dist)" >> $GITHUB_OUTPUT
+
+      - name: Check README rendering for PyPI
+        run: twine check dist/*
+
+      - name: Upload sdist result
+        uses: actions/upload-artifact@v3
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+          if-no-files-found: error
+
+  pypi-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/imap_processing
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+
+    steps:
+      - name: Download sdist
+        uses: actions/download-artifact@v3
+        with:
+          name: sdist
+          path: dist
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/[email protected]

.gitignore

@@ -1,3 +1,6 @@
+# Documentation ignore
+docs/source/reference/generated
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -158,3 +161,4 @@ cython_debug/
 #  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/
+.DS_Store

.pre-commit-config.yaml

@@ -12,12 +12,14 @@ repos:
     - id: detect-private-key
     - id: mixed-line-ending
     - id: trailing-whitespace
+    - id: no-commit-to-branch
+      args: [--branch, main, --branch, dev]
   - repo: https://github.com/psf/black
     rev: 23.3.0
     hooks:
     - id: black
-  - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: 'v0.0.276'
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: 'v0.0.277'
     hooks:
     - id: ruff
       args: [--fix]
@@ -26,3 +28,4 @@ repos:
     hooks:
       - id: poetry-check
       - id: poetry-lock
+        args: [--no-update]

.readthedocs.yaml

@@ -0,0 +1,18 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.10"
+
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc
+
+