Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

polartoolkit

A Python package with the goal of making Polar (i.e. Antarctic, Arctic, Greenland) research more efficient, reproducible, and accessible.
https://github.com/mdtanker/polartoolkit

Category: Cryosphere
Sub Category: Glacier and Ice Sheets

Keywords

antarctica arctic bedmachine bedmap cryosphere gmt greenland jupyter-notebook plotting polar profiles pygmt python

Keywords from Contributors

measur archiving observation blog transforms conversion community weather-station tracking tokenizer

Last synced: about 20 hours ago
JSON representation

Repository metadata

Helpful tools for polar researchers

README.md

PolarToolkit (formerly known as Antarctic-Plots) is a Python package with
the goal of making 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

Additionally, PolarToolkit provides an easy means for exploring datasets
with pre-defined or interactively-chosen geographic regions.

Disclaimer

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.

Installation

There are 3 main ways to install polartoolkit. We show them here in order of
simplest to hardest.

Conda / Mamba

The easiest way to install this package and it's dependencies is with conda or
mamba into a new virtual environment:

mamba create --name polartoolkit --yes --force polartoolkit

And activate the environment:

conda activate polartoolkit

Note that conda and mamba are interchangeable.

Pip

Instead, you can use pip to install polartoolkit, but first you need to
install a few dependencies with conda. This is because PyGMT GeoPandas, and
Cartopy all rely on C packages, which can only be install with conda/mamba and
not with pip.

To create a new virtual environment:

mamba create --name polartoolkit --yes --force pygmt geopandas cartopy

And activate the environment, followed by using pip to install polartoolkit:

mamba activate polartoolkit
pip install polartoolkit

To install the optional dependencies of polartoolkit, use this instead:

`pip install polartoolkit[all]`

Development version

You can use pip, with the above created environment, to install the latest
source from GitHub:

pip install git+https://github.com/mdtanker/polartoolkit.git

Or you can clone the repository and install:

git clone https://github.com/mdtanker/polartoolkit.git
cd polartoolkit
pip install .

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.

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 6 days ago

Total Commits: 886
Total Committers: 6
Avg Commits per committer: 147.667
Development Distribution Score (DDS): 0.054

Commits in past year: 405
Committers in past year: 6
Avg Commits per committer in past year: 67.5
Development Distribution Score (DDS) in past year: 0.084

Name Email Commits
mdtanker m****y@g****m 838
dependabot[bot] 4****] 18
pre-commit-ci[bot] 6****] 11
semantic-release s****e 10
github-actions g****s@g****m 7
PennyHow p****o@g****k 2

Committer domains:

Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 63
Total pull requests: 126
Average time to close issues: 4 months
Average time to close pull requests: 13 days
Total issue authors: 5
Total pull request authors: 5
Average comments per issue: 1.25
Average comments per pull request: 1.75
Merged pull request: 101
Bot issues: 0
Bot pull requests: 24

Past year issues: 13
Past year pull requests: 30
Past year average time to close issues: 19 days
Past year average time to close pull requests: 9 days
Past year issue authors: 2
Past year pull request authors: 4
Past year average comments per issue: 1.23
Past year average comments per pull request: 2.77
Past year merged pull request: 23
Past year bot issues: 0
Past year bot pull requests: 12

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/mdtanker/polartoolkit

Top Issue Authors

  • mdtanker (54)
  • PennyHow (3)
  • Bohr-niels (3)
  • JessicaS11 (2)
  • chenyqmy (1)

Top Pull Request Authors

  • mdtanker (98)
  • dependabot[bot] (21)
  • pre-commit-ci[bot] (3)
  • PennyHow (2)
  • hugoledoux (2)

Top Issue Labels

  • enhancement (10)
  • dependencies (4)
  • bug (4)
  • testing (3)
  • documentation (3)
  • good first issue (1)
  • help wanted (1)

Top Pull Request Labels

  • dependencies (21)

Package metadata

pypi.org: polartoolkit

Helpful tools for polar researchers

  • Homepage: https://github.com/mdtanker/polartoolkit
  • Documentation: https://polartoolkit.readthedocs.io/
  • Licenses: The MIT License (MIT) Copyright (c) 2022 Matt Tankersley Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 0.9.0 (published 27 days ago)
  • Last Synced: 2025-04-25T18:32:59.799Z (2 days ago)
  • Versions: 15
  • Dependent Packages: 2
  • Dependent Repositories: 0
  • Downloads: 888 Last month
  • Rankings:
    • Dependent packages count: 9.961%
    • Average: 37.856%
    • Dependent repos count: 65.752%
  • Maintainers (1)

Dependencies

pyproject.toml pypi
  • matplotlib ^3.5.3
  • numpy ^1.23.3
  • openpyxl ^3.0.10
  • pandas ^1.4.3
  • pooch ^1.6.0
  • pyogrio ^0.4.1
  • pyproj ^3.3.1
  • python >=3.9,<3.10
  • rioxarray ^0.12.0
  • scipy >=1.7.1
  • verde ^1.7.0
  • xarray ^2022.6.0
.github/workflows/ci.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v3.1.4 composite
  • conda-incubator/setup-miniconda v3 composite
  • pre-commit/action v3.0.0 composite
.github/workflows/semantic_release_check.yml actions
  • actions/checkout v4 composite
  • python-semantic-release/python-semantic-release master composite
  • wow-actions/auto-comment v1 composite
.github/workflows/get_pypi_stats.yml actions
  • EndBug/add-and-commit v9 composite
  • actions/checkout v4 composite
.github/workflows/pypi_release.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/upload-artifact v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/semantic_release.yml actions
  • EndBug/add-and-commit v9 composite
  • actions/checkout v4 composite
  • python-semantic-release/python-semantic-release master composite
env/environment.yml pypi

Score: 12.86077001571492