polartoolkit 0.2.0__tar.gz

polartoolkit-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+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.

polartoolkit-0.2.0/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.1
+Name: polartoolkit
+Version: 0.2.0
+Summary: Helpful tools for polar researchers
+Author-email: Matt Tankersley <matt.d.tankersley@gmail.com>
+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.
+        
+Project-URL: Homepage, https://github.com/mdtanker/polartoolkit
+Project-URL: Documentation, https://antarctic-plots.readthedocs.io/
+Project-URL: Bug Tracker, https://github.com/mdtanker/polartoolkit/issues
+Project-URL: Discussions, https://github.com/mdtanker/polartoolkit/discussions
+Project-URL: Changelog, https://antarctic-plots.readthedocs.io/en/latest/changelog.html
+Keywords: cryosphere,antarctica,arctic,greenland,maps,plotting,pygmt,cross-section
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas
+Requires-Dist: openpyxl
+Requires-Dist: pooch[progress]
+Requires-Dist: verde>=1.8.0
+Requires-Dist: xarray[io]
+Requires-Dist: harmonica>=0.6.0
+Requires-Dist: pyproj
+Requires-Dist: matplotlib
+Requires-Dist: pyogrio
+Requires-Dist: rioxarray
+Requires-Dist: scipy
+Requires-Dist: numpy
+Requires-Dist: pygmt
+Requires-Dist: geopandas
+Requires-Dist: zarr
+Requires-Dist: python-dotenv
+Requires-Dist: nptyping
+Provides-Extra: interactive
+Requires-Dist: geoviews; extra == "interactive"
+Requires-Dist: cartopy; extra == "interactive"
+Requires-Dist: ipyleaflet; extra == "interactive"
+Requires-Dist: ipython; extra == "interactive"
+Provides-Extra: viz
+Requires-Dist: seaborn; extra == "viz"
+Provides-Extra: test
+Requires-Dist: pytest>=6; extra == "test"
+Requires-Dist: pytest-cov>=3; extra == "test"
+Requires-Dist: deepdiff; extra == "test"
+Provides-Extra: docs
+Requires-Dist: sphinx>=4.0; extra == "docs"
+Requires-Dist: myst_parser; extra == "docs"
+Requires-Dist: sphinx_copybutton; extra == "docs"
+Requires-Dist: sphinx_autodoc_typehints; extra == "docs"
+Requires-Dist: sphinx-book-theme>=0.3; extra == "docs"
+Requires-Dist: sphinx_design; extra == "docs"
+Requires-Dist: nbsphinx; extra == "docs"
+Requires-Dist: nbconvert; extra == "docs"
+Provides-Extra: dev
+Requires-Dist: polartoolkit[docs,interactive,test,viz]; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: nox; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: python-semantic-release>=8; extra == "dev"
+Requires-Dist: ipykernel; extra == "dev"
+Requires-Dist: jupyterlab; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pathspec; extra == "dev"
+Provides-Extra: all
+Requires-Dist: polartoolkit[dev,docs,interactive,test,viz]; extra == "all"
+
+<h1 align="center">PolarToolkit</h1>
+<h2 align="center">Helpful tools for polar researchers</h2>
+
+<p align="center">
+<a href="https://antarctic-plots.readthedocs.io"><strong>Documentation Link</strong></a>
+</p>
+
+<!-- SPHINX-START1 -->
+
+<p align="center">
+<a href="https://mybinder.org/v2/gh/mdtanker/antarctic_plots/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/antarctic_plots">
+<img
+src="https://img.shields.io/codecov/c/github/mdtanker/antarctic_plots/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/antarctic-plots/'><img src='https://readthedocs.org/projects/antarctic-plots/badge/?version=latest&style=flat-square' alt='Documentation Status' /></a>
+ </p>
+
+<!-- SPHINX-END1 -->
+
+![](docs/cover_fig.png)
+
+## Disclaimer
+
+<p align="center">
+🚨 **This package is in early stages of development.** 🚨
+</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 newer version.
+
+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://antarctic-plots.readthedocs.io/en/latest/contribute.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://github.com/mdtanker/polartoolkit/blob/main/.github/CONTRIBUTING.md)
+to learn how you can contribute to the project.

polartoolkit-0.2.0/README.md

@@ -0,0 +1,104 @@
+<h1 align="center">PolarToolkit</h1>
+<h2 align="center">Helpful tools for polar researchers</h2>
+
+<p align="center">
+<a href="https://antarctic-plots.readthedocs.io"><strong>Documentation Link</strong></a>
+</p>
+
+<!-- SPHINX-START1 -->
+
+<p align="center">
+<a href="https://mybinder.org/v2/gh/mdtanker/antarctic_plots/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/antarctic_plots">
+<img
+src="https://img.shields.io/codecov/c/github/mdtanker/antarctic_plots/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/antarctic-plots/'><img src='https://readthedocs.org/projects/antarctic-plots/badge/?version=latest&style=flat-square' alt='Documentation Status' /></a>
+ </p>
+
+<!-- SPHINX-END1 -->
+
+![](docs/cover_fig.png)
+
+## Disclaimer
+
+<p align="center">
+🚨 **This package is in early stages of development.** 🚨
+</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 newer version.
+
+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://antarctic-plots.readthedocs.io/en/latest/contribute.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://github.com/mdtanker/polartoolkit/blob/main/.github/CONTRIBUTING.md)
+to learn how you can contribute to the project.

polartoolkit-0.2.0/pyproject.toml

@@ -0,0 +1,266 @@
+[build-system]
+requires = ["setuptools>=64"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "polartoolkit"
+authors = [
+    {name = "Matt Tankersley", email = "matt.d.tankersley@gmail.com"},
+]
+description = "Helpful tools for polar researchers"
+requires-python = ">=3.9"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Education",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Topic :: Scientific/Engineering",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Typing :: Typed",
+]
+readme = "README.md"
+version = "0.2.0"
+license = {file = "LICENSE"}
+
+keywords = ["cryosphere", "antarctica", "arctic", "greenland", "maps", "plotting", "pygmt", "cross-section"]
+
+dependencies = [
+    "pandas",
+    "openpyxl",
+    "pooch[progress]", # includes tqdm
+    "verde>=1.8.0",
+    "xarray[io]", # includes netCDF4, h5netcdf, scipy, pydap, zarr, fsspec, cftime, rasterio, cfgrib, pooch
+    "harmonica>=0.6.0",
+    "pyproj",
+    "matplotlib",
+    "pyogrio",
+    "rioxarray",
+    "scipy",
+    "numpy",
+    "pygmt",
+    "geopandas",
+    "zarr",
+    "python-dotenv",
+    "nptyping",
+]
+
+[project.optional-dependencies]
+interactive = [
+    "geoviews",
+    "cartopy",
+    "ipyleaflet",
+    "ipython",
+]
+viz = [
+    "seaborn",
+]
+test = [
+  "pytest >=6",
+  "pytest-cov >=3",
+  "deepdiff",
+]
+docs = [
+  "sphinx>=4.0",
+  "myst_parser",
+  "sphinx_copybutton",
+  "sphinx_autodoc_typehints",
+  "sphinx-book-theme>=0.3",
+  "sphinx_design",
+  "nbsphinx",
+  "nbconvert",
+]
+dev = [
+    "polartoolkit[interactive,viz,test,docs]",
+    "ruff",
+    "nox",
+    "pre-commit",
+    "pylint",
+    "python-semantic-release >=8",
+    "ipykernel",
+    "jupyterlab",
+    "mypy",
+    "pathspec",
+]
+all = [
+  "polartoolkit[interactive,viz,test,dev,docs]",
+]
+
+[project.urls]
+Homepage = "https://github.com/mdtanker/polartoolkit"
+Documentation = "https://antarctic-plots.readthedocs.io/"
+"Bug Tracker" = "https://github.com/mdtanker/polartoolkit/issues"
+Discussions = "https://github.com/mdtanker/polartoolkit/discussions"
+Changelog = "https://antarctic-plots.readthedocs.io/en/latest/changelog.html"
+
+[tool.coverage]
+run.source = ["polartoolkit"]
+port.exclude_lines = [
+  'pragma: no cover',
+  '\.\.\.',
+  'if typing.TYPE_CHECKING:',
+]
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = [
+  "-rA",
+  "--showlocals",
+  "--strict-markers",
+  "--strict-config",
+  "--cov", "--cov-report", "term-missing",
+  ]
+xfail_strict = true
+filterwarnings = [
+  "error",
+  "ignore::DeprecationWarning",
+  "ignore::PendingDeprecationWarning",
+  "ignore::FutureWarning",
+]
+log_cli_level = "INFO"
+testpaths = [
+  "tests",
+]
+markers = [
+    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
+    "earthdata: marks tests as requiring earthdata login info (deselect with '-m \"not earthdata\"')",
+    "issue: mark tests with current issues (deselect with '-m \"not issues\"')",
+    "fetch: marks tests which fetch data",
+]
+
+[tool.mypy]
+files = ["src"]
+python_version = "3.9"
+warn_unused_configs = true
+strict = true
+show_error_codes = true
+enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"]
+warn_unreachable = true
+disallow_untyped_defs = false
+disallow_incomplete_defs = false
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = "polartoolkit.*"
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+
+
+[tool.ruff]
+lint.select = [
+  "E", "F", "W", # flake8
+  "B",           # flake8-bugbear
+  "I",           # isort
+  "ARG",         # flake8-unused-arguments
+  "C4",          # flake8-comprehensions
+  "EM",          # flake8-errmsg
+  "ICN",         # flake8-import-conventions
+  "ISC",         # flake8-implicit-str-concat
+  "G",           # flake8-logging-format
+  "PGH",         # pygrep-hooks
+  "PIE",         # flake8-pie
+  "PL",          # pylint
+  "PT",          # flake8-pytest-style
+  "PTH",         # flake8-use-pathlib
+  "RET",         # flake8-return
+  "RUF",         # Ruff-specific
+  "SIM",         # flake8-simplify
+  "T20",         # flake8-print
+  "UP",          # pyupgrade
+  "YTT",         # flake8-2020
+  "EXE",         # flake8-executable
+  "NPY",         # NumPy specific rules
+  "PD",          # pandas-vet
+]
+lint.extend-ignore = [
+  "PLR",    # Design related pylint codes
+  "G004",   # Logging with f-strings
+  "PD901",  # Bad variable name warning
+  "PD003", # Changes .isna to .isnull
+  "PD004", # Changes .notna to .notnull
+  "PD011", # Changes .values() to .to_numpy()
+]
+src = ["src"]
+lint.unfixable = [
+  "T20",  # Removes print statements
+  "F841", # Removes unused variables
+  "PD003", # Changes .isna to .isnull
+  "PD004", # Changes .notna to .notnull
+  "PD011", # Changes .values() to .to_numpy()
+]
+exclude = ["docs/index.md", "CHANGELOG.md", "tools/license_notice.py"]
+line-length = 88 # Set the maximum line length to 88.
+lint.flake8-unused-arguments.ignore-variadic-names = true
+# lint.isort.required-imports = ["from __future__ import annotations"]
+# Uncomment if using a _compat.typing backport
+# typing-modules = ["polartoolkit._compat.typing"]
+extend-include = ["*.ipynb"]
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["T20"]
+"noxfile.py" = ["T20"]
+"*.ipynb" = ["E402", "B018", "T201", "F821"]
+
+
+[tool.pylint]
+py-version = "3.9"
+ignore-paths = ["CHANGELOG.md"]
+reports.output-format = "colorized"
+similarities.ignore-imports = "yes"
+similarities.min-similarity-lines = 5
+messages_control.disable = [
+  "design",
+  "fixme",
+  "line-too-long",
+  "missing-module-docstring",
+  "wrong-import-position",
+  "cyclic-import",
+]
+
+
+[tool.semantic_release]
+version_variables = ["src/polartoolkit/__init__.py:__version__"]
+version_toml = ["pyproject.toml:project.version"]
+major_on_zero = false
+build_command = """
+    python -m pip install build
+    python -m build .
+"""
+commit_parser = "angular"
+
+[tool.semantic_release.branches.main]
+match = "main"
+prerelease = false
+
+[tool.semantic_release.branches.notmain]
+match = "(?!main)"
+prerelease = true
+
+[tool.semantic_release.changelog]
+template_dir = "templates"
+
+[tool.semantic_release.changelog.environment]
+trim_blocks = true
+
+[tool.semantic_release.commit_parser_options]
+allowed_tags = [
+    "build",    # Changes that affect the build system or external dependencies
+    "chore",    # Changes to the build process or auxiliary tools and libraries such as documentation generation
+    "ci",       # CI related changes
+    "docs",     # Documentation only changes
+    "feat",     # A new feature
+    "fix",      # A bug fix
+    "perf",     # A code change that improves performance
+    "style",    # Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+    "refactor", # A code change that neither fixes a bug nor adds a feature
+    "test",     # Adding missing or correcting existing tests
+]
+# including BREAKING CHANGE: in the commit message will trigger a major release
+minor_tags = ["feat"] # tags which result in minor releases
+patch_tags = ["fix", "perf"] # tags which result in patch releases

polartoolkit-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

polartoolkit-0.2.0/src/polartoolkit/__init__.py

@@ -0,0 +1,12 @@
+# Copyright (c) 2022 The Polartoolkit Developers.
+# Distributed under the terms of the MIT License.
+# SPDX-License-Identifier: MIT
+#
+# This code is part of the package:
+# PolarToolkit (https://github.com/mdtanker/polartoolkit)
+#
+"""Helpful tools for polar researchers"""
+
+from __future__ import annotations
+
+__version__ = "0.2.0"