Fixes (#146)

* update binder link

* add north_arrow to plot_grd

* fix histogram error

* change north arrow default position

* add get_region function

* rerun notebook

* update changelog

README.md

@@ -6,8 +6,8 @@
 </p>
 
 <p align="center">
-<a href="https://mybinder.org/v2/gh/mdtanker/antarctic_plots/c88a23c9dfe92c36f0bfdbbc277d926c2de763de">
- <img src="https://img.shields.io/badge/launch-binder-579ACA.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFkAAABZCAMAAABi1XidAAAB8lBMVEX///9XmsrmZYH1olJXmsr1olJXmsrmZYH1olJXmsr1olJXmsrmZYH1olL1olJXmsr1olJXmsrmZYH1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olJXmsrmZYH1olL1olL0nFf1olJXmsrmZYH1olJXmsq8dZb1olJXmsrmZYH1olJXmspXmspXmsr1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olLeaIVXmsrmZYH1olL1olL1olJXmsrmZYH1olLna31Xmsr1olJXmsr1olJXmsrmZYH1olLqoVr1olJXmsr1olJXmsrmZYH1olL1olKkfaPobXvviGabgadXmsqThKuofKHmZ4Dobnr1olJXmsr1olJXmspXmsr1olJXmsrfZ4TuhWn1olL1olJXmsqBi7X1olJXmspZmslbmMhbmsdemsVfl8ZgmsNim8Jpk8F0m7R4m7F5nLB6jbh7jbiDirOEibOGnKaMhq+PnaCVg6qWg6qegKaff6WhnpKofKGtnomxeZy3noG6dZi+n3vCcpPDcpPGn3bLb4/Mb47UbIrVa4rYoGjdaIbeaIXhoWHmZYHobXvpcHjqdHXreHLroVrsfG/uhGnuh2bwj2Hxk17yl1vzmljzm1j0nlX1olL3AJXWAAAAbXRSTlMAEBAQHx8gICAuLjAwMDw9PUBAQEpQUFBXV1hgYGBkcHBwcXl8gICAgoiIkJCQlJicnJ2goKCmqK+wsLC4usDAwMjP0NDQ1NbW3Nzg4ODi5+3v8PDw8/T09PX29vb39/f5+fr7+/z8/Pz9/v7+zczCxgAABC5JREFUeAHN1ul3k0UUBvCb1CTVpmpaitAGSLSpSuKCLWpbTKNJFGlcSMAFF63iUmRccNG6gLbuxkXU66JAUef/9LSpmXnyLr3T5AO/rzl5zj137p136BISy44fKJXuGN/d19PUfYeO67Znqtf2KH33Id1psXoFdW30sPZ1sMvs2D060AHqws4FHeJojLZqnw53cmfvg+XR8mC0OEjuxrXEkX5ydeVJLVIlV0e10PXk5k7dYeHu7Cj1j+49uKg7uLU61tGLw1lq27ugQYlclHC4bgv7VQ+TAyj5Zc/UjsPvs1sd5cWryWObtvWT2EPa4rtnWW3JkpjggEpbOsPr7F7EyNewtpBIslA7p43HCsnwooXTEc3UmPmCNn5lrqTJxy6nRmcavGZVt/3Da2pD5NHvsOHJCrdc1G2r3DITpU7yic7w/7Rxnjc0kt5GC4djiv2Sz3Fb2iEZg41/ddsFDoyuYrIkmFehz0HR2thPgQqMyQYb2OtB0WxsZ3BeG3+wpRb1vzl2UYBog8FfGhttFKjtAclnZYrRo9ryG9uG/FZQU4AEg8ZE9LjGMzTmqKXPLnlWVnIlQQTvxJf8ip7VgjZjyVPrjw1te5otM7RmP7xm+sK2Gv9I8Gi++BRbEkR9EBw8zRUcKxwp73xkaLiqQb+kGduJTNHG72zcW9LoJgqQxpP3/Tj//c3yB0tqzaml05/+orHLksVO+95kX7/7qgJvnjlrfr2Ggsyx0eoy9uPzN5SPd86aXggOsEKW2Prz7du3VID3/tzs/sSRs2w7ovVHKtjrX2pd7ZMlTxAYfBAL9jiDwfLkq55Tm7ifhMlTGPyCAs7RFRhn47JnlcB9RM5T97ASuZXIcVNuUDIndpDbdsfrqsOppeXl5Y+XVKdjFCTh+zGaVuj0d9zy05PPK3QzBamxdwtTCrzyg/2Rvf2EstUjordGwa/kx9mSJLr8mLLtCW8HHGJc2R5hS219IiF6PnTusOqcMl57gm0Z8kanKMAQg0qSyuZfn7zItsbGyO9QlnxY0eCuD1XL2ys/MsrQhltE7Ug0uFOzufJFE2PxBo/YAx8XPPdDwWN0MrDRYIZF0mSMKCNHgaIVFoBbNoLJ7tEQDKxGF0kcLQimojCZopv0OkNOyWCCg9XMVAi7ARJzQdM2QUh0gmBozjc3Skg6dSBRqDGYSUOu66Zg+I2fNZs/M3/f/Grl/XnyF1Gw3VKCez0PN5IUfFLqvgUN4C0qNqYs5YhPL+aVZYDE4IpUk57oSFnJm4FyCqqOE0jhY2SMyLFoo56zyo6becOS5UVDdj7Vih0zp+tcMhwRpBeLyqtIjlJKAIZSbI8SGSF3k0pA3mR5tHuwPFoa7N7reoq2bqCsAk1HqCu5uvI1n6JuRXI+S1Mco54YmYTwcn6Aeic+kssXi8XpXC4V3t7/ADuTNKaQJdScAAAAAElFTkSuQmCC" alt="Binder link"></a>
+<a href="https://mybinder.org/v2/gh/mdtanker/antarctic_plots/main">
+ <img src="https://mybinder.org/badge_logo.svg" alt="Binder link"></a>
  </p>
 
 <p align="center">

antarctic_plots/maps.py

@@ -319,6 +319,7 @@ def plot_grd(
     inset = kwargs.get("inset", False)
     title = kwargs.get("title", None)
     scalebar = kwargs.get("scalebar", False)
+    north_arrow = kwargs.get("north_arrow", False)
     reverse_cpt = kwargs.get("reverse_cpt", False)
     colorbar = kwargs.get("colorbar", True)
     shp_mask = kwargs.get("shp_mask", None)
@@ -476,6 +477,15 @@ def plot_grd(
             position=kwargs.get("position", "n.5/.05"),
         )
 
+    # add north arrow
+    if north_arrow is True:
+        add_north_arrow(
+            fig,
+            region=region,
+            projection=proj_latlon,
+            **kwargs,
+        )
+
     # display colorbar
     if colorbar is True:
         # removed duplicate kwargs before passing to add_colorbar
@@ -580,17 +590,22 @@ def add_colorbar(
         grid = kwargs.get("grid", None)
 
         # clip grid to plot region
-        with pygmt.clib.Session() as lib:
-            region = list(lib.extract_region())
-            assert len(region) == 4
+        region = kwargs.get("region", None)
+        # if no region supplied, get region of current PyGMT figure
+        if region is None:
+            with pygmt.clib.Session() as lib:
+                region = list(lib.extract_region())
+                assert len(region) == 4
 
         # clip grid to plot region
         if region != utils.get_grid_info(grid)[1]:
             # grid = fetch.resample_grid(grid, region=region)
+            ew = [region[0], region[1]]
+            ns = [region[2], region[3]]
             grid_clipped = grid.sel(
                 {
-                    list(grid.sizes.keys())[1]: slice(region[0], region[1]),
-                    list(grid.sizes.keys())[0]: slice(region[2], region[3]),
+                    list(grid.sizes.keys())[1]: slice(min(ew), max(ew)),
+                    list(grid.sizes.keys())[0]: slice(max(ns), min(ns)),
                 }
             )
             # if subplotting, region will be in figure units and grid will be clipped
@@ -674,24 +689,27 @@ def add_colorbar(
         except pygmt.exceptions.GMTCLibError:
             pass
         # plot histograms above colorbar
-        fig.histogram(
-            data=data,
-            projection=f"X{fig_width*cbar_width_perc}c/{cbar_yoffset-.1}c",
-            region=hist_reg,
-            frame=kwargs.get("hist_frame", False),
-            cmap=kwargs.get("hist_cmap", True),
-            fill=kwargs.get("hist_fill", None),
-            pen=kwargs.get("hist_pen", "default"),
-            barwidth=kwargs.get("hist_barwidth", None),
-            center=kwargs.get("hist_center", False),
-            distribution=kwargs.get("hist_distribution", False),
-            cumulative=kwargs.get("hist_cumulative", False),
-            extreme=kwargs.get("hist_extreme", "b"),
-            stairs=kwargs.get("hist_stairs", False),
-            # horizontal=kwargs.get('hist_horizontal', False),
-            series=f"{zmin}/{zmax}/{bin_width}",
-            histtype=hist_type,
-        )
+        try:
+            fig.histogram(
+                data=data,
+                projection=f"X{fig_width*cbar_width_perc}c/{cbar_yoffset-.1}c",
+                region=hist_reg,
+                frame=kwargs.get("hist_frame", False),
+                cmap=kwargs.get("hist_cmap", True),
+                fill=kwargs.get("hist_fill", None),
+                pen=kwargs.get("hist_pen", "default"),
+                barwidth=kwargs.get("hist_barwidth", None),
+                center=kwargs.get("hist_center", False),
+                distribution=kwargs.get("hist_distribution", False),
+                cumulative=kwargs.get("hist_cumulative", False),
+                extreme=kwargs.get("hist_extreme", "b"),
+                stairs=kwargs.get("hist_stairs", False),
+                # horizontal=kwargs.get('hist_horizontal', False),
+                series=f"{zmin}/{zmax}/{bin_width}",
+                histtype=hist_type,
+            )
+        except pygmt.exceptions.GMTCLibError:
+            print("issue with plotting histogram, skipping...")
 
         # shift figure back
         try:
@@ -964,7 +982,7 @@ def add_north_arrow(
     """
     rose_size = kwargs.get("rose_size", "1c")
 
-    position = kwargs.get("position", "n.5/.05")
+    position = kwargs.get("position", "n.1/.05")
 
     # if no region supplied, get region of current PyGMT figure
     if region is None:

antarctic_plots/regions.py

@@ -12,7 +12,7 @@
 import pandas as pd
 import verde as vd
 
-from antarctic_plots import maps, utils
+from antarctic_plots import maps, utils, regions
 
 try:
     import ipyleaflet
@@ -72,6 +72,28 @@
 
 # ice catchements
 
+def get_regions():
+    exclude_list = [
+        "__",
+        "pd",
+        "vd",
+        "utils",
+        "regions",
+        "TYPE_CHECKING",
+        "Union",
+        "maps",
+        "ipyleaflet",
+        "ipywidgets",
+        "combine_regions",
+        "draw_region",
+        "get_regions",
+    ]
+
+    # regions_dict = [item for item in vars(regions) if (item not in exclude_list) & (not item.startswith("_"))]
+    regions_dict = {k: v for k, v in vars(regions).items() if (k not in exclude_list) & (not k.startswith("_"))}
+
+    return regions_dict
+
 
 def combine_regions(
     region1: list,

docs/changelog.md

@@ -19,13 +19,18 @@
 * ROSETTA-Ice airborne magnetics for the Ross Ice Shelf from Tinto et al. 2019
 * BedMachine updated to v3
 
-#### New functions in `---`
+#### New functions in `regions`
+* `get_regions()``
+    * list all available regions
 
 ### 📖 Documentation
 
 ### ⛔ Maintenance
 * new URL for fetching ADMAP1 magnetic data
 * added Harmonica as a dependency for ADMAP-2 geosoft grid conversion
+* fix old binder links
+* added `north_arrow()` function call to `plot_grd()` with keyword `add_north_arrow`
+* fixed issues with clipping of grid for plotting colorbar histogram
 
 ### 🧑‍🤝‍🧑 Contributors
 [@mdtanker](https://github.com/mdtanker)

docs/index.md

@@ -3,8 +3,8 @@
 Functions to automate Antarctic data visualization
 
 <p align="center">
-<a href="https://mybinder.org/v2/gh/mdtanker/antarctic_plots/c88a23c9dfe92c36f0bfdbbc277d926c2de763de">
- <img src="https://img.shields.io/badge/launch-binder-579ACA.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFkAAABZCAMAAABi1XidAAAB8lBMVEX///9XmsrmZYH1olJXmsr1olJXmsrmZYH1olJXmsr1olJXmsrmZYH1olL1olJXmsr1olJXmsrmZYH1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olJXmsrmZYH1olL1olL0nFf1olJXmsrmZYH1olJXmsq8dZb1olJXmsrmZYH1olJXmspXmspXmsr1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olLeaIVXmsrmZYH1olL1olL1olJXmsrmZYH1olLna31Xmsr1olJXmsr1olJXmsrmZYH1olLqoVr1olJXmsr1olJXmsrmZYH1olL1olKkfaPobXvviGabgadXmsqThKuofKHmZ4Dobnr1olJXmsr1olJXmspXmsr1olJXmsrfZ4TuhWn1olL1olJXmsqBi7X1olJXmspZmslbmMhbmsdemsVfl8ZgmsNim8Jpk8F0m7R4m7F5nLB6jbh7jbiDirOEibOGnKaMhq+PnaCVg6qWg6qegKaff6WhnpKofKGtnomxeZy3noG6dZi+n3vCcpPDcpPGn3bLb4/Mb47UbIrVa4rYoGjdaIbeaIXhoWHmZYHobXvpcHjqdHXreHLroVrsfG/uhGnuh2bwj2Hxk17yl1vzmljzm1j0nlX1olL3AJXWAAAAbXRSTlMAEBAQHx8gICAuLjAwMDw9PUBAQEpQUFBXV1hgYGBkcHBwcXl8gICAgoiIkJCQlJicnJ2goKCmqK+wsLC4usDAwMjP0NDQ1NbW3Nzg4ODi5+3v8PDw8/T09PX29vb39/f5+fr7+/z8/Pz9/v7+zczCxgAABC5JREFUeAHN1ul3k0UUBvCb1CTVpmpaitAGSLSpSuKCLWpbTKNJFGlcSMAFF63iUmRccNG6gLbuxkXU66JAUef/9LSpmXnyLr3T5AO/rzl5zj137p136BISy44fKJXuGN/d19PUfYeO67Znqtf2KH33Id1psXoFdW30sPZ1sMvs2D060AHqws4FHeJojLZqnw53cmfvg+XR8mC0OEjuxrXEkX5ydeVJLVIlV0e10PXk5k7dYeHu7Cj1j+49uKg7uLU61tGLw1lq27ugQYlclHC4bgv7VQ+TAyj5Zc/UjsPvs1sd5cWryWObtvWT2EPa4rtnWW3JkpjggEpbOsPr7F7EyNewtpBIslA7p43HCsnwooXTEc3UmPmCNn5lrqTJxy6nRmcavGZVt/3Da2pD5NHvsOHJCrdc1G2r3DITpU7yic7w/7Rxnjc0kt5GC4djiv2Sz3Fb2iEZg41/ddsFDoyuYrIkmFehz0HR2thPgQqMyQYb2OtB0WxsZ3BeG3+wpRb1vzl2UYBog8FfGhttFKjtAclnZYrRo9ryG9uG/FZQU4AEg8ZE9LjGMzTmqKXPLnlWVnIlQQTvxJf8ip7VgjZjyVPrjw1te5otM7RmP7xm+sK2Gv9I8Gi++BRbEkR9EBw8zRUcKxwp73xkaLiqQb+kGduJTNHG72zcW9LoJgqQxpP3/Tj//c3yB0tqzaml05/+orHLksVO+95kX7/7qgJvnjlrfr2Ggsyx0eoy9uPzN5SPd86aXggOsEKW2Prz7du3VID3/tzs/sSRs2w7ovVHKtjrX2pd7ZMlTxAYfBAL9jiDwfLkq55Tm7ifhMlTGPyCAs7RFRhn47JnlcB9RM5T97ASuZXIcVNuUDIndpDbdsfrqsOppeXl5Y+XVKdjFCTh+zGaVuj0d9zy05PPK3QzBamxdwtTCrzyg/2Rvf2EstUjordGwa/kx9mSJLr8mLLtCW8HHGJc2R5hS219IiF6PnTusOqcMl57gm0Z8kanKMAQg0qSyuZfn7zItsbGyO9QlnxY0eCuD1XL2ys/MsrQhltE7Ug0uFOzufJFE2PxBo/YAx8XPPdDwWN0MrDRYIZF0mSMKCNHgaIVFoBbNoLJ7tEQDKxGF0kcLQimojCZopv0OkNOyWCCg9XMVAi7ARJzQdM2QUh0gmBozjc3Skg6dSBRqDGYSUOu66Zg+I2fNZs/M3/f/Grl/XnyF1Gw3VKCez0PN5IUfFLqvgUN4C0qNqYs5YhPL+aVZYDE4IpUk57oSFnJm4FyCqqOE0jhY2SMyLFoo56zyo6becOS5UVDdj7Vih0zp+tcMhwRpBeLyqtIjlJKAIZSbI8SGSF3k0pA3mR5tHuwPFoa7N7reoq2bqCsAk1HqCu5uvI1n6JuRXI+S1Mco54YmYTwcn6Aeic+kssXi8XpXC4V3t7/ADuTNKaQJdScAAAAAElFTkSuQmCC" alt="Binder link"></a>
+<a href="https://mybinder.org/v2/gh/mdtanker/antarctic_plots/main">
+ <img src="https://mybinder.org/badge_logo.svg" alt="Binder link"></a>
  </p>
 
 <p align="center">