Merge branch 'main' into JOSS_paper

.github/workflows/ci.yml

@@ -95,6 +95,6 @@ jobs:
           --cov-report=term --durations=20
 
       - name: Upload coverage report
-        uses: codecov/codecov-action@v4.3.1
+        uses: codecov/codecov-action@v4.5.0
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.pre-commit-config.yaml

@@ -21,7 +21,7 @@ exclude: |
       .github/ISSUE_TEMPLATE/bug_report.md|
       .github/ISSUE_TEMPLATE/feature_request.md|
       .github/config.yml|
-      CONTRIBUTING.md|
+      docs/contributing.md|
       templates/CHANGELOG.md.j2|
       README.md|
       paper/paper.bib|

CHANGELOG.md

@@ -3,6 +3,24 @@ Automatically updated by
 [python-semantic-release](https://python-semantic-release.readthedocs.io/en/latest/)
 with commit parsing of [angular commits](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits).
 
+## Unreleased
+### 📦️ Build
+### 🧰 Chores / Maintenance
+* update binder env wih polartoolkit v0.4.0 ([`47ff400`](https://github.com/mdtanker/polartoolkit/commit/47ff400f81c3c33f4ab626e94c5f526b8a22f832))
+### 📖 Documentation
+* 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))
+* move contrib guide into docs/ ([`3001032`](https://github.com/mdtanker/polartoolkit/commit/30010329bed35bd608b1f40f1c23bd403d639ad2))
+* update license to 2024 for source files ([`127b173`](https://github.com/mdtanker/polartoolkit/commit/127b173745181ad5fc25686c3d873a4124147862))
+* 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))
+###  🎨 Refactor
+* 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))
+
 
 ## v0.4.0 (2024-06-14)
 ### 💥 Breaking Changes

README.md

@@ -22,7 +22,7 @@ The software does this by providing:
 <!-- SPHINX-START-badges -->
 
 <p align="center">
-<a href="https://mybinder.org/v2/gh/mdtanker/polartoolkit-binder/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252Fmdtanker%252Fpolartoolkit%26urlpath%3Dtree%252Fpolartoolkit%252Fdocs%252Fgallery%26branch%3Dmain">
+<a href="https://mybinder.org/v2/gh/mdtanker/polartoolkit-binder/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252Fmdtanker%252Fpolartoolkit%26urlpath%3Dtree%252Fpolartoolkit%252Fdocs%252Ftutorial%26branch%3Dmain">
  <img src="https://mybinder.org/badge_logo.svg" alt="Binder link"></a>
  </p>
 
@@ -90,49 +90,8 @@ Feel free to use, share, modify, and [contribute](https://polartoolkit.readthedo
 
 <!-- SPHINX-END-long-desc -->
 
-
-### Pip
-
-Instead, you can use pip to install `polartoolkit, but first, you need to install a few dependencies with conda.
-This is because `PyGMT` `GeoPandas`, and `Cartopy` all rely on C packages, which can only be successfully installed with conda/mamba and not with pip.
-
-To create a new virtual environment:
-
-```
-mamba create --name polartoolkit --yes --force pygmt geopandas cartopy --channel conda-forge
-```
-
-And activate the environment, followed by using `pip` to install `polartoolkit`:
-
-```
-mamba activate polartoolkit
-pip install polartoolkit
-```
-
-To install the optional dependencies of `polartoolkit`, use this instead:
-
-```
-`pip install polartoolkit[all]`
-```
-
-### Development version
-
-You can use pip, with the above-created environment, to install the latest source from GitHub:
-
-```
-pip install git+https://github.com/mdtanker/polartoolkit.git
-```
-
-Or you can clone the repository and install:
-
-```
-git clone https://github.com/mdtanker/polartoolkit.git
-cd polartoolkit
-pip install .
-```
-
 ## 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) on the [GitHub page](https://github.com/mdtanker/polartoolkit/)!
+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.
 

docs/citing.md

@@ -1,5 +1,14 @@
 # Citing PolarToolkit
 
+This is research software made by scientists. Citations help us justify the effort that goes into building and maintaining this project.
+
+If you used `PolarToolkit` in your research, please consider citing our paper:
+
 ```{warning}
-Citation info still to come ...
+Journal of Open Source Software (JOSS) paper still in review ...
 ```
+
+This is an open-access publication.
+The paper and the associated software review can be freely accessed at: https://joss.theoj.org/papers/b3964f290fcd03c7706ef1973bcdf702
+
+If you would like to cite the specific version you used, which can improve reproducibility and let users know the state of the software at the time of your analysis, please use the version-specific citation and DOI (available from [Zenodo](https://zenodo.org/doi/10.5281/zenodo.7059091)).

docs/conf.py

@@ -1,3 +1,10 @@
+# Copyright (c) 2024 The Polartoolkit Developers.
+# Distributed under the terms of the MIT License.
+# SPDX-License-Identifier: MIT
+#
+# This code is part of the package:
+# PolarToolkit (https://github.com/mdtanker/polartoolkit)
+#
 # Copyright (c) 2022 The Polartoolkit Developers.
 # Distributed under the terms of the MIT License.
 # SPDX-License-Identifier: MIT