PolarToolkit

Helpful tools for polar researchers

Documentation Link

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

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, MODIA MoA), create maps and plots specific to Antarctica (soon Greenland and the Arctic as well), and visualize data with multiple methods.

Feel free to use, share, modify, and contribute to this project. I've mostly made this for personal usage so expect significant changes. Hopefully, I'll implement more tests and Gallery examples soon.

Project goals

Below is a list of some features I hope to eventually include. Feel free to make a feature request through GitHub Issues.

• Create 3D interactive models to help visualize data.
• Include more datasets to aid in downloading and storage.
• Additional projections and possible support for the Arctic region as well.

How to contribute

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

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.