geovista.pantry.data

Download, cache and load geovista sample data.

Notes

Added in version 0.5.0.

Attributes

CLOUD_AMOUNT_PREFERENCE

The default type of cloud amount mesh.

Classes

CloudPreference	Enumeration of mesh types for cloud amount.
SampleStructuredXY	Data container for structured surface.
SampleStructuredXYZ	Data container for structured volume.
SampleUnstructuredXY	Data container for unstructured surface.

Functions

capitalise(title)	Capitalise each word and replace inappropriate characters.
cloud_amount([preference])	Download and cache unstructured cloud amount data.
dynamico()	Download and cache unstructured surface sample data.
fesom([step])	Download and cache unstructured surface sample data.
fvcom_tamar()	Download and cache unstructured surface sample data.
icon_soil()	Download and cache unstructured surface sample data.
lam_equator()	Download and cache unstructured surface sample data.
lam_falklands()	Download and cache unstructured surface sample data.
lam_london()	Download and cache unstructured surface sample data.
lam_new_zealand()	Download and cache unstructured surface sample data.
lam_pacific()	Download and cache unstructured surface sample data.
lam_polar()	Download and cache unstructured surface sample data.
lam_uk()	Download and cache unstructured surface sample data.
lfric_orog()	Download and cache unstructured surface sample data.
lfric_sst()	Download and cache unstructured surface sample data.
nemo_orca2()	Download and cache structured surface sample data.
nemo_orca2_gradient()	Download and cache point-cloud sample data.
oisst_avhrr_sst()	Download and cache structured surface sample data.
usgs_earthquakes()	Download and cache the USGS HoloViz large earthquake dataset.
ww3_global_smc([step])	Download and cache unstructured surface sample data.
ww3_global_tri()	Download and cache unstructured surface sample data.

Module Contents

class geovista.pantry.data.CloudPreference

Bases: geovista.common.MixinStrEnum, enum.StrEnum

Enumeration of mesh types for cloud amount.

Notes

Added in version 0.4.0.

Initialize self. See help(type(self)) for accurate signature.

HIGH = 'high'

LOW = 'low'

MEDIUM = 'medium'

MESH = 'mesh'

VERY_HIGH = 'very_high'

class geovista.pantry.data.SampleStructuredXY

Data container for structured surface.

data: numpy.typing.ArrayLike = None

lats: numpy.typing.ArrayLike

lons: numpy.typing.ArrayLike

name: str = None

ndim: int = 2

steps: int = None

units: str = None

class geovista.pantry.data.SampleStructuredXYZ

Data container for structured volume.

data: numpy.typing.ArrayLike = None

lats: numpy.typing.ArrayLike

lons: numpy.typing.ArrayLike

name: str = None

ndim: int = 3

steps: int = None

units: str = None

zlevel: numpy.typing.ArrayLike

class geovista.pantry.data.SampleUnstructuredXY

Data container for unstructured surface.

connectivity: numpy.typing.ArrayLike

data: numpy.typing.ArrayLike = None

face: numpy.typing.ArrayLike = None

lats: numpy.typing.ArrayLike

lons: numpy.typing.ArrayLike

name: str = None

ndim: int = 2

node: numpy.typing.ArrayLike = None

start_index: int = None

steps: int = None

units: str = None

geovista.pantry.data.capitalise(title)

Capitalise each word and replace inappropriate characters.

Parameters:

titlestr

The string title to be reformatted.

Returns:

str

The capitalised title.

Notes

Added in version 0.1.0.

geovista.pantry.data.cloud_amount(preference=None)

Download and cache unstructured cloud amount data.

Load Met Office LFRic c768 unstructured cubed-sphere quad-mesh cloud amount data.

Parameters:

preferencestr or CloudPreference, optional

The cloud type, which may be low, medium, high, very_high or mesh. Defaults to mesh, the c768 mesh with no data payload attached.

Returns:

SampleUnstructuredXY

The unstructured spatial coordinates and data payload.

Notes

Added in version 0.4.0.

geovista.pantry.data.dynamico()

Download and cache unstructured surface sample data.

Load DYNAMICO icosahedral unstructured mesh.

Returns:

SampleUnstructuredXY

The hexagonal/pentagonal unstructured spatial coordinates and data payload.

Notes

Added in version 0.3.0.

geovista.pantry.data.fesom(step=None)

Download and cache unstructured surface sample data.

Load AWI-CM FESOM 1.4 unstructured mesh.

Parameters:

stepint, default=0

The time-series offset.

Returns:

SampleUnstructuredXY

The unstructured spatial coordinates and data payload.

Notes

Added in version 0.1.0.

geovista.pantry.data.fvcom_tamar()

Download and cache unstructured surface sample data.

Load PML FVCOM unstructured mesh.

Returns:

SampleUnstructuredXY

The unstructured spatial coordinates and data payload.

Notes

Added in version 0.1.0.

geovista.pantry.data.icon_soil()

Download and cache unstructured surface sample data.

Load Icosahedral Nonhydrostatic Weather and Climate Model (ICON) global 160km resolution (R02B04 grid) triangular mesh.

Returns:

SampleUnstructuredXY

The unstructured spatial coordinates and data payload.

Notes

Added in version 0.1.0.

References

Sourced from http://icon-downloads.mpimet.mpg.de/dwd_grids.xml

geovista.pantry.data.lam_equator()

Download and cache unstructured surface sample data.

Load the GungHo C4 cubed-sphere LAM unstructured mesh located over the equator.

Returns:

SampleUnstructuredXY

The unstructured spatial coordinates and connectivity.

Notes

Added in version 0.1.0.

geovista.pantry.data.lam_falklands()

Download and cache unstructured surface sample data.

Load the GungHo C4 cubed-sphere LAM unstructured mesh located over the Falkland Islands.

Returns:

SampleUnstructuredXY

The unstructured spatial coordinates and connectivity.

Notes

Added in version 0.1.0.

geovista.pantry.data.lam_london()

Download and cache unstructured surface sample data.

Load the GungHo C4 cubed-sphere LAM unstructured mesh located over London, UK.

Returns:

SampleUnstructuredXY

The unstructured spatial coordinates and connectivity.

Notes

Added in version 0.1.0.

geovista.pantry.data.lam_new_zealand()

Download and cache unstructured surface sample data.

Load the GungHo C4 cubed-sphere LAM unstructured mesh located over New Zealand.

Returns:

SampleUnstructuredXY

The unstructured spatial coordinates and connectivity.

Notes

Added in version 0.1.0.

geovista.pantry.data.lam_pacific()

Download and cache unstructured surface sample data.

Load a high-resolution LAM unstructured mesh located over the Pacific Ocean.

Returns:

SampleUnstructuredXY

The unstructured spatial coordinates and data payload.

Notes

Added in version 0.1.0.

geovista.pantry.data.lam_polar()

Download and cache unstructured surface sample data.

Load the GungHo C4 cubed-sphere LAM unstructured mesh located over the Polar cap.

Returns:

SampleUnstructuredXY

The unstructured spatial coordinates and connectivity.

Notes

Added in version 0.1.0.

geovista.pantry.data.lam_uk()

Download and cache unstructured surface sample data.

Load the GungHo C4 cubed-sphere LAM unstructured mesh located over the UK.

Returns:

SampleUnstructuredXY

The unstructured spatial coordinates and connectivity.

Notes

Added in version 0.1.0.

geovista.pantry.data.lfric_orog()

Download and cache unstructured surface sample data.

Load CF UGRID global nodal orography unstructured mesh.

Returns:

SampleUnstructuredXY

The unstructured spatial coordinates and data payload.

Notes

Added in version 0.1.0.

geovista.pantry.data.lfric_sst()

Download and cache unstructured surface sample data.

Load CF UGRID global unstructured mesh.

Returns:

SampleUnstructuredXY

The unstructured spatial coordinates and data payload.

Notes

Added in version 0.1.0.

geovista.pantry.data.nemo_orca2()

Download and cache structured surface sample data.

Load NEMO ORCA2 curvilinear mesh.

Returns:

SampleStructuredXY

The curvilinear spatial coordinates and data payload.

Notes

Added in version 0.1.0.

geovista.pantry.data.nemo_orca2_gradient()

Download and cache point-cloud sample data.

Load NEMO ORCA2 curvilinear mesh with gradient filter.

Returns:

SampleStructuredXYZ

The gradient filtered spatial coordinates and data payload.

Notes

Added in version 0.2.0.

geovista.pantry.data.oisst_avhrr_sst()

Download and cache structured surface sample data.

Load NOAA/NCEI OISST AVHRR rectilinear mesh.

Returns:

SampleStructuredXY

The curvilinear spatial coordinates and data payload.

Notes

Added in version 0.1.0.

geovista.pantry.data.usgs_earthquakes()

Download and cache the USGS HoloViz large earthquake dataset.

Returns:

SampleStructuredXYZ

The spatial coordinates and data payload.

Notes

Added in version 0.4.0.

geovista.pantry.data.ww3_global_smc(step=None)

Download and cache unstructured surface sample data.

Load the WAVEWATCH III (WW3) unstructured Spherical Multi-Cell (SMC) mesh.

Parameters:

stepint, default=0

The time-series offset.

Returns:

SampleUnstructuredXY

The unstructured spatial coordinates and data payload.

Notes

Added in version 0.1.0.

geovista.pantry.data.ww3_global_tri()

Download and cache unstructured surface sample data.

Load the WAVEWATCH III (WW3) unstructured triangular mesh.

Returns:

SampleUnstructuredXY

The unstructured spatial coordinates and data payload.

Notes

Added in version 0.1.0.

geovista.pantry.data.CLOUD_AMOUNT_PREFERENCE: str = 'mesh'

The default type of cloud amount mesh.