Add advanced tutorials (#56)

* Miscellaneous * Miscellaneous * Add markdown linter precommit * Add madforhooks precommit * add pyupgrade precommit * Add nbstripout precommit * Add nbQa precommit * YAML formatting * Add rst precommit checks * Add prettier precommit * Move rgb plot argument to plot_kwargs * Refactor code order * Fix pcolormesh cartopy issue * Improve test coverage plots * Add initial new code for bucket partitioning * Add code and test for bucket writers and routines * Add code and test for bucket writers and routines * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update bucket to_xarray utility for multindexing * Update readme * Add tests for bucket readers * Add tests for bucket readers * Finalize readers and filters * Intermediate partitioning class refactor * Add refactor bucket reader interface * Add TilePartitioning * Generalize add_labels, add_centroids and to_xarray methods * Add fixes for windows * Fix bucket tests * Debug windows CI * Fix windows buckets tests * Rename partitioning names argument to levels * Rename partitioning_order to order * Rename partitioning_flavor to flavor * Remove xbin and ybin attrs in XYPartitioning * Add partitioning query_vertices methods * Update encoding chunksizes and preferred_chunks when transposing * Fix bug in remap_numeric_array * Set quality variable as coordinate * Refactor plot_image * Add new test data * Refactor and improve visualization --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
ghiggi · Jun 2, 2024 · 09ea12c · 09ea12c
1 parent ed099c2
commit 09ea12c
Show file tree

Hide file tree

Showing 155 changed files with 16,678 additions and 8,195 deletions.
diff --git a/.coveragerc b/.coveragerc
@@ -2,14 +2,14 @@
 source =
 	gpm
 omit =
-	*dev*
 	*docs*
 	*tutorials*
-	gpm/bucket/*
 	gpm/cli/*
 	gpm/encoding/*
 	gpm/etc/*
-	gpm/retrieval/*
+	gpm/retrievals/*
+	gpm/visualization/animation.py
+	gpm/utils/pyresample.py
 	gpm/_version.py
 
 [report]

diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -1,58 +1,58 @@
+---
 name: 🐞 Bug Report
 description: File a bug/issue
 title: "[BUG] <title>"
 labels: [bug, triage]
 assignees: ghiggi
 body:
-- type: checkboxes
-  attributes:
-    label: Is there an existing issue for this?
-    description: Please search to see if an issue already exists for the bug you encountered.
-    options:
-    - label: I have searched the existing issues
-      required: true
-- type: textarea
-  attributes:
-    label: Current Behavior
-    description: A concise description of what you're experiencing.
-  validations:
-    required: false
-- type: textarea
-  attributes:
-    label: Expected Behavior
-    description: A concise description of what you expected to happen.
-  validations:
-    required: false
-- type: textarea
-  attributes:
-    label: Steps To Reproduce
-    description: Steps to reproduce the behavior.
-    placeholder: |
-      1. In this environment...
-      2. With this config...
-      3. Run '...'
-      4. See error...
-  validations:
-    required: false
-- type: textarea
-  attributes:
-    label: Environment
-    description: |
-      examples:
-        - **OS**: Ubuntu 20.04
-        - **Python**: 3.8.2
-    value: |
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for the bug you encountered.
+      options:
+        - label: I have searched the existing issues
+          required: true
+  - type: textarea
+    attributes:
+      label: Current Behavior
+      description: A concise description of what you're experiencing.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A concise description of what you expected to happen.
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Steps To Reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1. In this environment...
+        2. With this config...
+        3. Run '...'
+        4. See error...
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Environment
+      description: |
+        examples:
+          - **OS**: Ubuntu 20.04
+          - **Python**: 3.8.2
+      value: |
         - OS:
         - python:
-    render: markdown
-  validations:
-    required: false
-- type: textarea
-  attributes:
-    label: Anything else?
-    description: |
-      Links? References? Anything that will give us more context about the issue you are encountering!
-
-      Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
-  validations:
-    required: false
+      render: markdown
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Anything else?
+      description: |
+        Links? References? Anything that will give us more context about the issue you are encountering!
+        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false
diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml
@@ -1 +1,2 @@
+---
 blank_issues_enabled: false
diff --git a/.github/dependabot.yml → .github/dependabot.yaml b/.github/dependabot.yml → .github/dependabot.yaml
@@ -1,11 +1,11 @@
+---
 # To get started with Dependabot version updates, you'll need to specify which
 # package ecosystems to update and where the package manifests are located.
 # Please see the documentation for all configuration options:
-# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
-
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yaml-file
 version: 2
 updates:
-  - package-ecosystem: "github-actions" # See documentation for possible values
-    directory: "/" # Location of package manifests
+  - package-ecosystem: github-actions # See documentation for possible values
+    directory: / # Location of package manifests
     schedule:
-      interval: "monthly"
+      interval: monthly
diff --git a/.github/workflows/lint.yml → .github/workflows/lint.yaml b/.github/workflows/lint.yml → .github/workflows/lint.yaml
@@ -1,36 +1,31 @@
-name: Lint
-on: [push, pull_request, workflow_dispatch]
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/setup-python@v5
-        with:
-          python-version: "3.8"
-
-      - name: Ruff
-        if: success() || failure()
-        uses: pre-commit/[email protected]
-        with:
-          extra_args: ruff --all-files
-
-      - name: Black
-        if: success() || failure()
-        uses: pre-commit/[email protected]
-        with:
-          extra_args: black --all-files
-
-      - name: blackdoc
-        if: success() || failure()
-        uses: pre-commit/[email protected]
-        with:
-          extra_args: blackdoc --all-files
-
-      - name: codespell
-        if: success() || failure()
-        uses: pre-commit/[email protected]
-        with:
-          extra_args: codespell --all-files
+---
+name: Lint
+on: [push, pull_request, workflow_dispatch]
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.8"
+      - name: Ruff
+        if: success() || failure()
+        uses: pre-commit/[email protected]
+        with:
+          extra_args: ruff --all-files
+      - name: Black
+        if: success() || failure()
+        uses: pre-commit/[email protected]
+        with:
+          extra_args: black --all-files
+      - name: blackdoc
+        if: success() || failure()
+        uses: pre-commit/[email protected]
+        with:
+          extra_args: blackdoc --all-files
+      - name: codespell
+        if: success() || failure()
+        uses: pre-commit/[email protected]
+        with:
+          extra_args: codespell --all-files
diff --git a/.github/workflows/release_to_pypi.yml → .github/workflows/release_to_pypi.yaml b/.github/workflows/release_to_pypi.yml → .github/workflows/release_to_pypi.yaml
@@ -1,56 +1,48 @@
-name: Package Release to PyPI
-on:
-  push:
-    tags:
-      - "v*"
-
-jobs:
-  build-n-publish:
-    name: Build and publish to PyPI
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-
-    steps:
-      - name: Checkout source
-        uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.x"
-
-      - name: Install pypa/build
-        run: >-
-          python -m
-          pip install build
-
-      - name: Build a binary wheel
-        run: >-
-          python -m build
-
-      - name: Publish distribution to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          user: __token__
-          password: ${{ secrets.PYPI_API_TOKEN }}
-
-      - name: Get Asset name
-        if: success() || failure()
-        run: |
-          export PKG=$(ls dist/ | grep tar)
-          set -- $PKG
-          echo "asset_name=$1" >> $GITHUB_ENV
-
-      - name: Create GitHub Release
-        if: success() || failure()
-        id: create_release
-        uses: softprops/action-gh-release@v2
-        with:
-          name: ${{ github.ref }}
-          tag_name: ${{ github.ref }}
-          files: |
-            dist/${{ env.asset_name }}
-          draft: false
-          prerelease: false
-          token: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
+---
+name: Package Release to PyPI
+on:
+  push:
+    tags: [v*]
+jobs:
+  build-n-publish:
+    name: Build and publish to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - name: Install pypa/build
+        run: >-
+          python -m
+          pip install build
+      - name: Build a binary wheel
+        run: >-
+          python -m build
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+      - name: Get Asset name
+        if: success() || failure()
+        run: |
+          export PKG=$(ls dist/ | grep tar)
+          set -- $PKG
+          echo "asset_name=$1" >> $GITHUB_ENV
+      - name: Create GitHub Release
+        if: success() || failure()
+        id: create_release
+        uses: softprops/action-gh-release@v2
+        with:
+          name: ${{ github.ref }}
+          tag_name: ${{ github.ref }}
+          files: |
+            dist/${{ env.asset_name }}
+          draft: false
+          prerelease: false
+          token: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token