-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #387 from tobac-project/RC_v1.5.x
Merge RC v1.5.2 into main
- Loading branch information
Showing
57 changed files
with
88,261 additions
and
84,996 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
name: Bug Report | ||
about: Report a bug in the tobac library | ||
title: '' | ||
labels: bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
* [ ] Have you searched the issue tracker for the same problem? | ||
* [ ] Have you checked if you're using the latest version? If not, which version are you using? | ||
* [ ] Have you mentioned the steps to reproduce the issue? | ||
* [ ] Have you, if applicable, included error messages? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
name: Question | ||
about: 'Ask a general question about tobac ' | ||
title: '' | ||
labels: question | ||
assignees: '' | ||
|
||
--- | ||
|
||
* [ ] Have you searched the issue tracker for similar questions? | ||
* [ ] Have you read the documentation to ensure your question isn't already answered? | ||
* [ ] Have you searched Stack Overflow or other relevant forums to see if your question has been answered elsewhere? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Release | ||
about: Prepare a new release for tobac | ||
title: Release v.X.Y.Z | ||
labels: release | ||
assignees: '' | ||
|
||
--- | ||
|
||
Checklist for releasing vX.Y.Z: | ||
|
||
* [ ] Re-run notebooks and commit updates to repository | ||
* [ ] Bump version in `__init__.py` in `RC_vX.Y.Z` | ||
* [ ] Add changelog in `RC_vX.Y.Z` | ||
* [ ] Add new contributors to vX.Y.Z | ||
* [ ] Merge `RC_vX.Y.Z` into `main` | ||
* [ ] Delete `RC_vX.Y.Z` branch | ||
* [ ] Create release | ||
* [ ] Push release to conda-forge | ||
* [ ] E-mail tobac mailing list |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
name: Matrix Testing CI | ||
# this is similar to the pyart CI action | ||
on: [push, pull_request] | ||
|
||
concurrency: | ||
group: ${{ github.workflow }}-${{ github.ref }} | ||
cancel-in-progress: true | ||
|
||
# This job installs dependencies and runs tests across a matrix of python and OS versions. | ||
#Add if: github.repository == 'tobac-project/tobac' to limit runs to tobac repo | ||
|
||
jobs: | ||
build: | ||
name: ${{ matrix.os }}-${{ matrix.python-version }} | ||
runs-on: ${{ matrix.os }}-latest | ||
if: github.repository == 'tobac-project/tobac' | ||
defaults: | ||
run: | ||
shell: bash -l {0} | ||
strategy: | ||
fail-fast: false | ||
matrix: | ||
python-version: ["3.8", "3.9", "3.10", "3.11"] | ||
os: [macos, ubuntu, windows] | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
|
||
# Install micromamba and dependencies | ||
- name: Setup Conda Environment | ||
uses: mamba-org/setup-micromamba@v1 | ||
with: | ||
environment-file: environment-ci.yml | ||
activate-environment: pyart-dev | ||
cache-downloads: true | ||
channels: conda-forge | ||
channel-priority: strict | ||
python-version: ${{ matrix.python-version }} | ||
|
||
- name: Fetch all history for all tags and branches | ||
run: | | ||
git fetch --prune --unshallow | ||
- name: Install tobac | ||
shell: bash -l {0} | ||
run: | | ||
python -m pip install -e . --no-deps --force-reinstall | ||
- name: Run Tests | ||
id: run_tests | ||
shell: bash -l {0} | ||
run: | | ||
python -m pytest -v |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
name: Linting | ||
on: | ||
pull_request_target: | ||
branches: | ||
- '*' | ||
permissions: | ||
pull-requests: write | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
defaults: | ||
run: | ||
shell: bash -l {0} | ||
steps: | ||
- name: Check out Git repository | ||
uses: actions/checkout@v3 | ||
|
||
- name: Set up conda | ||
uses: conda-incubator/setup-miniconda@v2 | ||
with: | ||
miniforge-version: latest | ||
miniforge-variant: mambaforge | ||
channel-priority: strict | ||
channels: conda-forge | ||
show-channel-urls: true | ||
use-only-tar-bz2: true | ||
|
||
- name: Install tobac and pylint | ||
run: | | ||
mamba install --yes pylint | ||
pip install . | ||
- name: Store the PR branch | ||
run: | | ||
echo "SHA=$(git rev-parse "$GITHUB_SHA")" >> $GITHUB_OUTPUT | ||
id: git | ||
|
||
- name: Checkout RC branch | ||
uses: actions/checkout@v3 | ||
with: | ||
ref: ${{ github.base_ref }} | ||
|
||
- name: Get pylint score of RC branch | ||
run: | | ||
pylint tobac --disable=C --exit-zero | ||
id: main_score | ||
|
||
- name: Checkout PR branch | ||
uses: actions/checkout@v3 | ||
with: | ||
ref: "${{ steps.git.outputs.SHA }}" | ||
|
||
- name: Get pylint score of PR branch | ||
run: | | ||
# use shell script to save only tail of output | ||
OUTPUT_PART=$(pylint tobac --disable=C --exit-zero | tail -n 2) | ||
# but post entire output in the action details | ||
pylint tobac --disable=C --exit-zero | ||
# define random delimiter for multiline string | ||
EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64) | ||
echo "MESSAGE<<$EOF" >> "$GITHUB_OUTPUT" | ||
echo "$OUTPUT_PART" >> "$GITHUB_OUTPUT" | ||
echo "$EOF" >> "$GITHUB_OUTPUT" | ||
id: pr_score | ||
|
||
- name: Find Comment | ||
uses: peter-evans/find-comment@v2 | ||
id: comment | ||
with: | ||
issue-number: ${{ github.event.pull_request.number }} | ||
comment-author: 'github-actions[bot]' | ||
body-includes: Linting results by Pylint | ||
|
||
- name: Post result to PR | ||
uses: peter-evans/create-or-update-comment@v3 | ||
with: | ||
issue-number: ${{ github.event.pull_request.number }} | ||
comment-id: ${{ steps.comment.outputs.comment-id }} | ||
edit-mode: replace | ||
body: | | ||
Linting results by Pylint: | ||
-------------------------- | ||
${{ steps.pr_score.outputs.MESSAGE }} | ||
<sub>The linting score is an indicator that reflects how well your code version follows Pylint’s coding standards and quality metrics with respect to the ${{ github.base_ref }} branch. | ||
A decrease usually indicates your new code does not fully meet style guidelines or has potential errors.<sup> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,9 @@ | ||
version: 2 | ||
formats: all | ||
build: | ||
os: ubuntu-22.04 | ||
tools: | ||
python: "3.9" | ||
python: | ||
version: 3 | ||
install: | ||
- requirements: doc/requirements.txt | ||
- requirements: doc/requirements.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,4 +12,4 @@ trackpy | |
pre-commit | ||
black | ||
pytest | ||
|
||
typing_extensions |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
########################## | ||
Compute bulk statistics | ||
########################## | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
notebooks/compute_statistics_during_feature_detection_example | ||
notebooks/compute_statistics_during_segmentation_example | ||
notebooks/compute_statistics_postprocessing_example |
Oops, something went wrong.