Changelog#
Automatically updated by python-semantic-release with commit parsing of conventional commits.
v0.9.1 (2025-04-07)#
π Bug Fixes#
π§° Chores / Maintenance#
π¨ 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#
quotes error (
d5fe11a)
π 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 specifing 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 seperate 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_comparedefaults 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#
βοΈ Formatting#
empty line (
defa73e)
π¨ 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#
π Features#
add range of basemap options (
86d2e0d)add region for getz ice shelf (
467f5b8)allow resampling during fetching of
mass_changeandbasal_melt(db1f464)add kwargs to all fetch calls to pass to
resample_grid(9e60600)add
add_simple_basemapplotting function (247c3aa)add
points_inside_shpfunction (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_gridfunction for filtering grids, add xrft as dependency (c2b2696)add
nearest_grid_fillfor interpolating grids (80d5f10)add cpt_lims kwarg to
grd_compare(31e4735)allow both grids and points in
get_min_maxandget_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
pointsparameter toset_cmap(fa01f54)allow choice of vertical reference and cleanup
fetch.ibcso(333a373)
π¨ Refactor#
change from
variabletoversioninbuttressingandbasal_meltto 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_coverageoptions (0064c05)more special cases with
square_subplots(466eb56)raise error if EarthData login fails (
4f6762d)bug with
plot_profileandplot_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
rapsandcoherencyfunctions (315f562)clean up .py license headers (
4853222)update backup yml (
a8f7809)add tests for fetch
groundinglineandantarctic_boundaries(ff7d9a2)
βοΈ Formatting#
π Documentation#
π¨ 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
aisorgrisinfetch.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#
βοΈ Formatting#
π Documentation#
π Features#
v0.6.0 (2024-11-18)#
π¦οΈ Build#
update backup env yml for
v0.5.1(7a1b984)
π§° Chores / Maintenance#
remove ruff commands and use pre-commit (
e73a310)
βοΈ Formatting#
pre-commit fixes (
7514e3a)
π Documentation#
π Features#
v0.5.1 (2024-08-05)#
π Bug Fixes#
π§° Chores / Maintenance#
v0.5.0 (2024-08-04)#
π Bug Fixes#
π¦οΈ Build#
π§° Chores / Maintenance#
βοΈ Formatting#
π Documentation#
fix issues with autoapi and typehints (
51f4266)rerun all doc notebooks (
1c0fcb3)minor corrections to docs (
64ee497)reduce notebook size with pygmt
dpiparameter (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#
π¨ Refactor#
organize
plot_grdand enable more mapping features forbasemap(684e86e)remove kwargs for
add_gridlines(e86144d)change
origin_shiftparameter 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)
Other#
(
4424866)
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#
π§° 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
imagetomodis(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#
auto style fixes (
3c3e155)style fixes (
2022c6d)fix cmap issues in plot_profile (
4492445)ignore pylint warnings (
63e23a5)auto fixes (
52ac789)fixes for pylint (
bf9c1cd)auto style fix (
120e634)auto style fixes (
b12c877)add typing to function (
51e25a9)fix regions test styling (
a8d9628)reformat with new ruff version (
363f8fa)auto style fixes from ruff/pylint (
e1efbab)
π 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)
π¨ Refactor#
change module name from
profiletoprofilesto 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_moaandmodis_mogtomodis
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_boundariestoantarctic_boundaries
BREAKING CHANGE: make sure to update your code with the new function name! (6951fe2)
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#
π¦οΈ 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#
v0.3.0 (2024-02-18)#
π¦οΈ Build#
π§° 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#
v0.2.1 (2024-01-29)#
π Bug Fixes#
π¦οΈ Build#
βοΈ Formatting#
π Documentation#
v0.2.0 (2024-01-26)#
π¦οΈ Build#
π§° Chores / Maintenance#
βοΈ Formatting#
formatting (
d15fe92)
π Documentation#
π¨ 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)
π¦οΈ 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)
add pylint config (
91dfa92)add ruff config (
5688ab9)add mypy config (
cd1805b)move regions to src (
c22281f)move utils to src (
39e477d)move profile to src (
0c6a014)move maps to src (
e2e561d)move fetch to src (
5a915b6)move init to src (
d3f229f)remove test init (
a381570)add github/matchers file (
99ed168)pre-commit ignore .github files (
ffb36c9)add noxfile (
6cac09d)update makefile (
d619207)add pre-commit config (
8c33642)update gitignore (
5912c52)move tests outside src (
e7b30e9)
βοΈ Formatting#
π Documentation#
update notebooks (
7851e53)rerun gallery examples (
3c6f4c0)rerun tutorials (
e61324a)update cover_fig (
1377bf0)fixes small issues (
e8339ed)add/fix all docstrings (
7c670d9)setup nbgallery for docs (
48f061a)update contrib guide (
69663f9)update README and index (
fea2b09)remove notebook output files (
4a8c78b)add module descriptions to overview (
92edec5)pin RTD python version (
f25810d)move changelog (
50c5439)add citing, overview, references (
f27a893)rename tutorials.md (
5134420)rename gallery.md (
4371781)update api docs with template (
116f06e)rename install file (
4b97d66)switch docs theme (
c1a5d5a)move contrib guide (
d4e47ca)combine index and readme (
1f4bfc1)change RTD config (
e17be26)
π Features#
π¨ 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)
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
robustoption to get_min_max(), and mapping functionslots 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 toplot_grd()with keywordadd_north_arrowfixed issues with clipping of grid for plotting colorbar histogram
π§βπ€βπ§ Contributors#
Release v0.0.6#
π« Highlights#
Switched from Poetry to Setuptools
Can install with conda
Eased the dependency constraints
β Maintenance#
renamed various util functions
π§βπ€βπ§ Contributors#
Release v0.0.4#
π« Highlights#
New mapping function
antarctic_plots.mapsPre-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
TutorialsandGallery examplesto the docsAdded tutorial for modules
fetchandregion
β 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#
Release v0.0.3#
π« Highlights#
Finally succeeded in building the docs!
π Documentation#
Added
make build-docsto execute and overwrite .ipynb to use in docs, sincePyGMTcanβt be included in dependencies and therefore RTDβs canβt execute the .ipynbβs.
β Maintenance#
Closed Issue #7
π§βπ€βπ§ Contributors#
Release v0.0.2#
π« Highlights#
Created a website for the documentation!
Added
NumPyformatted docstrings to the modulesWrote contribution guide, which outlines the unique case of publishing a package with dependencies which need C packages, like
PyGMT(GMT) andGeoPandas(GDAL).Added
Tipsfor generating shapefiles and picking start/end points
π Documentation#
Re-wrote docstrings to follow
NumPyformat.Added type-hints to docstrings.
β Maintenance#
π§βπ€βπ§ Contributors#
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-Bookstructure, with a table of contents (_toc.yml) and various markdown files.added
Sphinx.autodocto automatically include API documentation.
β Maintenance#
Looks of issues with the Poetry -> Jupyter-Books -> Read the Docs workflow
Poetry / RTD donβt like
PyGMTorGeoPandassince they both rely on C packages which canβt be installed via pip (GMTandGDAL). Next release should fix this.
π§βπ€βπ§ Contributors#
Release v0.0.0#
π First release of Antarctic-plots π
should have been published to TestPyPI π€¦βοΈ