<p align="center"> <img src="docs/logo_dark.png" alt="polartoolkit logo" width="200"/> </p> <h2 align="center">Helpful tools for polar researchers</h2> <p align="center"> <a href="https://polartoolkit.readthedocs.io"><strong>Documentation Link</strong></a> </p> <!-- SPHINX-START-proj-desc -->

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

• convenient functions for downloading and pre-processing a wide range of commonly used polar datasets
• tools for common geospatial tasks (i.e. changing data resolution, subsetting data by geographic regions)
• code to easily create publication-quality maps, data profiles, and cross-sections
• a means to interactively explore datasets

<!-- SPHINX-END-proj-desc --> <!-- SPHINX-START-badges --> <p align="center"> <a href="https://mybinder.org/v2/gh/mdtanker/polartoolkit-binder/main?urlpath=git-pull%3Frepo%3Dhttps%253A%252F%252Fgithub.com%252Fmdtanker%252Fpolartoolkit%26urlpath%3Dtree%252Fpolartoolkit%252Fdocs%252Ftutorial%26branch%3Dmain"> <img src="https://mybinder.org/badge_logo.svg" alt="Binder link"></a> </p> <p align="center"> <a href="https://pypi.python.org/pypi/polartoolkit"><img src="https://img.shields.io/pypi/v/polartoolkit?style=flat-square" alt="Latest version on PyPI"/></a> <a href="https://github.com/conda-forge/polartoolkit-feedstock"><img src="https://img.shields.io/conda/vn/conda-forge/polartoolkit.svg?style=flat-square"alt="Latest version on conda-forge"/></a> <a href="https://codecov.io/gh/mdtanker/polartoolkit"><img src="https://img.shields.io/codecov/c/github/mdtanker/polartoolkit/main.svg?style=flat-square" alt="Test coverage status"/></a> </p> <p align="center"> <a href="https://pypi.org/project/polartoolkit/"><img src="https://img.shields.io/pypi/pyversions/polartoolkit?style=flat-square" alt="Compatible Python versions."/></a> <a href="https://zenodo.org/badge/latestdoi/475677039"><img src="https://zenodo.org/badge/475677039.svg?style=flat-square" alt="Zenodo DOI"/></a> <a href='https://readthedocs.org/projects/polartoolkit/'><img src='https://readthedocs.org/projects/polartoolkit/badge/?version=latest&style=flat-square' alt='Documentation Status' /></a> </p> <p align="center"> <a href="https://scientific-python.org/specs/spec-0000/"><img src="https://img.shields.io/badge/SPEC-0-green?labelColor=%23004811&color=%235CA038)" alt="SPEC 0 — Minimum Supported Dependencies"/></a> </p> <!-- SPHINX-END-badges -->

Disclaimer

<p align="center"> 🚨 **Ready for daily use but still changing.** 🚨 </p>

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.

<!-- SPHINX-START-long-desc -->

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, Bedmap, 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:

• download commonly used datasets related to Antarctica, Greenland and the Arctic
• making publication-quality maps and cross-sections, with some limited support outside of polar regions
• interactively explore data and define geographic regions
• plotting and working with data in projected coordinates (meters) in either EPSG 3031 or 3413, for the South and North hemispheres, respectively
• mostly focused on regularly gridded (interpolated) datasets, with some support for discrete (un-gridded) data
• current focus for datasets is related to ice, geophysics, and earth properties since this is where my personal research interests are, but please request or add your own types of data!
• basic geospatial manipulations (filtering, resampling, reprojecting, masking etc.)

What PolarToolkit is not for:

• downloading niche datasets or those that only cover specific regions
• downloaded datasets outside of Antarctica, Greenland and the Arctic
• plotting and working with data in geographic (latitude and longitude) coordinates
• plots not related to geospatial data
• a point-and-click GUI for plotting or data exploration -> see Quantarctica or QGreenland
• complex geospatial processing -> see PyGMT, Verde, Geopandas or Rasterio

<!-- SPHINX-END-long-desc -->

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.