Metadata-Version: 2.1
Name: antarctic_plots
Version: 0.1.0
Summary: Functions to automate Antarctic data visualization
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/antarctic_plots
Project-URL: Documentation, https://antarctic-plots.readthedocs.io/
Project-URL: Bug Tracker, https://github.com/mdtanker/antarctic_plots/issues
Project-URL: Discussions, https://github.com/mdtanker/antarctic_plots/discussions
Project-URL: Changelog, https://antarctic-plots.readthedocs.io/en/latest/changelog.html
Keywords: antarctica,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: antarctic-plots[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"
Provides-Extra: all
Requires-Dist: antarctic-plots[dev,docs,interactive,test,viz]; extra == "all"

<h1 align="center">Antarctic-Plots</h1>
<h2 align="center">Functions to automate Antarctic data visualization</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/antarctic-plots">
<img
src="https://img.shields.io/pypi/v/antarctic-plots?style=flat-square"
alt="Latest version on PyPI"
/>
</a>
<a href="https://github.com/conda-forge/antarctic-plots-feedstock">
<img
src="https://img.shields.io/conda/vn/conda-forge/antarctic-plots.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/antarctic-plots/">
<img src="https://img.shields.io/pypi/pyversions/antarctic-plots?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 Antarctic-Plots to a newer version.

I welcome any feedback, ideas, or contributions! Please contact us on the
[GitHub discussions page](https://github.com/mdtanker/antarctic_plots/discussions)
or submit an
[issue on GitHub](https://github.com/mdtanker/antarctic_plots/issues) for
problems or feature ideas.

<!-- SPHINX-START2 -->

The **Antarctic-Plots** python package provides some basic tools to help in
conducting Antarctic research. You can use it to download common datasets (i.e.
BedMachine, Bedmap2, MODIA MoA), create maps and plots specific to Antarctica,
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/antarctic_plots/issues/new/choose).

- Create 3D interactive models to help visualize data.
- Include more Antarctic datasets to aid in download 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/antarctic_plots/)!

Also, please feel free to share how you're using Antarctic-Plots, I'd love to
know.

Please, read our
[Contributor Guide](https://github.com/mdtanker/antarctic_plots/blob/main/.github/CONTRIBUTING.md)
to learn how you can contribute to the project.
