antarctic-plots 0.0.1

Functions to automate Antarctic data visualization

Automatically plot Antarctic data

Disclaimer

🚨 This package is in early stages of design and implementation. 🚨

I welcome any feedback, ideas, or contributions! Please submit an issue on Github for problems or feature ideas.

About

This python package provides some basic tools for creating maps and plots specific to Antarctica. It includes code to download common continent-wide datasets (i.e. Bedmap2, AntGG, ADMAP), and visualize them in a variety of ways, including cross sections and maps. The Jupyter notebook examples/examples.ipynb runs through some of the main functions and usages of this package.

By default the cross-sections include Bedmap2 surface, icebase, and bed as layers, and the data profiles include Free-air gravity and magnetics, but these can be changed to any data, as long as it's supplied as a grid/raster type of file.

Data are sampled along lines either defined by 2 sets of coordinates, or along the path of a shapefile.

Feel free to use, share, modify, and contribute to this project. I've mostly made this for private usage so for now the documentation is sparse.

Getting started

Here I use mamba to install packages, but conda should work as well:

conda install mamba

Create a new python environment with the required dependencies:

mamba create --name antarctic_plots python=3.9 pandas numpy pooch xarray pyproj  verde rioxarray pygmt geopandas netCDF4 tqdm

If you will use ipython (i.e. Jupyter notebooks) then include ipykernel and jupyterlab:

    mamba create --name antarctic_plots python=3.9 pandas numpy pooch xarray pyproj  verde rioxarray pygmt geopandas netCDF4 tqdm ipykernel jupyterlab

Activate the new environment:

mamba activate antarctic_plots

To install the last released version:

pip install antarctic-plots --no-deps

To install the development version from Github:

git clone https://github.com/mdtanker/antarctic_plots.git
cd antarctic_plots
pip install -e .

Test the install by running the first few cells of examples/examples.ipynb or the equivalent .py file

If you get an error related to traitlets run the following command as discuss here:

conda install ipykernel --update-deps --force-reinstall

Antarctic_plots has the following dependencies:

• pandas
• numpy
• pooch
• xarray
• pyproj
• verde
• rioxarray
• pygmt
• geopandas
• netCDF4
• tqdm MIT License

Copyright (c) 2022 Matt Tankerlsey

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.