PolarToolkit
PolarToolkit: Python Tools for Convenient, Reproducible, and Open Polar Science - Published in JOSS (2024)
Science Score: 93.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 1 DOI reference(s) in JOSS metadata -
✓Academic publication links
Links to: zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Keywords from Contributors
Scientific Fields
Repository
Helpful tools for polar researchers
Basic Info
- Host: GitHub
- Owner: mdtanker
- License: mit
- Language: Python
- Default Branch: main
- Homepage: http://polartoolkit.readthedocs.io/
- Size: 1.53 GB
Statistics
- Stars: 59
- Watchers: 2
- Forks: 10
- Open Issues: 13
- Releases: 30
Topics
Metadata Files
README.md
Helpful tools for polar researchers
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:
- 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
){kind=icon}
**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, 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
- 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
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.
Owner
- Name: Matt Tankersley
- Login: mdtanker
- Kind: user
- Location: Wellington, New Zealand
- Company: Antarctic Research Centre, Victoria University of Wellington
- Website: https://www.linkedin.com/in/matthew-tankersley/
- Repositories: 5
- Profile: https://github.com/mdtanker
Geology / Geophysics Ph.D student doing Antarctic research
JOSS Publication
PolarToolkit: Python Tools for Convenient, Reproducible, and Open Polar Science
Authors
Victoria University of Wellington, New Zealand, GNS Science, New Zealand
Editor
Hugo Ledoux
Tags
python cryosphere polar antarctica arctic greenland open scienceGitHub Events
Total
- Create event: 41
- Issues event: 24
- Release event: 13
- Watch event: 18
- Delete event: 33
- Issue comment event: 85
- Push event: 126
- Pull request event: 63
- Fork event: 1
Last Year
- Create event: 41
- Issues event: 24
- Release event: 13
- Watch event: 18
- Delete event: 33
- Issue comment event: 85
- Push event: 126
- Pull request event: 63
- Fork event: 1
Committers
Last synced: 8 months ago
Top Committers
| Name | 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 (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 44
- Total pull requests: 141
- Average time to close issues: 7 months
- Average time to close pull requests: 15 days
- Total issue authors: 6
- Total pull request authors: 5
- Average comments per issue: 0.64
- Average comments per pull request: 2.18
- Merged pull requests: 96
- Bot issues: 0
- Bot pull requests: 47
Past Year
- Issues: 16
- Pull requests: 60
- Average time to close issues: 8 days
- Average time to close pull requests: 7 days
- Issue authors: 2
- Pull request authors: 3
- Average comments per issue: 0.06
- Average comments per pull request: 1.47
- Merged pull requests: 45
- Bot issues: 0
- Bot pull requests: 27
Top Authors
Issue Authors
- mdtanker (35)
- PennyHow (3)
- JessicaS11 (2)
- Bohr-niels (2)
- chenyqmy (1)
- YingpuRin (1)
Pull Request Authors
- mdtanker (89)
- dependabot[bot] (39)
- pre-commit-ci[bot] (8)
- PennyHow (3)
- hugoledoux (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 414 last-month
-
Total dependent packages: 2
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 57
- Total maintainers: 1
proxy.golang.org: github.com/mdtanker/polartoolkit
- Documentation: https://pkg.go.dev/github.com/mdtanker/polartoolkit#section-documentation
- License: mit
-
Latest release: v1.1.3
published 5 months ago
Rankings
pypi.org: polartoolkit
Helpful tools for polar researchers
- Homepage: https://github.com/mdtanker/polartoolkit
- Documentation: https://polartoolkit.readthedocs.io/
- License: 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: 1.1.3
published 5 months ago
Rankings
Maintainers (1)
Dependencies
- 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
- 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
- actions/checkout v4 composite
- python-semantic-release/python-semantic-release master composite
- wow-actions/auto-comment v1 composite
- EndBug/add-and-commit v9 composite
- actions/checkout v4 composite
- actions/checkout v4 composite
- actions/download-artifact v4 composite
- actions/upload-artifact v4 composite
- pypa/gh-action-pypi-publish release/v1 composite
- EndBug/add-and-commit v9 composite
- actions/checkout v4 composite
- python-semantic-release/python-semantic-release master composite