Merge branch 'main' into JOSS_paper

mdtanker · Feb 19, 2024 · 57411eb · 57411eb
2 parents b166a58 + a70231f
commit 57411eb
Show file tree

Hide file tree

Showing 27 changed files with 6,439 additions and 6,217 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -33,7 +33,7 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: "3.x"
-      - uses: pre-commit/[email protected].0
+      - uses: pre-commit/[email protected].1
         with:
           extra_args: --hook-stage manual --all-files
       - name: Run PyLint
@@ -97,4 +97,4 @@ jobs:
           --cov-report=term --durations=20
 
       - name: Upload coverage report
-        uses: codecov/codecov-action@v3.1.5
+        uses: codecov/codecov-action@v4.0.1
diff --git a/.github/workflows/get_pypi_stats.yml b/.github/workflows/get_pypi_stats.yml
@@ -19,7 +19,7 @@ jobs:
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: "traffic"
 

diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 <h2 align="center">Helpful tools for polar researchers</h2>
 
 <p align="center">
-<a href="https://antarctic-plots.readthedocs.io"><strong>Documentation Link</strong></a>
+<a href="https://polartoolkit.readthedocs.io"><strong>Documentation Link</strong></a>
 </p>
 
 <!-- SPHINX-START1 -->
@@ -42,7 +42,7 @@ alt="Compatible Python versions."
 alt="Zenodo DOI"
 />
 </a>
-<a href='https://readthedocs.org/projects/antarctic-plots/'><img src='https://readthedocs.org/projects/antarctic-plots/badge/?version=latest&style=flat-square' alt='Documentation Status' /></a>
+<a href='https://readthedocs.org/projects/polartoolkit/'><img src='https://readthedocs.org/projects/polartoolkit/badge/?version=latest&style=flat-square' alt='Documentation Status' /></a>
  </p>
 
 <!-- SPHINX-END1 -->
@@ -52,14 +52,14 @@ alt="Zenodo DOI"
 ## Disclaimer
 
 <p align="center">
-🚨 **This package is in early stages of development.** 🚨
+🚨 **Ready for daily use but still changing.** 🚨
 </p>
 
 This means that we are still adding a lot of new features and sometimes we make
 changes to the ones we already have while we try to improve the software based
 on users' experience, test new ideas, make better design decisions, etc. Some of
 these changes could be **backwards incompatible**. Keep that in mind before you
-update PolarToolkit to a newer version.
+update PolarToolkit to a new major version (i.e. from `v1.0.0` to `v2.0.0`).
 
 I welcome any feedback, ideas, or contributions! Please contact us on the
 [GitHub discussions page](https://github.com/mdtanker/polartoolkit/discussions)
@@ -75,8 +75,8 @@ BedMachine, Bedmap2, MODIA MoA), create maps and plots specific to Antarctica
 methods.
 
 Feel free to use, share, modify, and
-[contribute](https://antarctic-plots.readthedocs.io/en/latest/contribute.html)
-to this project. I've mostly made this for personal usage so expect significant
+[contribute](https://polartoolkit.readthedocs.io/en/latest/contributing.html) to
+this project. I've mostly made this for personal usage so expect significant
 changes. Hopefully, I'll implement more tests and Gallery examples soon.
 
 ## Project goals
@@ -100,5 +100,5 @@ the [GitHub page](https://github.com/mdtanker/polartoolkit/)!
 Also, please feel free to share how you're using PolarToolkit, I'd love to know.
 
 Please, read our
-[Contributor Guide](https://github.com/mdtanker/polartoolkit/blob/main/.github/CONTRIBUTING.md)
+[Contributor Guide](https://polartoolkit.readthedocs.io/en/latest/contributing.html)
 to learn how you can contribute to the project.
diff --git a/docs/gallery/3D_stack.ipynb b/docs/gallery/3D_stack.ipynb
@@ -9,13 +9,13 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2022-11-07T00:12:31.510033Z",
-     "iopub.status.busy": "2022-11-07T00:12:31.510033Z",
-     "iopub.status.idle": "2022-11-07T00:12:35.411888Z",
-     "shell.execute_reply": "2022-11-07T00:12:35.411888Z"
+     "iopub.execute_input": "2024-02-09T04:52:32.842409Z",
+     "iopub.status.busy": "2024-02-09T04:52:32.842207Z",
+     "iopub.status.idle": "2024-02-09T04:52:35.863914Z",
+     "shell.execute_reply": "2024-02-09T04:52:35.863528Z"
     }
    },
    "outputs": [],
@@ -46,21 +46,45 @@
    "execution_count": 2,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2022-11-07T00:12:35.417871Z",
-     "iopub.status.busy": "2022-11-07T00:12:35.415877Z",
-     "iopub.status.idle": "2022-11-07T00:14:52.938218Z",
-     "shell.execute_reply": "2022-11-07T00:14:52.922094Z"
+     "iopub.execute_input": "2024-02-09T04:52:35.866303Z",
+     "iopub.status.busy": "2024-02-09T04:52:35.866095Z",
+     "iopub.status.idle": "2024-02-09T04:52:46.140105Z",
+     "shell.execute_reply": "2024-02-09T04:52:46.139646Z"
     }
    },
    "outputs": [
     {
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "INFO:root:returning grid with new region and/or registration, same spacing\n",
-      "INFO:root:returning grid with new region and/or registration, same spacing\n",
-      "INFO:root:calculating icebase from surface and thickness grids\n",
-      "INFO:root:returning grid with new region and/or registration, same spacing\n",
+      "INFO:root:returning grid with new region and/or registration, same spacing\n"
+     ]
+    },
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "INFO:root:returning grid with new region and/or registration, same spacing\n"
+     ]
+    },
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "INFO:root:calculating icebase from surface and thickness grids\n"
+     ]
+    },
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "INFO:root:returning grid with new region and/or registration, same spacing\n"
+     ]
+    },
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
       "INFO:root:returning grid with new region and/or registration, same spacing\n"
      ]
     }
@@ -88,10 +112,10 @@
    "execution_count": 3,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2022-11-07T00:14:52.958200Z",
-     "iopub.status.busy": "2022-11-07T00:14:52.956203Z",
-     "iopub.status.idle": "2022-11-07T00:15:35.061899Z",
-     "shell.execute_reply": "2022-11-07T00:15:35.061899Z"
+     "iopub.execute_input": "2024-02-09T04:52:46.142537Z",
+     "iopub.status.busy": "2024-02-09T04:52:46.142174Z",
+     "iopub.status.idle": "2024-02-09T04:52:57.292747Z",
+     "shell.execute_reply": "2024-02-09T04:52:57.292323Z"
     }
    },
    "outputs": [
@@ -136,8 +160,15 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
-   "metadata": {},
+   "execution_count": 4,
+   "metadata": {
+    "execution": {
+     "iopub.execute_input": "2024-02-09T04:52:57.331904Z",
+     "iopub.status.busy": "2024-02-09T04:52:57.331727Z",
+     "iopub.status.idle": "2024-02-09T04:52:57.453128Z",
+     "shell.execute_reply": "2024-02-09T04:52:57.452679Z"
+    }
+   },
    "outputs": [
     {
      "data": {
@@ -148,7 +179,7 @@
        "<POLYGON ((-567296.694 -960693.399, -571417.813 -946194.579, -566583.657 -93...>"
       ]
      },
-     "execution_count": 6,
+     "execution_count": 4,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -172,23 +203,41 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 5,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2022-11-07T00:15:35.177658Z",
-     "iopub.status.busy": "2022-11-07T00:15:35.177658Z",
-     "iopub.status.idle": "2022-11-07T00:15:54.750994Z",
-     "shell.execute_reply": "2022-11-07T00:15:54.750484Z"
+     "iopub.execute_input": "2024-02-09T04:52:57.455008Z",
+     "iopub.status.busy": "2024-02-09T04:52:57.454894Z",
+     "iopub.status.idle": "2024-02-09T04:53:04.456547Z",
+     "shell.execute_reply": "2024-02-09T04:53:04.455706Z"
     }
    },
    "outputs": [
     {
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "makecpt [WARNING]: Without inc in -T option, -Z has no effect (ignored)\n",
-      "makecpt [WARNING]: Without inc in -T option, -Z has no effect (ignored)\n",
-      "makecpt [WARNING]: Without inc in -T option, -Z has no effect (ignored)\n",
+      "makecpt [WARNING]: Without inc in -T option, -Z has no effect (ignored)\n"
+     ]
+    },
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "makecpt [WARNING]: Without inc in -T option, -Z has no effect (ignored)\n"
+     ]
+    },
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "makecpt [WARNING]: Without inc in -T option, -Z has no effect (ignored)\n"
+     ]
+    },
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
       "makecpt [WARNING]: Without inc in -T option, -Z has no effect (ignored)\n"
      ]
     },

diff --git a/docs/gallery/basic_map.ipynb b/docs/gallery/basic_map.ipynb
@@ -21,10 +21,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2022-11-07T00:16:04.857258Z",
-     "iopub.status.busy": "2022-11-07T00:16:04.856278Z",
-     "iopub.status.idle": "2022-11-07T00:16:14.688464Z",
-     "shell.execute_reply": "2022-11-07T00:16:14.687462Z"
+     "iopub.execute_input": "2024-02-09T04:53:05.977192Z",
+     "iopub.status.busy": "2024-02-09T04:53:05.976275Z",
+     "iopub.status.idle": "2024-02-09T04:53:09.261331Z",
+     "shell.execute_reply": "2024-02-09T04:53:09.260931Z"
     }
    },
    "outputs": [],
@@ -48,10 +48,10 @@
    "execution_count": 2,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2022-11-07T00:16:14.698434Z",
-     "iopub.status.busy": "2022-11-07T00:16:14.694444Z",
-     "iopub.status.idle": "2022-11-07T00:16:18.637794Z",
-     "shell.execute_reply": "2022-11-07T00:16:18.636795Z"
+     "iopub.execute_input": "2024-02-09T04:53:09.263668Z",
+     "iopub.status.busy": "2024-02-09T04:53:09.263483Z",
+     "iopub.status.idle": "2024-02-09T04:53:11.806302Z",
+     "shell.execute_reply": "2024-02-09T04:53:11.805655Z"
     }
    },
    "outputs": [],
@@ -75,10 +75,10 @@
    "execution_count": 3,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2022-11-07T00:16:18.643777Z",
-     "iopub.status.busy": "2022-11-07T00:16:18.642780Z",
-     "iopub.status.idle": "2022-11-07T00:16:22.831980Z",
-     "shell.execute_reply": "2022-11-07T00:16:22.831980Z"
+     "iopub.execute_input": "2024-02-09T04:53:11.807964Z",
+     "iopub.status.busy": "2024-02-09T04:53:11.807842Z",
+     "iopub.status.idle": "2024-02-09T04:53:13.081840Z",
+     "shell.execute_reply": "2024-02-09T04:53:13.081122Z"
     }
    },
    "outputs": [
@@ -115,10 +115,10 @@
    "execution_count": 4,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2022-11-07T00:16:22.846915Z",
-     "iopub.status.busy": "2022-11-07T00:16:22.846915Z",
-     "iopub.status.idle": "2022-11-07T00:16:34.785064Z",
-     "shell.execute_reply": "2022-11-07T00:16:34.785064Z"
+     "iopub.execute_input": "2024-02-09T04:53:13.086134Z",
+     "iopub.status.busy": "2024-02-09T04:53:13.085990Z",
+     "iopub.status.idle": "2024-02-09T04:53:16.332675Z",
+     "shell.execute_reply": "2024-02-09T04:53:16.331493Z"
     }
    },
    "outputs": [
@@ -158,21 +158,27 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 5,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2022-11-07T00:16:34.795038Z",
-     "iopub.status.busy": "2022-11-07T00:16:34.795038Z",
-     "iopub.status.idle": "2022-11-07T00:17:04.382411Z",
-     "shell.execute_reply": "2022-11-07T00:17:04.382411Z"
+     "iopub.execute_input": "2024-02-09T04:53:16.338253Z",
+     "iopub.status.busy": "2024-02-09T04:53:16.338037Z",
+     "iopub.status.idle": "2024-02-09T04:53:24.440730Z",
+     "shell.execute_reply": "2024-02-09T04:53:24.440008Z"
     }
    },
    "outputs": [
     {
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "grd2cpt [ERROR]: Making a continuous cpt from a discrete cpt may give unexpected results!\n",
+      "grd2cpt [ERROR]: Making a continuous cpt from a discrete cpt may give unexpected results!\n"
+     ]
+    },
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
       "gmtset [WARNING]: Representation of font type not recognized. Using default.\n"
      ]
     },

diff --git a/docs/gallery/extend_pygmt.ipynb b/docs/gallery/extend_pygmt.ipynb
@@ -20,10 +20,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2022-11-07T00:17:08.009675Z",
-     "iopub.status.busy": "2022-11-07T00:17:08.009675Z",
-     "iopub.status.idle": "2022-11-07T00:17:12.916981Z",
-     "shell.execute_reply": "2022-11-07T00:17:12.916216Z"
+     "iopub.execute_input": "2024-02-09T04:53:26.118759Z",
+     "iopub.status.busy": "2024-02-09T04:53:26.118476Z",
+     "iopub.status.idle": "2024-02-09T04:53:29.194633Z",
+     "shell.execute_reply": "2024-02-09T04:53:29.193698Z"
     }
    },
    "outputs": [],
@@ -47,10 +47,10 @@
    "execution_count": 2,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2022-11-07T00:17:12.921935Z",
-     "iopub.status.busy": "2022-11-07T00:17:12.920938Z",
-     "iopub.status.idle": "2022-11-07T00:17:13.439798Z",
-     "shell.execute_reply": "2022-11-07T00:17:13.439798Z"
+     "iopub.execute_input": "2024-02-09T04:53:29.196669Z",
+     "iopub.status.busy": "2024-02-09T04:53:29.196437Z",
+     "iopub.status.idle": "2024-02-09T04:53:30.942832Z",
+     "shell.execute_reply": "2024-02-09T04:53:30.942378Z"
     }
    },
    "outputs": [],
@@ -65,10 +65,10 @@
    "execution_count": 3,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2022-11-07T00:17:13.442790Z",
-     "iopub.status.busy": "2022-11-07T00:17:13.442790Z",
-     "iopub.status.idle": "2022-11-07T00:17:31.675720Z",
-     "shell.execute_reply": "2022-11-07T00:17:31.675720Z"
+     "iopub.execute_input": "2024-02-09T04:53:30.944874Z",
+     "iopub.status.busy": "2024-02-09T04:53:30.944688Z",
+     "iopub.status.idle": "2024-02-09T04:53:37.392591Z",
+     "shell.execute_reply": "2024-02-09T04:53:37.391375Z"
     }
    },
    "outputs": [
@@ -125,10 +125,10 @@
    "execution_count": 4,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2022-11-07T00:17:31.772305Z",
-     "iopub.status.busy": "2022-11-07T00:17:31.771308Z",
-     "iopub.status.idle": "2022-11-07T00:17:42.406361Z",
-     "shell.execute_reply": "2022-11-07T00:17:42.405369Z"
+     "iopub.execute_input": "2024-02-09T04:53:37.406282Z",
+     "iopub.status.busy": "2024-02-09T04:53:37.406066Z",
+     "iopub.status.idle": "2024-02-09T04:53:40.102975Z",
+     "shell.execute_reply": "2024-02-09T04:53:40.102288Z"
     }
    },
    "outputs": [