chore: update from antarctic-plots to polartoolkit

Makefile

@@ -2,7 +2,7 @@ PROJECT=invert4geom
 STYLE_CHECK_FILES=.
 
 create:
-	mamba create --name $(PROJECT) --yes --force antarctic-plots python=3.11
+	mamba create --name $(PROJECT) --yes --force polartoolkit python=3.11
 
 create_test_env:
 	mamba create --name test --yes python=3.11

README.md

@@ -9,7 +9,7 @@
 <!-- SPHINX-START1 -->
 
 <!-- <p align="center">
-<a href="https://mybinder.org/v2/gh/mdtanker/antarctic_plots/main">
+<a href="https://mybinder.org/v2/gh/mdtanker/polartoolkit/main">
  <img src="https://mybinder.org/badge_logo.svg" alt="Binder link"></a>
  </p> -->
 

docs/conf.py

@@ -48,7 +48,7 @@
     # pykdtree
     "xrft": ("https://xrft.readthedocs.io/en/stable/", None),
     "harmonica": ("https://www.fatiando.org/harmonica/latest/", None),
-    "antarctic_plots": ("https://antarctic-plots.readthedocs.io/en/latest/", None),
+    "polartoolkit": ("https://polartoolkit.readthedocs.io/en/latest/", None),
     "numba": ("https://numba.pydata.org/numba-doc/latest/", None),
     "scipy": ("https://docs.scipy.org/doc/scipy/", None),
     # nptyping

docs/install.md

@@ -21,11 +21,11 @@ First create a `conda` environment and install the necessary packages into that:
 ```
 
 ```
-mamba create --name invert4geom antarctic-plots python=3.11
+mamba create --name invert4geom polartoolkit python=3.11
 ```
 
-The package `antarctic-plots` provides several useful functions used in
-`invert4geom`. Since `antarctic-plots` has several dependencies that can't be
+The package `polartoolkit` provides several useful functions used in
+`invert4geom`. Since `polartoolkit` has several dependencies that can't be
 install with `pip` (mostly `pygmt`), it is easiest to install with `conda`.
 
 activate the environment and use `pip` to install `invert4geom`:
@@ -66,7 +66,7 @@ If you don't have or want `make` or `mamba` installed, you can accomplish the
 same with the following:
 
 ```
-conda create --name invert4geom --yes --force antarctic-plots python=3.11
+conda create --name invert4geom --yes --force polartoolkit python=3.11
 conda activate invert4geom
 pip install -e .[all]
 ```

docs/user_guide/adhering_to_constraints.ipynb

@@ -34,7 +34,7 @@
     "import pandas as pd\n",
     "import verde as vd\n",
     "import xarray as xr\n",
-    "from antarctic_plots import utils as ap_utils\n",
+    "from polartoolkit import utils as polar_utils\n",
     "\n",
     "from invert4geom import inversion, plotting, synthetic, utils"
    ]
@@ -150,7 +150,7 @@
     }
    ],
    "source": [
-    "_ = ap_utils.grd_compare(\n",
+    "_ = polar_utils.grd_compare(\n",
     "    true_topography,\n",
     "    starting_topography,\n",
     "    plot_type=\"xarray\",\n",
@@ -1329,7 +1329,7 @@
    "source": [
     "final_topography = topo_results.set_index([\"northing\", \"easting\"]).to_xarray().topo\n",
     "\n",
-    "_ = ap_utils.grd_compare(\n",
+    "_ = polar_utils.grd_compare(\n",
     "    true_topography,\n",
     "    final_topography,\n",
     "    plot_type=\"xarray\",\n",

docs/user_guide/damping_cross_validation.ipynb

@@ -44,7 +44,7 @@
     "import numpy as np\n",
     "import verde as vd\n",
     "import xarray as xr\n",
-    "from antarctic_plots import utils as ap_utils\n",
+    "from polartoolkit import utils as polar_utils\n",
     "\n",
     "from invert4geom import cross_validation, inversion, plotting, synthetic, utils"
    ]
@@ -1053,7 +1053,7 @@
    "source": [
     "final_topography = topo_results.set_index([\"northing\", \"easting\"]).to_xarray().topo\n",
     "\n",
-    "_ = ap_utils.grd_compare(\n",
+    "_ = polar_utils.grd_compare(\n",
     "    true_topography,\n",
     "    final_topography,\n",
     "    plot_type=\"xarray\",\n",

docs/user_guide/density_cross_validation.ipynb

@@ -44,8 +44,8 @@
     "import pandas as pd\n",
     "import verde as vd\n",
     "import xarray as xr\n",
-    "from antarctic_plots import maps\n",
-    "from antarctic_plots import utils as ap_utils\n",
+    "from polartoolkit import maps\n",
+    "from polartoolkit import utils as polar_utils\n",
     "\n",
     "from invert4geom import cross_validation, inversion, plotting, synthetic, utils"
    ]
@@ -872,7 +872,7 @@
    "source": [
     "final_topography = topo_results.set_index([\"northing\", \"easting\"]).to_xarray().topo\n",
     "\n",
-    "_ = ap_utils.grd_compare(\n",
+    "_ = polar_utils.grd_compare(\n",
     "    true_topography,\n",
     "    final_topography,\n",
     "    plot_type=\"xarray\",\n",

docs/user_guide/estimating_regional_field.ipynb

@@ -38,8 +38,8 @@
     "import pandas as pd\n",
     "import verde as vd\n",
     "import xarray as xr\n",
-    "from antarctic_plots import maps\n",
-    "from antarctic_plots import utils as ap_utils\n",
+    "from polartoolkit import maps\n",
+    "from polartoolkit import utils as polar_utils\n",
     "\n",
     "from invert4geom import plotting, regional, synthetic, utils"
    ]
@@ -683,7 +683,7 @@
     "grav_grid = grav_df.set_index([\"northing\", \"easting\"]).to_xarray()\n",
     "\n",
     "# compare with true regional\n",
-    "_ = ap_utils.grd_compare(\n",
+    "_ = polar_utils.grd_compare(\n",
     "    grav_grid.lower_surface_grav,\n",
     "    grav_grid.filter_reg,\n",
     "    plot_type=\"xarray\",\n",
@@ -744,7 +744,7 @@
     "grav_grid = grav_df.set_index([\"northing\", \"easting\"]).to_xarray()\n",
     "\n",
     "# compare with true regional\n",
-    "_ = ap_utils.grd_compare(\n",
+    "_ = polar_utils.grd_compare(\n",
     "    grav_grid.lower_surface_grav,\n",
     "    grav_grid.trend_reg,\n",
     "    plot_type=\"xarray\",\n",
@@ -806,7 +806,7 @@
     "grav_grid = grav_df.set_index([\"northing\", \"easting\"]).to_xarray()\n",
     "\n",
     "# compare with true regional\n",
-    "_ = ap_utils.grd_compare(\n",
+    "_ = polar_utils.grd_compare(\n",
     "    grav_grid.lower_surface_grav,\n",
     "    grav_grid.eq_sources_reg,\n",
     "    plot_type=\"xarray\",\n",
@@ -870,7 +870,7 @@
     "grav_grid = grav_df.set_index([\"northing\", \"easting\"]).to_xarray()\n",
     "\n",
     "# compare with true regional\n",
-    "_ = ap_utils.grd_compare(\n",
+    "_ = polar_utils.grd_compare(\n",
     "    grav_grid.lower_surface_grav,\n",
     "    grav_grid.constraints_reg,\n",
     "    plot_type=\"xarray\",\n",

docs/user_guide/including_starting_model.ipynb

@@ -31,7 +31,7 @@
     "import pandas as pd\n",
     "import verde as vd\n",
     "import xarray as xr\n",
-    "from antarctic_plots import utils as ap_utils\n",
+    "from polartoolkit import utils as polar_utils\n",
     "\n",
     "from invert4geom import inversion, plotting, synthetic, utils"
    ]
@@ -128,7 +128,7 @@
     }
    ],
    "source": [
-    "_ = ap_utils.grd_compare(\n",
+    "_ = polar_utils.grd_compare(\n",
     "    true_topography,\n",
     "    starting_topography,\n",
     "    plot_type=\"xarray\",\n",
@@ -994,7 +994,7 @@
    "source": [
     "final_topography = topo_results.set_index([\"northing\", \"easting\"]).to_xarray().topo\n",
     "\n",
-    "_ = ap_utils.grd_compare(\n",
+    "_ = polar_utils.grd_compare(\n",
     "    true_topography,\n",
     "    final_topography,\n",
     "    plot_type=\"xarray\",\n",

docs/user_guide/simple_inversion.ipynb

@@ -39,8 +39,8 @@
     "\n",
     "import verde as vd\n",
     "import xarray as xr\n",
-    "from antarctic_plots import maps\n",
-    "from antarctic_plots import utils as ap_utils\n",
+    "from polartoolkit import maps\n",
+    "from polartoolkit import utils as polar_utils\n",
     "\n",
     "from invert4geom import inversion, plotting, synthetic, utils"
    ]
@@ -1393,7 +1393,7 @@
    "source": [
     "final_topography = topo_results.set_index([\"northing\", \"easting\"]).to_xarray().topo\n",
     "\n",
-    "_ = ap_utils.grd_compare(\n",
+    "_ = polar_utils.grd_compare(\n",
     "    true_topography,\n",
     "    final_topography,\n",
     "    plot_type=\"xarray\",\n",

env/RTD_env.yml

@@ -15,7 +15,7 @@ dependencies:
   - pykdtree
   - xrft>=1.0
   - harmonica>=0.6.0
-  - antarctic-plots>=0.0.6
+  - polartoolkit
   - numba
   - scipy
   - nptyping

env/test_env.yml

@@ -15,7 +15,7 @@ dependencies:
   - pykdtree
   - xrft>=1.0
   - harmonica>=0.6.0
-  - antarctic-plots>=0.0.6
+  - polartoolkit
   - numba
   - scipy
   - nptyping

noxfile.py

@@ -42,7 +42,7 @@ def tests(session: nox.Session) -> None:
     """
     Run the unit and regular tests.
     """
-    session.conda_install("antarctic-plots")
+    session.conda_install("polartoolkit")
     session.install(".[test]")
 
     # run tests with numba jit disabled to get real coverage

pyproject.toml

@@ -38,7 +38,7 @@ dependencies = [
   "pykdtree",
   "xrft>=1.0",
   "harmonica>=0.6.0",
-  "antarctic_plots>=0.0.6",
+  "polartoolkit",
   "numba",
   "scipy",
   "nptyping",

src/invert4geom/cross_validation.py

@@ -7,7 +7,7 @@
 import pandas as pd
 import verde as vd
 import xarray as xr
-from antarctic_plots import utils as ap_utils
+from polartoolkit import utils as polar_utils
 from tqdm.autonotebook import tqdm
 
 from invert4geom import inversion, plotting, utils
@@ -194,7 +194,7 @@ def grav_cv_score(
         obs = test_grid[kwargs.get("input_grav_column")] - test_grid.reg
         pred = test_grid.test_point_grav.rename("")
 
-        ap_utils.grd_compare(
+        polar_utils.grd_compare(
             pred,
             obs,
             grid1_name="Predicted gravity",

src/invert4geom/plotting.py

@@ -23,7 +23,7 @@
     pyvista = None
 import verde as vd
 import xarray as xr
-from antarctic_plots import utils as ap_utils
+from polartoolkit import utils as polar_utils
 
 from invert4geom import utils
 
@@ -342,7 +342,7 @@ def plot_inversion_topo_results(
 
     topo_lims = []
     for g in [initial_topo, final_topo]:
-        topo_lims.append(ap_utils.get_min_max(g))
+        topo_lims.append(polar_utils.get_min_max(g))
 
     topo_min = min([i[0] for i in topo_lims]) * topo_cmap_perc  # pylint: disable=consider-using-generator
     topo_max = max([i[1] for i in topo_lims]) * topo_cmap_perc  # pylint: disable=consider-using-generator
@@ -455,7 +455,7 @@ def plot_inversion_grav_results(
     initial_rmse = utils.rmse(grav_results["iter_1_initial_misfit"])
     final_rmse = utils.rmse(grav_results[f"iter_{max(iterations)}_final_misfit"])
 
-    _ = ap_utils.grd_compare(
+    _ = polar_utils.grd_compare(
         initial_misfit,
         final_misfit,
         plot=True,
@@ -530,11 +530,11 @@ def plot_inversion_iteration_results(
     corrections_lims = []
 
     for g in misfit_grids:
-        misfit_lims.append(ap_utils.get_min_max(g))
+        misfit_lims.append(polar_utils.get_min_max(g))
     for g in topo_grids:
-        topo_lims.append(ap_utils.get_min_max(g))
+        topo_lims.append(polar_utils.get_min_max(g))
     for g in corrections_grids:
-        corrections_lims.append(ap_utils.get_min_max(g))
+        corrections_lims.append(polar_utils.get_min_max(g))
 
     misfit_min = min([i[0] for i in misfit_lims])  # pylint: disable=consider-using-generator
     misfit_max = max([i[1] for i in misfit_lims])  # pylint: disable=consider-using-generator

tests/test_regional.py

@@ -54,7 +54,7 @@ def test_regional_trend(fill_method, trend):
     )
 
     # grid = df.set_index(["northing", "easting"]).to_xarray()
-    # ap_utils.grd_compare(grid.reg, grid.misfit, plot=True, plot_type="xarray")
+    # polar_utils.grd_compare(grid.reg, grid.misfit, plot=True, plot_type="xarray")
 
     assert len(df.misfit) == len(df.reg)
 
@@ -96,7 +96,7 @@ def test_regional_filter():
     )
 
     # grid = df.set_index(["northing", "easting"]).to_xarray()
-    # ap_utils.grd_compare(grid.reg, grid.misfit, plot=True, plot_type="xarray")
+    # polar_utils.grd_compare(grid.reg, grid.misfit, plot=True, plot_type="xarray")
 
     assert len(df.misfit) == len(df.reg)
 
@@ -172,7 +172,7 @@ def test_regional_constraints(test_input):
     )
 
     # grid = df.set_index(["northing", "easting"]).to_xarray()
-    # ap_utils.grd_compare(
+    # polar_utils.grd_compare(
     #     grid.reg, grid.misfit, plot=True, plot_type="xarray",
     #     points=points.rename(columns={"easting":"x", "northing":"y"}),
     #     )

tests/test_utils.py

@@ -209,8 +209,8 @@ def test_filter_grid_nans():
 #     # filter the grid
 #     filtered = utils.filter_grid(grid, filter_width=500, change_spacing=True)
 #     # get grid spacings
-#     original_spacing = float(ap_utils.get_grid_info(grid)[0])
-#     new_spacing = float(ap_utils.get_grid_info(filtered)[0])
+#     original_spacing = float(polar_utils.get_grid_info(grid)[0])
+#     new_spacing = float(polar_utils.get_grid_info(filtered)[0])
 #     print(original_spacing)
 #     print(new_spacing)
 #     # check that the gridspacing has been changed