Changelog
Contents
Changelog#
Unreleased#
π« Highlights#
Added rioxarray as dependency
Added
utils.mask_from_shp
gallery example
π Features#
New module Maps
#
New datasets in Fetch
#
New functions in Utils
#
π Documentation#
β Maintenance#
π§βπ€βπ§ Contributors#
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
andGallery examples
to the docsAdded tutorial for modules
fetch
andregion
β Maintenance#
Closed Issue #6: Create gallery examples
Closed Issue #9: Code formating
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-docs
to execute and overwrite .ipynb to use in docs, sincePyGMT
canβ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
NumPy
formatted 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
Tips
for generating shapefiles and picking start/end points
π Documentation#
Re-wrote docstrings to follow
NumPy
format.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-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
orGeoPandas
since they both rely on C packages which canβt be installed via pip (GMT
andGDAL
). Next release should fix this.
π§βπ€βπ§ Contributors#
Release v0.0.0#
π First release of Antarctic-plots π
should have been published to TestPyPI π€¦βοΈ