Skip to content

CHANGELOG.md

Latest commit

 

History

History
1196 lines (1033 loc) · 99.9 KB

CHANGELOG.md

File metadata and controls

1196 lines (1033 loc) · 99.9 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

v1.5.1

Released on 2026-03-22 Contributors:

  • Matt Tankersley
  • Boris Konstantinov

🚀 Added

  • several Moho elevation and crustal thickness models for Antarctica
  • added Scooby as a dependency, giving a nice environment report to use in the issues template
  • all functions now allow passing an EPSG code instead of a hemisphere string
  • many plotting functions now work for non polar stereographic projection by passing an EPSG code
  • support for variable figure sizes when using origin_shift
  • new function polygon_to_shapefile to convert output of interactive clicking to a shapefile
  • new function square_around_region to define a square centered around a region, used in the add_inset function
  • new function epsg_central_coordinates to get the central point of a EPSG projection, to be used for interactive data plotting
  • new parameter inset_width_factor to make region of the inset map a square x times larger than the figure region, centered on the figure region
  • new function gmt_projection_from_epsg
  • new section of docs for Gallery examples
  • new How-to notebook for plotting non-polar data

✏️ Changed

  • replaced Nox, Make, and Conda commands with Pixi
  • add all user-facing functions to polartoolkit namespace to be used with needed module names
  • removed autodoc in favor of manually created .rst file for API

⚠️ Deprecated

  • rename function grd_trend to grid_trend
  • rename function grd_compare to grid_compare
  • rename function plot_grd to plot_grid
  • rename function change_reg to change_registration
  • rename function grd_blend to grid_blend
  • rename function mask_from_shp to mask_from_shapefile
  • rename function points_inside_shp to points_inside_shapefile, and have it return a subset of the dataframe, instead of adding a new column 'inside'
  • rename parameter filt_type to filter_type
  • rename parameter shp_mask to shapefile
  • rename parameter inset_reg to inset_region

❌ Removed

  • function default_hemisphere in favor of new function default_epsg

🐛 Fixed

  • issues with preprocessing of Martos-2017 and AQ1 heat flow models
  • bug getting region from points during plotting
  • error message with grid of constant value during plotting
  • bug which didn't make points use same cmap as grid
  • annoying warning about GMT invalid font
  • ensure all past deprecation warnings are actually raised for users
  • incorrect link to the Contributor Guide in the docs
  • a bug when in the add_modis function

v1.5.0

Yanked from PyPI and conda-forge due to error in dependency version for pygmt.

v1.4.0

Released on 2026-01-08 Contributors:

  • Matt Tankersley
  • Max Lowe

🚀 Added

  • new geothermal heat flow models from Haeger et al. 2022 and Hazzard and Richards 2024.
  • Max Lowe added as new author to PolarToolkit!
  • pre-defined regions for all Antarctic ice shelves

🐛 Fixed

  • fixed a few citations issues in the docs
  • Antarctic bed type data wasn't in correct pooch cache location
  • use full names for PyGMT verbosity levels
  • issue with Bedmap3 grids when converted to ellipsoidal heights

v1.3.0

Released on 2025-11-06 Contributors:

  • Matt Tankersley

🚀 Added

  • known hashes used for all fetches (except some which are changed on each download)
  • add fetch for Aitken et al. 2023 Antarctic bed classifications
  • new function add_geologic_units() for plotting Geomap geologic units
  • new function add_bed_type() for plotting Antarctic bed classification
  • added notebook to be used periodically to re-download all datasets

🐛 Fixed

  • update several broken fetch download links for NSIDC datasets
  • some bugs with colorbars and grids supplied as filenames
  • remove annoying warnings about projections when plotting MODIS data

✏️ Changed

  • try to use original file names where applicable
  • for any preprocessed grid file, use the .zarr data format for quicker loading of data
  • renamed all kwargs for add_faults to start with faults_ instead of fault_

v1.2.0

Released on 2025-10-14 Contributors:

  • Matt Tankersley

🚀 Added

  • add individual functions for getting grid region, spacing, and registration

🐛 Fixed

  • fix broken download links for ice velocity datasets
  • fix some issues with ReadTheDocs
  • bug with passing colorbar twice to fig.add_points()
  • bug with pygmt parsing of region supplied with units

v1.1.3

Released on 2025-08-07 Contributors:

  • Matt Tankersley

🐛 Fixed

  • preserve original coordinate names in xarray datarrays when cutting or resampling
  • allow x and y shift amounts to be None

✏️ Changed

  • simplified ReadTheDocs environment using uv
  • add minimum dependencies for some packages following SPEC0
  • drop support for Python 3.10 and add 3.13 following SPEC 0

v1.1.2

Released on 2025-07-31 Contributors:

  • Matt Tankersley

🐛 Fixed

  • error in type checking which cause optional packages to be requires

v1.1.1

⚠️ YANKED: This has been yanked from PyPI since a bug accidentally required the optional dependency ipyleaflet.

Released on 2025-07-31 Contributors:

  • Matt Tankersley

🐛 Fixed

  • error in build process which didn't build / upload the correct sdist and wheel files

🚀 Added

  • a .zenodo.yml file to set metadata for Zenodo releases
  • a github action to validate the .zenodo.yml file

v1.1.0

⚠️ YANKED: This has been yanked from PyPI since sdist files weren't uploaded.

Released on 2025-07-30 Contributors:

  • Matt Tankersley

🚀 Added

  • speed up Profiles modules with lower-resolution default layers
  • store low-resolution (5km) versions of Bedmachine, Bedmap2/3, and IBCSO grids for faster use when high-resolution doesn't matter
  • new Figure class, with easy-to-call class plotting functions

🐛 Fixed

  • removed some bugs in subset_grid, grd_compare,
  • allow users to configure their own logging
  • updated use of GMT virtual files for correctly reading grid registration type
  • fix bug which removed dates and times from Bedmap point data

✏️ Changed

  • replace most Make commands with Nox
  • add minimum version of Zarr as 3.0 to fix issues with consolidated metadata
  • switch to Hatchling for build backend

❌ Removed

  • drop Python 3.9 support
  • remove license checks and text in each file
  • remove Python Semantic Release and automated changelogs

v1.0.6 (2025-07-17)

🐛 Bug Fixes

  • add warnings for other updated preprocessing functions (5bfe00c)
  • reset proj and region after plotting colorbar histogram (cb764a8)
  • bug with non-transparent basemap when plotting over existing figure (40a563a)
  • add warning to delete and rerun preprocessing for fetching bedmap2 grids (2ae58cb)
  • mistake in coord names for reproject() (690bcbc)

🧰 Chores / Maintenance

✏️ Formatting

v1.0.5 (2025-06-05)

🐛 Bug Fixes

  • remove issue with checking layer order in profiles (a04c614)

🧰 Chores / Maintenance

v1.0.4 (2025-06-05)

🐛 Bug Fixes

  • empty commit to force patch (14163f2)

📦️ Build

🧰 Chores / Maintenance

✏️ Formatting

v1.0.3 (2025-06-04)

🐛 Bug Fixes

  • manually trigger release (81523ea)

🧰 Chores / Maintenance

v1.0.1 (2025-06-04)

🐛 Bug Fixes

🧰 Chores / Maintenance

  • increase deprecations to v2.0.0 (f5ac4b3)

v1.0.0 (2025-06-04)

🐛 Bug Fixes

  • update fetch tests (3218acf)
  • update region tests (68d8ebc)
  • remove basal_melt fetch due to changed data access (8a8f64c)
  • remove unneeded checks in resample_grid (3a73b32)
  • bug in maps.subplots (b966565)
  • use pygmt.grdsample in grd_compare to ensure grids can be subtracted (c1f9b92)
  • bug where coordinates displayed on clicking interactive_map were incorrect (494ecc1)
  • remove bug where layers_version wasn't being used in plot_profiles (2f4f118)
  • bug in distance calculation for profiles, and rename relative and cumulative distance functions (788045d)
  • check region and spacing provide if no grid in utils.mask_from_polygon (2567780)
  • still fill layers in profile if entirely above plot (e850a05)
  • check cpt_lims for cbar_end_triangles (061e939)
  • plotting code should be under if plot condition for grd_compare (05daa80)

📦️ Build

  • add pyogrio as dep and remove geopandas upper version limit (9ffd5ce)

🧰 Chores / Maintenance

✏️ Formatting

  • minor changes to fetch.py (52b49c2)
  • fixes for new pre-commit hook versions (5b534ce)
  • pre-commit fixes (b49b4a0)
  • pre-commit fixes (e2e3516)

📖 Documentation

🚀 Features

  • add kwarg cpt_log to make colormap on a log scale. (e8406b6)
  • add regions_overlap function (e8ddbeb)
  • ensure ice surface, water surface, and earth surface are in correct order in plot_profiles (e668a90)
  • add option to choose modis cmap: modis_cmap (29ad0ac)
  • allow drapegrid for plot_3d (3f095c1)
  • enable absolute values option for colormaps (159de8b)
  • allow automatic and chosen colorbar end triangles (77f3547)
  • allow specifying colorbar height percentage (d327304)

🎨 Refactor

  • use zarr instead of nc for some preprocessed fetch calls (03c89b0)
  • various changes to fetch functions (45837a9)
  • remove all initial region, spacing, and registrations from fetch functions (b9c4203)
  • interactive_map zoom level based on basemap type (06125f5)
  • for southern hemisphere, change default interactive map basemap to Imagery to allow zooming in (ac11744)
  • remove show kwarg of interactive_map (2507c8f)
  • remove clip kwarg from plot_profiles and plot_data and do distance clipping before grd sampling (2f3bed9)
  • require extracting grid info in resample_grid and reorganize function (a38b94b)
  • deprecate xr_grid and grid_file parameters for utils.mask_from_shp and use grid instead (9a2af43)
  • use bedmap2 as default for profiles for speed (41dcb5a)
  • clean up some code and add some debug logging (9240bc8)

v0.9.1 (2025-04-07)

🐛 Bug Fixes

  • update bedmap3 fetch with after registration issue (6cf33ed)
  • update some fetch hashes (f6e4ab7)
  • use updated coord names (35feba1)
  • resample grids if sampling and reg are same, but registration is different (1c1636a)

🧰 Chores / Maintenance

  • reduce sig figs on test_gravity (1005757)
  • update test_bedmap3 (6f69a34)
  • update values for test_bedmap_points (0eec659)
  • add filterwarnings to some tests (b0636e7)

🎨 Refactor

  • change order of some code for clarity (9e315b0)

v0.9.0 (2025-03-31)

🐛 Bug Fixes

  • more informative errors raised in fetch (a94704c)
  • warn in grd2cpt called for points not grid (9b11476)
  • if region not specified and subplotting use existing figure region (d7a8b83)
  • unnecessary kwargs passed to add_colorbar (b4302c4)
  • pass region to add_inset in 'plot_grd' and 'basemap' (958154c)
  • subset GHF points by region during fetch (92a41ad)
  • add defaults for coordinate conversion output column names (66a649b)
  • use assumed coordinate names in reprojections (423ddc5)

🧰 Chores / Maintenance

✏️ Formatting

📖 Documentation

🚀 Features

  • add bedmap3 grids (3bab405)
  • allow extra x and y shift amounts (5bef9ca)
  • allow specifying cbar histogram height with 'cbar_hist_height', independent from 'cbar_yoffset (02ae70d)
  • allow specifying simple basemap colors and pen (c711274)
  • allow setting number of columns in layers legend in profiles with 'layers_legend_columns' (149fbf7)
  • add verbose kwarg for 'add_box' and 'add_colorbar' (92a476d)
  • allow specifying robust percentiles in various functions (f1b62f1)
  • add padding options and more filter types to 'filter_grid' (425aea8)

🎨 Refactor

  • use easting and northing throughout profiles module (82df4f6)
  • use 'easting' and 'northing' instead of 'x' and 'y' throughout code (856e054)
  • bedmap3 as default for profiles (b2fc5d6)
  • determine y shift amount based on what is being plotted. (901be27)
  • set title and frames at beginning of plotting (f2131ab)
  • use separate transparency kwarg for frame and grid (d9ca761)
  • use easting and northing for bedmap points (2ce8510)
  • use warnings instead of logging for some cases (2876442)
  • specify point fill with column name (cd59881)
  • change 'scale_font_color' to 'scalebar_font_color' (18e7b84)
  • use measures-v2 groundingline by default instead of depoorter (07ad14b)
  • rename 'inset_pos' to 'inset_position' and remove 'inset_offset' (52a537f)
  • scalebar and inset length by default relative to shortest dimension (d6acd76)
  • change kwarg 'scale_length_perc' to 'scalebar_length_perc' (4b77be3)
  • change grd_compare defaults to automatically plot and no inset (9d0041b)

v0.8.1 (2025-02-19)

🐛 Bug Fixes

  • update from angular to conventional commits to fix deprecation warning (079a5db)

🧰 Chores / Maintenance

  • update python-semantic-release version (80ecf5a)
  • update semantic release changelog template (ecd6834)
  • wait to deprecate functions till v1.0.0 (ffae0de)
  • fix some tests (c33aadb)
  • update test marks (3b15338)

✏️ Formatting

🎨 Refactor

  • add kwargs for legend labels for coasts and points (20c4d0e)

v0.8.0 (2025-02-19)

🐛 Bug Fixes

  • update to new fetch gravity function (82d0024)
  • fix typos in fetch functions (0b18528)
  • reorder columns in testing reprojection functions (a4d82dd)
  • minor fix in maps (9866e72)
  • fix issue with reprojecting IBCSO coverage data (214bf6f)
  • allow many subplot labels (3a130cf)
  • allow single geometry in mask_from_shp (c231c77)
  • allow showing all columns for points in interactive data (0692a6b)

📦️ Build

  • unpin unnecessary verde version (c9a5c1d)

🧰 Chores / Maintenance

  • disable disallow-caps pre-commit to fix issue (3cfe9a8)
  • mark tests with fetch and earthdata marks (ace576e)
  • fix tests (2453f47)
  • update broken fetch tests (8fbe37c)
  • add tests to profiles module (52db507)
  • add tests for regions module (9a230fc)
  • warn if dataset provided instead of dataarray (fd090af)
  • add debugging logs (a88b76f)
  • make command fix (207535a)
  • update backup env to v0.7.1 (ef1f621)

✏️ Formatting

Other

  • add setuptools to RTD_env to fix issue (ee5178a)

📖 Documentation

  • use new fetch gravity function (281028e)
  • update simple map tutorial (269147a)
  • fix gravity dataset gallery (123f57e)
  • update ibcso coverage notebook (d4a8ebb)
  • update bedmap points gallery (69fd85d)
  • fixes to some docstring (aa7017e)

🚀 Features

  • add range of basemap options (86d2e0d)
  • add region for getz ice shelf (467f5b8)
  • allow resampling during fetching of mass_change and basal_melt (db1f464)
  • add kwargs to all fetch calls to pass to resample_grid (9e60600)
  • add add_simple_basemap plotting function (247c3aa)
  • add points_inside_shp function (e859569)
  • add fetch for bedmap 2 and 3 point data (7cca1a0)
  • add kwargs to pass to resample_grd (0cf71d7)
  • add ice shelf buttressing dataset to fetch (3e6f8b1)
  • allow specifying individual points, reverse_cpt, inset, scalebar for subplots (49e53f9)
  • allow subplot row and column titles (dad1ce5)
  • allow setting transparency in basemap (6a18fb8)
  • add absolute value option and robust percentiles option to get_min_max (490198c)
  • add filter_grid function for filtering grids, add xrft as dependency (c2b2696)
  • add nearest_grid_fill for interpolating grids (80d5f10)
  • add cpt_lims kwarg to grd_compare (31e4735)
  • allow both grids and points in get_min_max and get_combined_min_max (290fdc5)
  • all cmap for points in basemap (908f04b)
  • allow creation of cmap from point values as well as grids values with new points parameter to set_cmap (fa01f54)
  • allow choice of vertical reference and cleanup fetch.ibcso (333a373)

🎨 Refactor

  • change from variable to version in buttressing and basal_melt to be consistent (56af29d)
  • remove compression on zarr files for simplicity (8c8dd5b)
  • setup and use logger instance for polartoolkit (ff1a02a)
  • update gravity fetch (d67d6b7)
  • drop antgg-update and make other gravity fetches return datasets with elevation and error grids (3be3a83)
  • use consistent import of pathlib (2bfd3ef)
  • use tuples instead of lists where applicable (6bc1f20)
  • combine and simplify reprojection functions (6f3ac05)
  • check and use pyogrio for reading coastlines (9702e4d)
  • automatically increase vertical shift between plots if using colorbar histogram (0f0820c)
  • clean up fetch.ibcso_coverage (41da27f)
  • check if pyogrio is installed and use if it is, warn if its not (576db88)

v0.7.1 (2024-12-17)

🐛 Bug Fixes

  • update maps.subplots() to be more user friendly (1f3bc35)
  • raise error if EarthData login doesn't work (1576c00)
  • make region parameter of ibcso_coverage options (0064c05)
  • more special cases with square_subplots (466eb56)
  • raise error if EarthData login fails (4f6762d)
  • bug with plot_profile and plot_data (23bde34)
  • extract previous fig_height for subplots (cb9e93f)
  • re-add test for deepbedmap (c825e67)
  • bad link in fetch mass_change (54b67d1)

🧰 Chores / Maintenance

  • update run docs commands (533dd69)
  • dev install with environment.yml (74b9afd)
  • remove codespell ignore-regrex (6b6affc)
  • remove unused raps and coherency functions (315f562)
  • clean up .py license headers (4853222)
  • update backup yml (a8f7809)
  • add tests for fetch groundingline and antarctic_boundaries (ff7d9a2)

✏️ Formatting

📖 Documentation

  • update install instructions (c2e9845)
  • update and rerun all docs ipynb (0e8e6eb)

🎨 Refactor

  • reduce default number of cbar histogram bins (75543fb)
  • reduce default cbar y offset (04cd3ed)
  • change default vertical origin shift to down instead of up (e3a9e3c)
  • need to specify ais or gris in fetch.mass_change (26ae3d6)
  • remove pyogrio dependency and replace with geopandas (3b4c315)
  • remove matplotlib plotting options, and matplotib and seaborn dependencies (b0458c9)

v0.7.0 (2024-12-03)

🐛 Bug Fixes

  • broken shading parameter in plot_grd (97ec19b)
  • bug in mask_from_shp (b3e3dbc)
  • raise warning if passing buffer to alter_region (be16120)
  • bug in square_subplots (861310c)
  • allow easting and northing as coordinate column names as backups for x and y in sample_grids (8cb9f8a)
  • check for valid version strings in fetch.mass_change (24cd984)

🧰 Chores / Maintenance

  • update make test install commands and instructions (c236a9e)
  • update backup environmental.yml for v0.6.0 (5626d22)

✏️ Formatting

📖 Documentation

🚀 Features

  • add EIGEN gravity data for Arctic (a1b1943)
  • add ice velocity basemap to interactive_map (7f410f8)
  • allow easting and northing as backups for x and y for coord column names in various functions (8f8ae84)
  • add LCS-1 satellite magnetic anomaly grids (3b400f9)

v0.6.0 (2024-11-18)

📦️ Build

  • update backup env yml forv0.5.1 (7a1b984)

🧰 Chores / Maintenance

  • remove ruff commands and use pre-commit (e73a310)

✏️ Formatting

📖 Documentation

  • rerun docs (fba71d7)
  • add commit message convention to contribute guide (959f6f4)
  • add JOSS to citing page (54d8273)
  • fix issue in contrib guide (f776f03)

🚀 Features

  • add ANTGG2021 gravity compilation (f782a85)
  • allow setting y limits in profile plots (894fafb)

v0.5.1 (2024-08-05)

🐛 Bug Fixes

  • restrict geopandas to below v1 until issue with scheme is fixed in next pygmt release (846056e)
  • remove nptyping as a dependency after issues with bool8 (6b97865)

🧰 Chores / Maintenance

v0.5.0 (2024-08-04)

🐛 Bug Fixes

  • add warning for deprecated origin shift parameters (728a218)
  • found bug in utils.square_subplots (f87f2e1)
  • drop band and spatial_ref variables from fetched grids (40f6ba2)

📦️ Build

🧰 Chores / Maintenance

  • add test deps to conda_install for testing conda releases (0cc2da2)
  • updates from learn-scientific-python (07d79a9)
  • update binder env with polartoolkit v0.4.0 (47ff400)

✏️ Formatting

📖 Documentation

  • fix issues with autoapi and typehints (51f4266)
  • rerun all doc notebooks (1c0fcb3)
  • minor corrections to docs (64ee497)
  • reduce notebook size with pygmt dpi parameter (46aadb8)
  • add make setup instructions to contrib guide (18fe9cf)
  • remove install info from readme (09ef175)
  • typos in notebook (d539795)
  • fix missing instruction in contrib guide (8128a8f)
  • move contrib guide into docs/ (3001032)
  • update license to 2024 for source files (127b173)
  • add citation info (d1281da)
  • update docs with numbered tutorials and other fixes (fdb7227)
  • point binder link to tutorials (3fddb27)

🚀 Features

  • add 'easting' and 'northing' as defaults for plotting points (13b917b)
  • add earthaccess dependency and use for login credentials (1b87ca8)

🎨 Refactor

  • organize plot_grd and enable more mapping features for basemap (684e86e)
  • remove kwargs for add_gridlines (e86144d)
  • 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)

  • mock import geopandas (ab3437d)
  • use figshare sample shapefiles and remove data/ from repo (de684bb)
  • remove quotes from scalebar (7995f9f)

Other

v0.4.0 (2024-06-14)

🐛 Bug Fixes

  • fix deprecated test measures boundaries (6f3cc23)
  • fix deprecated test alter region (eaad9c8)
  • fix fetch ice vel issue (02bf5e4)
  • remove hash from mass_change (54cfe1b)
  • fix tests for deprecations (890bc21)
  • remove alter region from get_regions (ab009d4)
  • properly set default region in basemap (f5ca3da)
  • specify hemisphere in bedmap2 reference test (fd4e668)
  • for bedmachine grids, restore correct registration type and only resample after geoid added to grids (bf600b4)
  • remove fetch basement due to limited spatial extent of data (4cfc9e5)
  • remove support for fetch ROSETTA grav and mag to align with goal of only providing common and widespread datasets (cc8d2af)
  • update warning about grid region extract in plot_3d (b9be0ae)
  • update figure shifting of plot_3d (2ff91d3)
  • warning about histogram if grid is constant value (7d7647b)
  • improve creation of colormap (25ea3b5)
  • correctly center interactive map (f0f5887)
  • change greenland region slightly (6953ce0)
  • load deepbedmap instead of returning string (6840639)
  • remove faulty layer name from fetch bedmachine (78a9879)

📦️ Build

  • move deprecation from dev to normal dependencies (4a83f67)
  • add deprecation package to dev deps (ac04b0d)
  • include environment.yml file as backup for issues with installing (8ef681f)
  • set min pylint version (a93d83a)
  • explicitly specify tqdm as dependency (287a4db)

🧰 Chores / Maintenance

  • enable caching of test CI environment (f374dd2)
  • switch CI from mini-conda to micromamba (69d182d)
  • remove pip local install in testing CI (563f98e)
  • don't run fetch calls during test

This should drastically speed up testing, not overload GHA with downloading datasets, but means testing of fetch calls will need to be performed manual by deleting the local pooch cache and rerun all fetch calls / tests. (090f239)

  • add fetch mark to some tests (2f5771c)
  • mark some tests as earthdata (bacb0fa)
  • add codecov token (b05c119)
  • add deprecation to old fetch measures boundaries function (262a0c2)
  • add deprecations to old fetch modis functions (7c5461e)
  • update fetch mass change test (9b2c282)
  • exclude some md files from pre-commit (e4acbeb)
  • update use of pylint (c886573)
  • update tests for bedmachine with reference change (c1200ca)
  • pre-commit autoupdate to monthly (1f977cc)
  • fix test (4ac5e0b)
  • misc fixes (699c02f)
  • add greenland coast version to plotting functions (9dc125b)
  • change arg image to modis (677b13e)
  • change default profile map cmap (c9396ac)
  • don't run tests on docs or style commits (8440e6f)
  • add tests for regions (77ea6f8)
  • update ruff version in pre-commit (e13c0d9)
  • cleanup Make commands (eeab8f6)
  • increase timeout for test shen moho (c769215)
  • remove pre-commit updates from changelog (611ff84)

✏️ Formatting

📖 Documentation

  • typo and readme update (c0ffc0c)
  • spelling mistake (5fe90e5)
  • add logo to README (b710923)
  • rerun all dataset gallery notebooks (35851b9)
  • major overhaul of docs structure to follow the Divio system (bbe3975)
  • merge arctic and greenland dataset gallery (55abdf2)
  • add missing links (a8d0af5)
  • add instructions for EarthData login (18e5581)
  • add release instructions to contributing guide (04d3ac2)
  • consolidate and update install instructions (399ba89)
  • rerun notebooks (c5fe426)
  • clarify all mentions of format of region tuples (1e8c09f)
  • clarify project scope and goals (11ef365)
  • add rosetta grav/mag to gallery datasets (690e747)
  • add measures ice boundaries to dataset gallery (60db1c9)
  • add basal melt rate to dataset gallery (02ee6f7)
  • add geomap geology to dataset gallery (4277b7c)
  • add groundline to dataset gallery (39b142e)
  • add mass change to dataset gallery (0476df2)
  • add magnetics to dataset gallery (f0cadd9)
  • add ice velocity to dataset gallery (3e8a022)
  • add gravity to dataset gallery (80d1a6c)
  • add GIA to dataset gallery (5e2eced)
  • use full citations in dataset gallery (df634ba)
  • add GHF to dataset gallery (95826c1)
  • rerun notebook (2c44c08)
  • add modis mog to index (2a041a8)
  • rerun all docs (9984c8d)
  • add more dataset notebooks (4526aab)
  • edit some docstrings (66a1ef5)
  • reorganize available dataset gallery (99ac4a2)
  • add more dataset notebooks (41908f0)
  • update references (520823f)
  • mention dataset gallery in fetch walkthrough (d6387b3)
  • add bedmachine dataset notebook (2651e46)
  • update bedmap2 dataset notebook (1dee9e9)
  • update dataset gallery template (1d100c3)
  • add available dataset gallery (7932719)
  • conform fetch walkthrough to standard figure creation style (a740223)
  • switch binder env to separate repo, remove launch buttons (921f091)
  • try nbgitpull link for launch binder buttons (5ca4de9)
  • fix issues with subplot_layout example (9e46dbd)
  • remove python version and nodefaults from binder env (9c46665)
  • simplify binder env (8e2c8ed)
  • update contributing guide (777b662)
  • reuse readme material in RTD index (8791e96)

🚀 Features

  • add points option to basemap (474cde7)
  • add region_ll_to_xy function (31b054c)
  • add ice velocity for Greenland (9ad6fe7)
  • add etopo data for the arctic/greenland (2910e30)
  • add mass change for Greenland (56bd01a)
  • enable greenland support for profiles (548f626)
  • add function to extract default hemisphere (b8b4f0a)
  • add geoid for Greenland and change geoid region for Antarctica (4987e0b)
  • add bedmachine data from Greenland (cfa5fff)
  • add cbar_labels kwarg to plot_3d (9d26d06)
  • add cbar_perspective arg to plot_3d (25f1bf7)
  • enable passing single grid to plot_3d (b71001a)
  • add function for combined min max of several grids (6d3c294)
  • allow passing .cpt file to colorbar histogram (e633789)
  • add inset map option for greenland (5d36db4)
  • add hemisphere arg to most plotting functions

BREAKING CHANGE: this alters a vast majority of the code! (05cb358)

  • add subset grid function (ab2e60a)
  • add BAS greenland groundingline (d29863e)
  • add pen kwarg to show_region (308eac0)
  • add fetch MODIS Greenland (3e78b8e)
  • add some Greenland regions (29fa593)
  • add Arctic/Greenland to utils/maps (503b6a1)

🎨 Refactor

  • change module name from profile to profiles to match plural style of other modules.

BREAKING CHANGE: please update all import statements to use profiles instead of profile! (84524e3)

  • update deprecated pandas delim_whitespace (f70476a)
  • move alter_region from utils to regions (f95ced0)
  • combine fetch modis_moa and modis_mog to modis

BREAKING CHANGE: make sure to update your code to use the new function fetch.modis() and specify MoG vs MoA with parameter hemisphere = "south" or "north" (89e50d2)

  • add hemisphere and remove kwargs from call to geoid (db5241e)
  • remove unnecessary verbose and kwargs for some fetches (fdab8fe)
  • log info instead of error in mask_from_shp (fd2e768)
  • use environment variable for setting hemisphere in profile (3be6d86)
  • if available, use environmental variables for setting hemisphere throughout code

To utilize this feature, either set a system environment variable POLARTOOLKIT_HEMISPHERE equal to either south or north, or in your python file/notebook use os.environ to set this value for the current session. (d756838)

  • rename fetch measures_boundaries to antarctic_boundaries

BREAKING CHANGE: make sure to update your code with the new function name! (6951fe2)

  • use new set_cmap function in plot_3d (1e68076)
  • set cbar position in plot_3d (ecf53cf)
  • changed default shading to false in plot_3d (7e4feed)
  • remove default vlims for plot_3d (3f59d10)
  • change default point color in plot_profile (e895aed)
  • update np random number generator (0daaffc)

Other

v0.3.3 (2024-04-23)

🐛 Bug Fixes

  • pinning issue in workflow (1578894)

📦️ Build

  • make semantic release GHA need changelog success (adf7edb)

🧰 Chores / Maintenance

  • pin python semantic release version (73a0fbd)

v0.3.2 (2024-04-23)

🐛 Bug Fixes

  • reduce accuracy check for test resampling grids (93fca6f)

📦️ Build

🧰 Chores / Maintenance

  • fix semantic release action (6b12799)

v0.3.1 (2024-02-22)

🐛 Bug Fixes

  • increase timeout for shen-2018 moho fetch (8d9e183)
  • delete tmp.nc file in fetch call (ee16bdc)

📦️ Build

  • extend support to python 3.12 (f68def9)

🧰 Chores / Maintenance

  • remove shen-2018 hash (fbefe40)
  • fix test ghf (c7c66f6)
  • update changelog template (e4bd1d9)
  • reduce sig figs for test_ghf (393aadc)
  • list packages after installing local for test GHA (51250b4)
  • update testing_env and add make command (4ee6945)
  • add hashes to all fetch calls (91eb9a8)
  • move contributing file (05dff10)
  • add test_fetch make command (2a0adb3)
  • add ignores to pre-commit (3fffd15)
  • fix changelog template spacing (cabc14a)

📖 Documentation

  • update install instructions (70faf04)
  • fix links to contrib guide (5c6af8d)

v0.3.0 (2024-02-18)

📦️ Build

  • add requests to deps (15ea6e8)
  • switch GHA from hynek to build and twine (91c6ca9)
  • explicitly include packages (a76a0e9)

🧰 Chores / Maintenance

  • ignore auto update changelog commits in changelog (01a092e)
  • mark test mass change as issue (a3bde43)
  • add issue marker to imagery and basal melt fetches (95bce69)
  • make fig an arg of plot_grd (e762a5a)
  • add kwarg arg to add_scalebar (df374ba)
  • specify args in functions (9febc0e)
  • remove dependa-bot commits from changelog (44a322c)
  • fix _static path warning (257f6e7)
  • add skip ci to changelog commit message (6b665ae)
  • update changelog an main pushes (2dca0fc)
  • editing workflows (a059f50)
  • collect usage stats (b5d16ac)

✏️ Formatting

📖 Documentation

  • update RTD links to polartoolkit (e5376b3)
  • fix disclaimer (8075024)
  • re-run all docs (0776879)
  • add pygmt and pip to RTD.env (9a8ae51)
  • back to conda for RTD (d2a4c1f)
  • switch RTD from mamba to python (aeab560)
  • switch RTD from conda to pip (18cf7fb)
  • update RTD env and instructions (f142c6d)
  • remove JOSS folder (dc0a421)
  • add .bib and enable sphinxcontrib-bibtex (bf90dc0)
  • add paper template for JOSS (22feca3)

🚀 Features

  • add plotting geomap faults function (3e87e60)
  • add cmap arg to points of plot_grd (f4fc948)
  • add basemap imagery option to plot_grd (b7ad2ee)
  • make default scalebar have white box (3c879d5)
  • add water thickness layer to bedmap2 fetch (8f26e46)
  • add / update pre-defined regions (4ce3d8d)

v0.2.1 (2024-01-29)

🐛 Bug Fixes

  • add "+ue" unit to regions in meters for lat long projections (fa67b53) # codespell:ignore ue
  • fixes lines between layers in cross-sections (7eaaf64)
  • fix pandas copy warning (48ce7a7)

📦️ Build

  • add antarctic_plots package for import warning (bb4c134)
  • add lower version limit to PyGMT (4f3a837)

✏️ Formatting

📖 Documentation

  • clicking on logo directs to homepage (841e9e5)
  • rerun notebooks (eb5e47d)
  • update binder env, links, and codecov link (4854853)

v0.2.0 (2024-01-26)

📦️ Build

🧰 Chores / Maintenance

✏️ Formatting

📖 Documentation

  • update descriptions to not only focus on Antarctica (b08a509)
  • add favicon and dark and light logos (77f9835)
  • add logo to docs (c26f850)
  • fix changelog template (31083e3)

🎨 Refactor

  • force a major version bump.

BREAKING CHANGE: (cc2ecda)

v0.1.0 (2023-12-10)

🐛 Bug Fixes

  • change default layer names in profile (801611f)
  • avoid resampling default layers for profile (1f75666)
  • warning for resampling default layers (543fe60)
  • issue with plot_grd cpt_lims (548da1d)
  • fixing self imports (3e806df)
  • switch module import style (c61552a)
  • fixing typing cast (0405ad3)
  • specify kwargs to shorten function (acaf8d9)
  • increase default colorbar font size (fc86e93)
  • various fixes to fetch.py

leftover fixes after refactoring code to pass new formatting / linting / type checking procedures (4da7fc1)

  • various fixes to maps.py

leftover fixes after refactoring code to pass new formatting / linting / type checking procedures (6b7b25c)

  • various fixes to utils.py

leftover fixes after refactoring code to pass new formatting / linting / type checking procedures (02d105d)

  • various fixes to profile.py

leftover fixes after refactoring code to pass new formatting / linting / type checking procedures (aa43a85)

  • various fixes to regions.py

leftover fixes after refactoring code to pass new formatting / linting / type checking procedures (4f732aa)

  • change default layer pen to black (b2c1e74)
  • change default inset region box to red (627b2bd)

📦️ Build

🧰 Chores / Maintenance

  • reduce sig figs of fetch tests (15e5c3d)
  • match test env to pyproject (155f1cf)
  • switch python 3.8 to 3.9 for CI testing (1a17424)
  • exclude some tests for CI (ac535d9)
  • update binder env and links (fe80114)
  • type checking fixes (6ec45e1)
  • update changelog template (1418eb8)
  • add refactor to changelog template (8738126)
  • add mypy to dev deps (8102792)
  • add mypy make command (ed80102)
  • add run_notebook make command (1272361)
  • add types-request to mypy (6e14d17)
  • ignore contrib guide in pre-commit (be24667)
  • remove RTD mock imports (80d6d0f)
  • remove dynamic version (53f018b)
  • update license notice file (c51b7b1)
  • add changelog template (855691e)
  • update project urls (4cf10f8)
  • switches version management system

changes from setuptools_scm to python-semantic-release (46df13d)

✏️ Formatting

📖 Documentation

🚀 Features

  • add grd2cpt and shading to profile map (2440c27)
  • add spacing option to default layers (69d72f4)
  • add lake vostok region (69b5ff6)
  • pass scalebar kwargs to plot_grd (e733241)
  • add get_fetches function (b0312c2)

🎨 Refactor

  • fix issues with fetch tests

swaps pytest.approx with DeepDiff, adds ignore RuntimeWarning to many tests. (3b1bf49)

  • switch regions from lists to tuples (65d7d92)
  • update optional deps import check (9926a59)
  • standardize preprocessing calls

increments filename variables since they change type, and standardizes the format of the preprocessors. (4f5656f)

Other

Note: 🚨 Everything above this point was generated automatically by Python Semantic Release. Everything below is from prior to the implementation of Python Semaintic Release. 🚨

Between v0.0.6 and v0.1.0

💫 Highlights

  • dropped support for Python 3.8 in PR #140
  • several new datasets!
  • added robust option to get_min_max(), and mapping functions
  • lots of new customization options (kwargs) for plotting functions
  • several bug fixes

🚀 Features

New datasets in Fetch

  • Ice Mass Changes from Smith et al. 2020
  • Basal Melt Rates from Adusumulli et al. 2020
  • Faults and geologic unit shapefiles from GEOMAP (Cox et al. 2023)
  • ADMAP-2 magnetics compilation
  • ROSETTA-Ice airborne magnetics for the Ross Ice Shelf from Tinto et al. 2019
  • BedMachine updated to v3

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

Release v0.0.6

💫 Highlights

  • Switched from Poetry to Setuptools
  • Can install with conda
  • Eased the dependency constraints

⛔ Maintenance

  • renamed various util functions

🧑‍🤝‍🧑 Contributors

@mdtanker

Release v0.0.4

💫 Highlights

  • New mapping function antarctic_plots.maps
  • Pre-set regions for commonly plotted areas
  • Added Gallery examples
  • Created a Binder environment
  • More datasets included in fetch

🚀 Features

New module Maps

  • plot_grd

New datasets in Fetch

  • bedmachine
  • geothermal

New functions in Utils

  • alter_region
  • coherency
  • grd_compare
  • grd_trend
  • make_grid
  • raps
  • set_proj

📖 Documentation

  • Added Tutorials and Gallery examples to the docs
  • Added tutorial for modules fetch and region

⛔ Maintenance

  • Closed Issue #6: Create gallery examples
  • Closed Issue #9: Code formatting
  • Closed Issue #13: Specify dependency version
  • Closed Issue #15: Add inset map of Antarctica
  • Closed Issue #16: Add Welcome Bot message to first time contributors
  • Closed Issue #20: Add options to use the package online
  • Closed Issue #25: Add GHF data to fetch module
  • Closed Issue #26: Add BedMachine Data to fetch
  • Closed Issue #27: fetch.bedmap2 issue with xarray
  • Closed Issue #28: Set region strings for commonly plotted areas
  • Closed Issue #22: Create Zenodo DOI

🧑‍🤝‍🧑 Contributors

@mdtanker

Release v0.0.3

💫 Highlights

  • Finally succeeded in building the docs!

📖 Documentation

  • Added make build-docs to execute and overwrite .ipynb to use in docs, since PyGMT can't be included in dependencies and therefore RTD's can't execute the .ipynb's.

⛔ Maintenance

🧑‍🤝‍🧑 Contributors

@mdtanker

Release v0.0.2

💫 Highlights

  • Created a website for the documentation!

  • Added NumPy formatted docstrings to the modules

  • Wrote contribution guide, which outlines the unique case of publishing a package with dependencies which need C packages, like PyGMT (GMT) and GeoPandas (GDAL).

  • Added Tips for generating shapefiles and picking start/end points

📖 Documentation

  • Re-wrote docstrings to follow NumPy format.
  • Added type-hints to docstrings.

⛔ Maintenance

🧑‍🤝‍🧑 Contributors

@mdtanker

Release v0.0.1

💫 Highlights

  • also probably should have been published to TestPyPI 🤦♂️

🚀 Features

  • Added a Makefile for streamlining development, publishing, and doc building.
  • Added license notifications to all files.

📖 Documentation

  • Used Jupyter-Book structure, with a table of contents (_toc.yml) and various markdown files.
  • added Sphinx.autodoc to automatically include API documentation.

⛔ Maintenance

  • Looks of issues with the Poetry -> Jupyter-Books -> Read the Docs workflow
  • Poetry / RTD don't like PyGMT or GeoPandas since they both rely on C packages which can't be installed via pip (GMT and GDAL). Next release should fix this.

🧑‍🤝‍🧑 Contributors

@mdtanker

Release v0.0.0

  • 🎉 First release of Antarctic-plots 🎉

  • should have been published to TestPyPI 🤦♂️

🧑‍🤝‍🧑 Contributors

@mdtanker