Merge branch 'main' into issue-template

Author: max-sixty

.binder/environment.yml

@@ -23,6 +23,7 @@ dependencies:
   - netcdf4
   - numba
   - numpy
+  - packaging
   - pandas
   - pint
   - pip

.github/ISSUE_TEMPLATE/bugreport.yml

@@ -0,0 +1,65 @@
+name: Bug Report
+description: File a bug report to help us improve
+labels: [bug, "needs triage"]
+body:
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: |
+        Thanks for reporting a bug! Please describe what you were trying to get done.
+        Tell us what happened, what went wrong.
+    validations:
+      required: true
+
+  - type: textarea
+    id: what-did-you-expect-to-happen
+    attributes:
+      label: What did you expect to happen?
+      description: |
+        Describe what you expected to happen.
+    validations:
+      required: false
+
+  - type: textarea
+    id: sample-code
+    attributes:
+      label: Minimal Complete Verifiable Example
+      description: |
+        Minimal, self-contained copy-pastable example that generates the issue if possible. Please be concise with code posted. See guidelines below on how to provide a good bug report:
+
+        - [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve)
+        - [Craft Minimal Bug Reports](http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports)
+
+        Bug reports that follow these guidelines are easier to diagnose, and so are often handled much more quickly.
+        This will be automatically formatted into code, so no need for markdown backticks.
+      render: Python
+
+  - type: textarea
+    id: log-output
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant output. This will be automatically formatted into code, so no need for markdown backticks.
+      render: Python
+
+  - type: textarea
+    id: extra
+    attributes:
+      label: Anything else we need to know?
+      description: |
+        Please describe any other information you want to share.
+
+  - type: textarea
+    id: show-versions
+    attributes:
+      label: Environment
+      description: |
+        Paste the output of `xr.show_versions()` between the `<details>` tags, leaving an empty line following the opening tag.
+      value: |
+        <details>
+
+
+
+        </details>
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -6,3 +6,9 @@ contact_links:
       Ask questions and discuss with other community members here.
       If you have a question like "How do I concatenate a list of datasets?" then
       please include a self-contained reproducible example if possible.
+  - name: Raster analysis usage question
+    url: https://github.com/corteva/rioxarray/discussions
+    about: |
+      If you are using the rioxarray extension (engine='rasterio'), or have questions about
+      raster analysis such as geospatial formats, coordinate reprojection, etc.,
+      please use the rioxarray discussion forum.

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,17 @@
+name: Issue
+description: General Issue or discussion topic. For usage questions, please follow the "Usage question" link
+labels: ["needs triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please describe your issue here.
+  - type: textarea
+    id: issue-description
+    attributes:
+      label: What is your issue?
+      description: |
+        Thank you for filing an issue! Please give us further information on how we can help you.
+      placeholder: Please describe your issue.
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/misc.yml

@@ -0,0 +1,35 @@
+name: Feature Request
+description: Suggest an idea for xarray
+labels: [enhancement]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Is your feature request related to a problem?
+      description: |
+        Please do a quick search of existing issues to make sure that this has not been asked before.
+        Please provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like
+      description: |
+        A clear and concise description of what you want to happen.
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered
+      description: |
+        A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: false
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: |
+        Add any other context about the feature request here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/newfeature.yml

@@ -2,6 +2,5 @@
 
 - [ ] Closes #xxxx
 - [ ] Tests added
-- [ ] Passes `pre-commit run --all-files`
 - [ ] User visible changes (including notable bug fixes) are documented in `whats-new.rst`
 - [ ] New functions/methods are listed in `api.rst`

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,7 @@
 # Configuration for probot-stale - https://github.com/probot/stale
 
 # Number of days of inactivity before an Issue or Pull Request becomes stale
-daysUntilStale: 700  # start with a large number and reduce shortly
+daysUntilStale: 600 # start with a large number and reduce shortly
 
 # Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
 # Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
@@ -14,10 +14,10 @@ exemptLabels:
   - "[Status] Maybe Later"
 
 # Set to true to ignore issues in a project (defaults to false)
-exemptProjects: false
+exemptProjects: true
 
 # Set to true to ignore issues in a milestone (defaults to false)
-exemptMilestones: false
+exemptMilestones: true
 
 # Set to true to ignore issues with an assignee (defaults to false)
 exemptAssignees: true
@@ -31,6 +31,9 @@ markComment: |
 
   If this issue remains relevant, please comment here or remove the `stale` label; otherwise it will be marked as closed automatically
 
+closeComment: |
+  The stalebot didn't hear anything for a while, so it closed this. Please reopen if this is still an issue.
+
 # Comment to post when removing the stale label.
 # unmarkComment: >
 #   Your comment here.
@@ -40,8 +43,7 @@ markComment: |
 #   Your comment here.
 
 # Limit the number of actions per hour, from 1-30. Default is 30
-limitPerRun: 1  # start with a small number
-
+limitPerRun: 2 # start with a small number
 
 # Limit to only `issues` or `pulls`
 # only: issues

.github/stale.yml

@@ -0,0 +1,74 @@
+name: Benchmark
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize, labeled]
+  workflow_dispatch:
+
+jobs:
+  benchmark:
+    if: ${{ contains( github.event.pull_request.labels.*.name, 'run-benchmark') && github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch' }}
+    name: Linux
+    runs-on: ubuntu-20.04
+    env:
+      ASV_DIR: "./asv_bench"
+
+    steps:
+      # We need the full repo to avoid this issue
+      # https://github.com/actions/checkout/issues/23
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Miniconda
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          # installer-url: https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-Linux-x86_64.sh
+          installer-url: https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-x86_64.sh
+
+      - name: Setup some dependencies
+        shell: bash -l {0}
+        run: |
+          pip install asv
+          sudo apt-get update -y
+
+      - name: Run benchmarks
+        shell: bash -l {0}
+        id: benchmark
+        env:
+          OPENBLAS_NUM_THREADS: 1
+          MKL_NUM_THREADS: 1
+          OMP_NUM_THREADS: 1
+          ASV_FACTOR: 1.5
+          ASV_SKIP_SLOW: 1
+        run: |
+          set -x
+          # ID this runner
+          asv machine --yes
+          echo "Baseline:  ${{ github.event.pull_request.base.sha }} (${{ github.event.pull_request.base.label }})"
+          echo "Contender: ${GITHUB_SHA} (${{ github.event.pull_request.head.label }})"
+          # Use mamba for env creation
+          # export CONDA_EXE=$(which mamba)
+          export CONDA_EXE=$(which conda)
+          # Run benchmarks for current commit against base
+          ASV_OPTIONS="--split --show-stderr --factor $ASV_FACTOR"
+          asv continuous $ASV_OPTIONS ${{ github.event.pull_request.base.sha }} ${GITHUB_SHA} \
+              | sed "/Traceback \|failed$\|PERFORMANCE DECREASED/ s/^/::error::/" \
+              | tee benchmarks.log
+          # Report and export results for subsequent steps
+          if grep "Traceback \|failed\|PERFORMANCE DECREASED" benchmarks.log > /dev/null ; then
+              exit 1
+          fi
+        working-directory: ${{ env.ASV_DIR }}
+
+      - name: Add instructions to artifact
+        if: always()
+        run: |
+          cp benchmarks/README_CI.md benchmarks.log .asv/results/
+        working-directory: ${{ env.ASV_DIR }}
+
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: asv-benchmark-results-${{ runner.os }}
+          path: ${{ env.ASV_DIR }}/.asv/results