Merge branch 'main' into JOSS_paper

.github/dependabot.yml

@@ -7,4 +7,7 @@ updates:
       interval: "monthly"
     commit-message:
       prefix: "chore"
-      include:
+    groups:
+      actions:
+        patterns:
+          - "*"

.github/workflows/ci.yml

@@ -16,37 +16,24 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
+env:
+  # Many color libraries just need this to be set to any value, but at least
+  # one distinguishes color depth, where "3" -> "256-bit color".
+  FORCE_COLOR: 3
+
 # Use bash by default in all jobs
 defaults:
   run:
     shell: bash -el {0}
 
 jobs:
-  # run pre-commit which includes many formatting and linting tools
-  pre-commit:
-    name: Format
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - uses: actions/setup-python@v5
-        with:
-          python-version: "3.x"
-      - uses: pre-commit/[email protected]
-        with:
-          extra_args: --hook-stage manual --all-files
-      - name: Run PyLint
-        run: pipx run nox -s pylint -- --output-format=github
-
   # Run tests and upload to codecov
   test:
     name: Check Python ${{ matrix.python-version }} on ${{ matrix.runs-on }}
     runs-on: ${{ matrix.runs-on }}
     if: |
       ${{!startsWith(github.event.head_commit.message, 'docs:') }} ||
       ${{!startsWith(github.event.head_commit.message, 'style:') }}
-    needs: [pre-commit]
     strategy:
       # Otherwise, the workflow would stop if a single job fails. We want to
       # run all of them to catch failures in different combinations.
@@ -55,7 +42,6 @@ jobs:
         python-version: ["3.9", "3.10", "3.11", "3.12"]
         runs-on: [ubuntu-latest, macos-latest, windows-latest]
     env:
-      FORCE_COLOR: 3
       NUMBA_DISABLE_JIT: "1"
     timeout-minutes: 30
     steps:

.pre-commit-config.yaml

@@ -29,11 +29,6 @@ exclude: |
   )$
 
 repos:
-  # - repo: https://github.com/psf/black-pre-commit-mirror
-  #   rev: "23.9.1"
-  #   hooks:
-  #     - id: black-jupyter
-
   - repo: https://github.com/adamchainz/blacken-docs
     rev: "1.16.0"
     hooks:
@@ -112,3 +107,16 @@ repos:
         language: pygrep
         entry: PyBind|Numpy|Cmake|CCache|Github|PyTest
         exclude: .pre-commit-config.yaml
+
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: "v0.18"
+    hooks:
+      - id: validate-pyproject
+        additional_dependencies: ["validate-pyproject-schema-store[all]"]
+
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: "0.29.0"
+    hooks:
+      - id: check-dependabot
+      - id: check-github-workflows
+      - id: check-readthedocs

CHANGELOG.md

@@ -5,9 +5,34 @@ with commit parsing of [angular commits](https://github.com/angular/angular.js/b
 
 ## Unreleased
 ### 📦️ Build
+* update backup env yml for`v0.5.1` ([`7a1b984`](https://github.com/mdtanker/polartoolkit/commit/7a1b98434fed49a94d097a77557252a5a5314dce))
 ### 🧰 Chores / Maintenance
+### 📖 Documentation
+* fix issue in contrib guide ([`f776f03`](https://github.com/mdtanker/polartoolkit/commit/f776f03d56c581683688d27552eaec71f4b59029))
+
+
+## v0.5.1 (2024-08-05)
+### 🧰 Chores / Maintenance
+### 🐛 Bug Fixes
+* restrict geopandas to below v1 until issue with `scheme` is fixed in next pygmt release ([`846056e`](https://github.com/mdtanker/polartoolkit/commit/846056ed9aa8de7105398d1014d91f5201141fce))
+* remove nptyping as a dependency after issues with bool8 ([`6b97865`](https://github.com/mdtanker/polartoolkit/commit/6b97865002fed2469c32fea2276de352e90b416d))
+
+## v0.5.0 (2024-08-04)
+### 💥 Breaking Changes
+* change `origin_shift` parameter options
+
+BREAKING CHANGE: please update your code for functions `plot_grd` and `basemap` to use the following options for `origin_shift`: 'x', 'y', 'both', 'initialize', or None. ([`4e751c8`](https://github.com/mdtanker/polartoolkit/commit/4e751c8d6fc848bc15cd04657d913af374af8e4e))
+### 📦️ Build
+### 🧰 Chores / Maintenance
+* add test deps to conda_install for testing conda releases ([`0cc2da2`](https://github.com/mdtanker/polartoolkit/commit/0cc2da230754d9f23138ca13d123b5798e93fa0c))
+* updates from learn-scientific-python ([`07d79a9`](https://github.com/mdtanker/polartoolkit/commit/07d79a90213f8646bb909c6f5e03af99359b8106))
 * update binder env wih polartoolkit v0.4.0 ([`47ff400`](https://github.com/mdtanker/polartoolkit/commit/47ff400f81c3c33f4ab626e94c5f526b8a22f832))
 ### 📖 Documentation
+* fix issues with autoapi and typehints ([`51f4266`](https://github.com/mdtanker/polartoolkit/commit/51f4266c8aee1d3a37021844c34a0e7441ebf442))
+* rerun all doc notebooks ([`1c0fcb3`](https://github.com/mdtanker/polartoolkit/commit/1c0fcb33e5167a05a3bc9cbe986b81330ce62622))
+* minor corrections to docs ([`64ee497`](https://github.com/mdtanker/polartoolkit/commit/64ee497779bf20a34793956fb59d510d4b9b9282))
+* reduce notebook size with pygmt `dpi` parameter ([`46aadb8`](https://github.com/mdtanker/polartoolkit/commit/46aadb8c8727f620822811f2e0678ddc2007421d))
+* add make setup instructions to contrib guide ([`18fe9cf`](https://github.com/mdtanker/polartoolkit/commit/18fe9cf9b76c964baea357e109533c4c492398ae))
 * remove install info from readme ([`09ef175`](https://github.com/mdtanker/polartoolkit/commit/09ef175c3a9096ec014e3ee86880eb397fcd0f42))
 * typos in notebook ([`d539795`](https://github.com/mdtanker/polartoolkit/commit/d539795396d9c8675e71c797492a17f3cd44e09b))
 * fix missing instruction in contrib guide ([`8128a8f`](https://github.com/mdtanker/polartoolkit/commit/8128a8f0389f673dc91916f659b0e32417f7a3ea))
@@ -16,11 +41,25 @@ with commit parsing of [angular commits](https://github.com/angular/angular.js/b
 * add citation info ([`d1281da`](https://github.com/mdtanker/polartoolkit/commit/d1281dab3b7c698ee7653be36fd8eaa560c2a861))
 * update docs with numbered tutorials and other fixes ([`fdb7227`](https://github.com/mdtanker/polartoolkit/commit/fdb72271ac9b7cd7f5a59779a0ab6aa619992221))
 * point binder link to tutorials ([`3fddb27`](https://github.com/mdtanker/polartoolkit/commit/3fddb27c5a1c28bf2d8b7807f1cf1913e8393b0f))
+### 🚀 Features
+* add 'easting' and 'northing' as defaults for plotting points ([`13b917b`](https://github.com/mdtanker/polartoolkit/commit/13b917b31e939f73fbe4a4764502bfa81b15eeaf))
+* add earthaccess dependency and use for login credentials ([`1b87ca8`](https://github.com/mdtanker/polartoolkit/commit/1b87ca8f0b71bba73afd617cc06394b6a74b122e))
+### 🐛 Bug Fixes
+* add warning for deprecated origin shift parameters ([`728a218`](https://github.com/mdtanker/polartoolkit/commit/728a218aa3684f7990b3cc72abeb45d440e9c7bb))
+* found bug in `utils.square_subplots` ([`f87f2e1`](https://github.com/mdtanker/polartoolkit/commit/f87f2e1ff96f2335c857cdb00b5594325469421e))
+* drop band and spatial_ref variables from fetched grids ([`40f6ba2`](https://github.com/mdtanker/polartoolkit/commit/40f6ba2bb7e9fb7b9b4deda7ef895cc925bb4641))
 ###  🎨 Refactor
+* organize `plot_grd` and enable more mapping features for `basemap` ([`684e86e`](https://github.com/mdtanker/polartoolkit/commit/684e86e5957276f2e86fcd38fb1852c234a2a67f))
+* remove kwargs for `add_gridlines` ([`e86144d`](https://github.com/mdtanker/polartoolkit/commit/e86144d707dedbddae98414eea3f0d27b6584cd9))
 * mock import geopandas ([`ab3437d`](https://github.com/mdtanker/polartoolkit/commit/ab3437d17d856fe78e02f34596764e2937463004))
 * use figshare sample shapefiles and remove data/ from repo ([`de684bb`](https://github.com/mdtanker/polartoolkit/commit/de684bb53dd0a09de969160ebf6c32e0f44628e2))
 * remove quotes from scalebar ([`7995f9f`](https://github.com/mdtanker/polartoolkit/commit/7995f9fde71428e8e3f6cc58a917e26642a8ec8f))
-
+### ✏️ Formatting
+* pre-commit fixes ([`463a225`](https://github.com/mdtanker/polartoolkit/commit/463a225babe3d84aa2d2589121eba632050aa386))
+* auto style fix ([`65266e9`](https://github.com/mdtanker/polartoolkit/commit/65266e99e46481d88ffdf386899958a28417ed03))
+* typo ([`a8e0342`](https://github.com/mdtanker/polartoolkit/commit/a8e03420f4af969933495fbc98abccfd1ef201b1))
+### Other
+*  ([`4424866`](https://github.com/mdtanker/polartoolkit/commit/4424866f96dd88f5948ad307d28c4b958ac40caf))
 
 ## v0.4.0 (2024-06-14)
 ### 💥 Breaking Changes

Makefile

@@ -21,7 +21,7 @@ remove:
 	mamba remove --name $(PROJECT) --all
 
 conda_install:
-	mamba create --name $(PROJECT) --yes --force --channel conda-forge $(PROJECT)
+	mamba create --name $(PROJECT) --yes --force --channel conda-forge $(PROJECT) pytest pytest-cov deepdiff
 
 conda_export:
 	mamba env export --name $(PROJECT) --channel conda-forge --file env/environment.yml

README.md

@@ -43,7 +43,7 @@ alt="Latest version on PyPI"/></a>
 
 ![](docs/cover_fig.png)
 
-## Disclaimer
+# Disclaimer
 
 <p align="center">
 🚨 **Ready for daily use but still changing.** 🚨
@@ -63,7 +63,7 @@ You can use it to download common datasets (i.e. BedMachine, Bedmap2, MODIS Mosa
 
 Feel free to use, share, modify, and [contribute](https://polartoolkit.readthedocs.io/en/latest/contributing.html) to this project.
 
-### What _PolarToolkit_ is for:
+## What _PolarToolkit_ is for:
 
 - download commonly used datasets related to Antarctica, Greenland and the Arctic
 - making publication-quality maps and cross-sections
@@ -73,7 +73,7 @@ Feel free to use, share, modify, and [contribute](https://polartoolkit.readthedo
 - current focus for datasets is related to ice, geophysics, and earth properties since this is where my personal research interests are, but please request or add your own types of data!
 - basic geospatial manipulations (filtering, resampling, reprojecting, masking etc.)
 
-### What _PolarToolkit_ is **NOT** for:
+## What _PolarToolkit_ is **NOT** for:
 
 - downloading niche datasets or those that only cover specific regions
 - downloaded datasets outside of Antarctica, Greenland and the Arctic
@@ -90,7 +90,7 @@ Feel free to use, share, modify, and [contribute](https://polartoolkit.readthedo
 
 <!-- SPHINX-END-long-desc -->
 
-## How to contribute
+# How to contribute
 I welcome all forms of contribution! If you have any questions, comments or suggestions, please open a [discussion](https://github.com/mdtanker/polartoolkit/discussions/new/choose) or [issue (feature request)](https://github.com/mdtanker/polartoolkit/issues/new/choose)!
 
 Also, please feel free to share how you're using PolarToolkit, I'd love to know.