| Name | polartoolkit JSON |
| Version |
0.7.1
JSON |
| download |
| home_page | None |
| Summary | Helpful tools for polar researchers |
| upload_time | 2024-12-17 14:03:40 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| 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. |
| keywords |
cryosphere
antarctica
arctic
greenland
maps
plotting
pygmt
cross-section
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<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** (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
<!-- 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>
<!-- 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](https://github.com/mdtanker/polartoolkit/blob/main/CHANGELOG.md) 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](https://github.com/mdtanker/polartoolkit/discussions) or submit an [issue on GitHub](https://github.com/mdtanker/polartoolkit/issues) 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, 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](https://polartoolkit.readthedocs.io/en/latest/contributing.html) 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](https://www.npolar.no/quantarctica/) or
[QGreenland](https://qgreenland.org/)
- complex geospatial processing -> see
[PyGMT](https://www.pygmt.org/dev/index.html),
[Verde](https://www.fatiando.org/verde/dev/index.html),
[Geopandas](https://geopandas.org/en/stable/) or
[Rasterio](https://rasterio.readthedocs.io/en/stable/)
<!-- 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](https://github.com/mdtanker/polartoolkit/discussions/new/choose) or [issue (feature request)](https://github.com/mdtanker/polartoolkit/issues/new/choose)!
Also, please feel free to share how you're using PolarToolkit, I'd love to know.
Please, read our [Contributor Guide](https://polartoolkit.readthedocs.io/en/latest/contributing.html) to learn how you can contribute to the project.
Raw data
{
"_id": null,
"home_page": null,
"name": "polartoolkit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "cryosphere, antarctica, arctic, greenland, maps, plotting, pygmt, cross-section",
"author": null,
"author_email": "Matt Tankersley <matt.d.tankersley@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/07/4e/3bb61fcb5a67729e7273407885666beb1771b39b2dcb473fbcd6654b84fa/polartoolkit-0.7.1.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n<img src=\"docs/logo_dark.png\" alt=\"polartoolkit logo\" width=\"200\"/>\n</p>\n<h2 align=\"center\">Helpful tools for polar researchers</h2>\n\n<p align=\"center\">\n<a href=\"https://polartoolkit.readthedocs.io\"><strong>Documentation Link</strong></a>\n</p>\n\n<!-- SPHINX-START-proj-desc -->\n\n**PolarToolkit** (formerly known as Antarctic-Plots) is a Python package to make polar (i.e. Antarctic, Arctic, Greenland) research more efficient, reproducible, and accessible.\nThe software does this by providing:\n\n- convenient functions for downloading and pre-processing a wide range of commonly used polar datasets\n- tools for common geospatial tasks (i.e. changing data resolution, subsetting data by geographic regions)\n- code to easily create publication-quality maps, data profiles, and cross-sections\n- a means to interactively explore datasets\n\n<!-- SPHINX-END-proj-desc -->\n\n<!-- SPHINX-START-badges -->\n\n<p align=\"center\">\n<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\">\n <img src=\"https://mybinder.org/badge_logo.svg\" alt=\"Binder link\"></a>\n </p>\n\n<p align=\"center\">\n<a href=\"https://pypi.python.org/pypi/polartoolkit\"><img src=\"https://img.shields.io/pypi/v/polartoolkit?style=flat-square\"\nalt=\"Latest version on PyPI\"/></a>\n<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>\n<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>\n</p>\n\n<p align=\"center\">\n<a href=\"https://pypi.org/project/polartoolkit/\"><img src=\"https://img.shields.io/pypi/pyversions/polartoolkit?style=flat-square\" alt=\"Compatible Python versions.\"/></a>\n<a href=\"https://zenodo.org/badge/latestdoi/475677039\"><img src=\"https://zenodo.org/badge/475677039.svg?style=flat-square\" alt=\"Zenodo DOI\"/></a>\n<a href='https://readthedocs.org/projects/polartoolkit/'><img src='https://readthedocs.org/projects/polartoolkit/badge/?version=latest&style=flat-square' alt='Documentation Status' /></a>\n </p>\n\n<!-- SPHINX-END-badges -->\n\n\n\n# Disclaimer\n\n<p align=\"center\">\n\ud83d\udea8 **Ready for daily use but still changing.** \ud83d\udea8\n</p>\n\nThis 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.\nSome of these changes could be **backwards incompatible**.\nKeep 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](https://github.com/mdtanker/polartoolkit/blob/main/CHANGELOG.md) for `BREAKING CHANGES` and how to update your code appropriately.\n\nI welcome any feedback, ideas, or contributions!\nPlease contact us on the [GitHub discussions page](https://github.com/mdtanker/polartoolkit/discussions) or submit an [issue on GitHub](https://github.com/mdtanker/polartoolkit/issues) for problems or feature ideas.\n\n<!-- SPHINX-START-long-desc -->\n\nThe **PolarToolkit** python package provides some basic tools to help in conducting polar research.\nYou 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.\n\nFeel free to use, share, modify, and [contribute](https://polartoolkit.readthedocs.io/en/latest/contributing.html) to this project.\n\n## What _PolarToolkit_ is for:\n\n- download commonly used datasets related to Antarctica, Greenland and the Arctic\n- making publication-quality maps and cross-sections\n- interactively explore data and define geographic regions\n- plotting and working with data in projected coordinates (meters) in either EPSG 3031 or 3413, for the South and North hemispheres, respectively\n- mostly focused on regularly gridded (interpolated) datasets, with some support for discrete (un-gridded) data\n- 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!\n- basic geospatial manipulations (filtering, resampling, reprojecting, masking etc.)\n\n## What _PolarToolkit_ is **NOT** for:\n\n- downloading niche datasets or those that only cover specific regions\n- downloaded datasets outside of Antarctica, Greenland and the Arctic\n- plotting and working with data in geographic (latitude and longitude) coordinates\n- plots not related to geospatial data\n- a point-and-click GUI for plotting or data exploration -> see\n [Quantarctica](https://www.npolar.no/quantarctica/) or\n [QGreenland](https://qgreenland.org/)\n- complex geospatial processing -> see\n [PyGMT](https://www.pygmt.org/dev/index.html),\n [Verde](https://www.fatiando.org/verde/dev/index.html),\n [Geopandas](https://geopandas.org/en/stable/) or\n [Rasterio](https://rasterio.readthedocs.io/en/stable/)\n\n<!-- SPHINX-END-long-desc -->\n\n# How to contribute\nI welcome all forms of contribution! If you have any questions, comments or suggestions, please open a [discussion](https://github.com/mdtanker/polartoolkit/discussions/new/choose) or [issue (feature request)](https://github.com/mdtanker/polartoolkit/issues/new/choose)!\n\nAlso, please feel free to share how you're using PolarToolkit, I'd love to know.\n\nPlease, read our [Contributor Guide](https://polartoolkit.readthedocs.io/en/latest/contributing.html) to learn how you can contribute to the project.\n",
"bugtrack_url": null,
"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. ",
"summary": "Helpful tools for polar researchers",
"version": "0.7.1",
"project_urls": {
"Bug Tracker": "https://github.com/mdtanker/polartoolkit/issues",
"Changelog": "https://polartoolkit.readthedocs.io/en/latest/changelog.html",
"Discussions": "https://github.com/mdtanker/polartoolkit/discussions",
"Documentation": "https://polartoolkit.readthedocs.io/",
"Homepage": "https://github.com/mdtanker/polartoolkit"
},
"split_keywords": [
"cryosphere",
" antarctica",
" arctic",
" greenland",
" maps",
" plotting",
" pygmt",
" cross-section"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d2a859bb6c1c9922f6926e62f45b479abec28f27e07577286ebf769ebc8571ac",
"md5": "1a6eb27321aeedd175ae3a4d62c27ada",
"sha256": "79715d36af9f978f2c6557b61d8e9fab77fdc8eea13fb21ccb44485df13c95c7"
},
"downloads": -1,
"filename": "polartoolkit-0.7.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a6eb27321aeedd175ae3a4d62c27ada",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 78101,
"upload_time": "2024-12-17T14:03:37",
"upload_time_iso_8601": "2024-12-17T14:03:37.447233Z",
"url": "https://files.pythonhosted.org/packages/d2/a8/59bb6c1c9922f6926e62f45b479abec28f27e07577286ebf769ebc8571ac/polartoolkit-0.7.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "074e3bb61fcb5a67729e7273407885666beb1771b39b2dcb473fbcd6654b84fa",
"md5": "8db4f9269e0c7d6af5bff84b81fdf05f",
"sha256": "227bc4150c9b5469a5872d44e0bce28cf87752d8c6a9ab2e2bcb6454faefc647"
},
"downloads": -1,
"filename": "polartoolkit-0.7.1.tar.gz",
"has_sig": false,
"md5_digest": "8db4f9269e0c7d6af5bff84b81fdf05f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 88535,
"upload_time": "2024-12-17T14:03:40",
"upload_time_iso_8601": "2024-12-17T14:03:40.067341Z",
"url": "https://files.pythonhosted.org/packages/07/4e/3bb61fcb5a67729e7273407885666beb1771b39b2dcb473fbcd6654b84fa/polartoolkit-0.7.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 14:03:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mdtanker",
"github_project": "polartoolkit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "polartoolkit"
}
