| Name | polartoolkit JSON |
| Version |
0.3.3
JSON |
| download |
| home_page | None |
| Summary | Helpful tools for polar researchers |
| upload_time | 2024-04-23 10:31:17 |
| 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.
|
<h1 align="center">PolarToolkit</h1>
<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-START1 -->
<p align="center">
<a href="https://mybinder.org/v2/gh/mdtanker/polartoolkit/main">
<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"
/>
<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-END1 -->
## 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`).
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-START2 -->
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](https://polartoolkit.readthedocs.io/en/latest/contributing.html) 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](https://github.com/mdtanker/polartoolkit/issues/new/choose).
- 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.
<!-- SPHINX-END2 -->
## 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](https://github.com/mdtanker/polartoolkit/)!
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/10/9c/2a91c652dd3f2f1578f556c86d63fd049e7c4cfe5f6d7baf989eb7b0958b/polartoolkit-0.3.3.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">PolarToolkit</h1>\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-START1 -->\n\n<p align=\"center\">\n<a href=\"https://mybinder.org/v2/gh/mdtanker/polartoolkit/main\">\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\">\n<img\nsrc=\"https://img.shields.io/pypi/v/polartoolkit?style=flat-square\"\nalt=\"Latest version on PyPI\"\n/>\n</a>\n<a href=\"https://github.com/conda-forge/polartoolkit-feedstock\">\n<img\nsrc=\"https://img.shields.io/conda/vn/conda-forge/polartoolkit.svg?style=flat-square\"\nalt=\"Latest version on conda-forge\"\n/>\n</a>\n<a href=\"https://codecov.io/gh/mdtanker/polartoolkit\">\n<img\nsrc=\"https://img.shields.io/codecov/c/github/mdtanker/polartoolkit/main.svg?style=flat-square\"\nalt=\"Test coverage status\"\n/>\n\n<p align=\"center\">\n<a href=\"https://pypi.org/project/polartoolkit/\">\n<img src=\"https://img.shields.io/pypi/pyversions/polartoolkit?style=flat-square\"\nalt=\"Compatible Python versions.\"\n/>\n</a>\n<a href=\"https://zenodo.org/badge/latestdoi/475677039\">\n<img src=\"https://zenodo.org/badge/475677039.svg?style=flat-square\"\nalt=\"Zenodo DOI\"\n/>\n</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-END1 -->\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\nchanges to the ones we already have while we try to improve the software based\non users' experience, test new ideas, make better design decisions, etc. Some of\nthese changes could be **backwards incompatible**. Keep that in mind before you\nupdate PolarToolkit to a new major version (i.e. from `v1.0.0` to `v2.0.0`).\n\nI welcome any feedback, ideas, or contributions! Please contact us on the\n[GitHub discussions page](https://github.com/mdtanker/polartoolkit/discussions)\nor submit an [issue on GitHub](https://github.com/mdtanker/polartoolkit/issues)\nfor problems or feature ideas.\n\n<!-- SPHINX-START2 -->\n\nThe **PolarToolkit** python package provides some basic tools to help in\nconducting polar research. You can use it to download common datasets (i.e.\nBedMachine, Bedmap2, MODIA MoA), create maps and plots specific to Antarctica\n(soon Greenland and the Arctic as well), and visualize data with multiple\nmethods.\n\nFeel free to use, share, modify, and\n[contribute](https://polartoolkit.readthedocs.io/en/latest/contributing.html) to\nthis project. I've mostly made this for personal usage so expect significant\nchanges. Hopefully, I'll implement more tests and Gallery examples soon.\n\n## Project goals\n\nBelow is a list of some features I hope to eventually include. Feel free to make\na feature request through\n[GitHub Issues](https://github.com/mdtanker/polartoolkit/issues/new/choose).\n\n- Create 3D interactive models to help visualize data.\n- Include more datasets to aid in downloading and storage.\n- Additional projections and possible support for the Arctic region as well.\n\n<!-- SPHINX-END2 -->\n\n## How to contribute\n\nI really welcome all forms of contribution! If you have any questions, comments\nor suggestions, please open a [discussion]() or [issue (feature request)]() on\nthe [GitHub page](https://github.com/mdtanker/polartoolkit/)!\n\nAlso, please feel free to share how you're using PolarToolkit, I'd love to know.\n\nPlease, read our\n[Contributor Guide](https://polartoolkit.readthedocs.io/en/latest/contributing.html)\nto 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.3.3",
"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": "89d9efdcb29d56e8a9c9451658b1b8df88f287703e8bc0b060ae78a8b0e0da3f",
"md5": "6710a9ec4469ac504cb205d9983aa948",
"sha256": "5a1c0f17fbda8f5991e5802f55024fe8d903003c5a52786ff530fd431cae5b6e"
},
"downloads": -1,
"filename": "polartoolkit-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6710a9ec4469ac504cb205d9983aa948",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 71238,
"upload_time": "2024-04-23T10:31:15",
"upload_time_iso_8601": "2024-04-23T10:31:15.342573Z",
"url": "https://files.pythonhosted.org/packages/89/d9/efdcb29d56e8a9c9451658b1b8df88f287703e8bc0b060ae78a8b0e0da3f/polartoolkit-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "109c2a91c652dd3f2f1578f556c86d63fd049e7c4cfe5f6d7baf989eb7b0958b",
"md5": "276106d18aed816f894f18dc0d41ef93",
"sha256": "22f1d450bc2698f0d55cb308a8bc3f535bf54c1e10823c5e392f2e53f0f9c9a3"
},
"downloads": -1,
"filename": "polartoolkit-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "276106d18aed816f894f18dc0d41ef93",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 80158,
"upload_time": "2024-04-23T10:31:17",
"upload_time_iso_8601": "2024-04-23T10:31:17.170429Z",
"url": "https://files.pythonhosted.org/packages/10/9c/2a91c652dd3f2f1578f556c86d63fd049e7c4cfe5f6d7baf989eb7b0958b/polartoolkit-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-23 10:31:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mdtanker",
"github_project": "polartoolkit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "polartoolkit"
}
