mdtanker / polartoolkit

Helpful tools for polar researchers
http://polartoolkit.readthedocs.io/
MIT License
37 stars 5 forks source link
antarctica arctic bedmachine bedmap cryosphere gmt greenland jupyter-notebook plotting polar profiles pygmt python

polartoolkit logo

Helpful tools for polar researchers

Documentation Link

PolarToolkit (formerly known as Antarctic-Plots) is a Python package to make polar (i.e. Antarctic, Arctic, Greenland) research more efficient, reproducible, and accessible. The software does this by providing:

Binder link

Latest version on PyPI Latest version on conda-forge Test coverage status

Compatible Python versions. Zenodo DOI Documentation Status

Disclaimer

🚨 **Ready for daily use but still changing.** 🚨

This means that we are still adding a lot of new features and sometimes we make changes to the ones we already have while we try to improve the software based on users' experience, test new ideas, make better design decisions, etc. Some of these changes could be backwards incompatible. Keep that in mind before you update PolarToolkit to a new major version (i.e. from v1.0.0 to v2.0.0) and always check the Changelog for BREAKING CHANGES and how to update your code appropriately.

I welcome any feedback, ideas, or contributions! Please contact us on the GitHub discussions page or submit an issue on GitHub for problems or feature ideas.

The PolarToolkit python package provides some basic tools to help in conducting polar research. You can use it to download common datasets (i.e. BedMachine, Bedmap2, MODIS Mosaics), create maps and plots specific to Antarctica, Greenland and the Arctic and visualize data with multiple methods.

Feel free to use, share, modify, and contribute to this project.

What PolarToolkit is for:

What PolarToolkit is NOT for:

How to contribute

I welcome all forms of contribution! If you have any questions, comments or suggestions, please open a discussion or issue (feature request)!

Also, please feel free to share how you're using PolarToolkit, I'd love to know.

Please, read our Contributor Guide to learn how you can contribute to the project.