Skip to content

Latest commit

 

History

History
758 lines (654 loc) · 66.5 KB

CHANGELOG.md

File metadata and controls

758 lines (654 loc) · 66.5 KB

Changelog

Automatically updated by python-semantic-release with commit parsing of angular commits.

Unreleased

🧰 Chores / Maintenance

  • update backup env to v0.7.1 (ef1f621)

Other

  • add setuptools to RTD_env to fix issue (ee5178a)

✏️ Formatting

v0.7.1 (2024-12-17)

🧰 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)

📖 Documentation

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

🐛 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)

🎨 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)

✏️ Formatting

v0.7.0 (2024-12-03)

🧰 Chores / Maintenance

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

📖 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)

🐛 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)

✏️ Formatting

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)

📖 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)

✏️ Formatting

v0.5.1 (2024-08-05)

🧰 Chores / Maintenance

🐛 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)

v0.5.0 (2024-08-04)

💥 Breaking Changes

  • 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)

📦️ Build

🧰 Chores / Maintenance

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

📖 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)

🐛 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)

🎨 Refactor

  • organize plot_grd and enable more mapping features for basemap (684e86e)
  • remove kwargs for add_gridlines (e86144d)
  • mock import geopandas (ab3437d)
  • use figshare sample shapefiles and remove data/ from repo (de684bb)
  • remove quotes from scalebar (7995f9f)

✏️ Formatting

Other

v0.4.0 (2024-06-14)

💥 Breaking Changes

  • 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)

  • 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)

  • rename fetch measures_boundaries to antarctic_boundaries

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

  • add hemisphere arg to most plotting functions

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

📦️ 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)

📖 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 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)

🐛 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)

🎨 Refactor

  • update deprecated pandas delim_whitespace (f70476a)
  • move alter_region from utils to regions (f95ced0)
  • 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)

  • 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)

✏️ Formatting

Other

v0.3.3 (2024-04-23)

📦️ Build

  • make semantic release GHA need changelog success (adf7edb)

🧰 Chores / Maintenance

  • pin python semantic release version (73a0fbd)

🐛 Bug Fixes

  • pinning issue in workflow (1578894)

v0.3.2 (2024-04-23)

📦️ Build

🧰 Chores / Maintenance

  • fix semantic release action (6b12799)

🐛 Bug Fixes

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

v0.3.1 (2024-02-22)

📦️ 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)

🐛 Bug Fixes

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

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)

📖 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)

✏️ Formatting

v0.2.1 (2024-01-29)

📦️ Build

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

📖 Documentation

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

🐛 Bug Fixes

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

✏️ Formatting

v0.2.0 (2024-01-26)

💥 Breaking Changes

  • force a major version bump.

BREAKING CHANGE: (cc2ecda)

📦️ Build

🧰 Chores / Maintenance

📖 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)

✏️ Formatting

v0.1.0 (2023-12-10)

📦️ 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)

📖 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)

🐛 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)

🎨 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 variabls since they change type, and standardizes the format of the preprocessors. (4f5656f)

✏️ Formatting

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