Quickstart

Here is a quick demonstration of some of the main things PolarToolkit can do. This assumes you know a bit of Python and have successfully installed this packaged. See the tutorials for a step-by-step introduction to PolarToolkit, and the how-to guides for more in-depth guides for specific features.

Import the various modules of PolarToolkit.

import polartoolkit as ptk

Inform PolarToolkit that for this notebook, we are using Antarctica data, in a Polar Stereographic projection EPSG:3031 as opposed to the data / projection from the Arctic/Greenland.

import os

os.environ["POLARTOOLKIT_EPSG"] = "3031"

Use the PolarToolkit fetch module to download some gridded Antarctic ice thickness data from Bedmap3 and return the portion around the Amery Ice Shelf using the region module.

ice_thickness = ptk.fetch.bedmap3(
    layer="ice_thickness",
    region=ptk.regions.amery_ice_shelf,
)

Create a simple map with a few optional embellishments with the maps module.

fig = ptk.plot_grid(
    ice_thickness,
    title="Ice thickness of the Amery Ice Shelf",
    cbar_label="meters",
    cmap="dense",
    inset=True,
    coast=True,
    scalebar=True,
    hist=True,
    gridlines=True,
)
fig.show(dpi=200)

Define a profile between two points and plot a cross section of ice, ocean, and earth layers from Bedmap3 using the profiles module.

# meters east and north of the south pole in EPSG 3031
a = (1925000, 830000)
b = (2200000, 600000)

fig, _, _ = ptk.plot_profile(
    method="points",
    start=a,
    stop=b,
    add_map=True,
    layers_version="bedmap3",
)
fig.show(dpi=200)