geovista.pantry.meshes

Download, cache, load and transform geovista sample data into a pyvista mesh.

ノート

Added in version 0.5.0.

属性

LFRIC_RESOLUTION	The default LFRic model unstructured cubed-sphere resolution.
LFRIC_RESOLUTIONS	The available Met Office cubed-sphere assets.
PREFERENCE	The default mesh preference.
REGULAR_RESOLUTION	Default regular grid resolution.
WARP_FACTOR	The default warp factor for mesh points.
ZLEVEL_SCALE_CLOUD	Proportional multiplier for point-cloud levels/offsets.

Functions

cloud_amount(*[, preference])	Create a mesh from geovista.pantry.data sample data.
dynamico()	Create a mesh from geovista.pantry.data sample data.
fesom()	Create a mesh from geovista.pantry.data sample data.
fvcom_tamar(*[, preference, warp, factor])	Create a mesh from geovista.pantry.data sample data.
icon_soil()	Create a mesh from geovista.pantry.data sample data.
lam_equator()	Create a mesh from geovista.pantry.data sample data.
lam_falklands()	Create a mesh from geovista.pantry.data sample data.
lam_london()	Create a mesh from geovista.pantry.data sample data.
lam_new_zealand()	Create a mesh from geovista.pantry.data sample data.
lam_pacific()	Create a mesh from geovista.pantry.data sample data.
lam_polar()	Create a mesh from geovista.pantry.data sample data.
lam_uk()	Create a mesh from geovista.pantry.data sample data.
lfric(*[, resolution])	Load a pre-defined LFRic mesh available from the CACHE.
lfric_orog(*[, warp, factor])	Create a mesh from geovista.pantry.data sample data.
lfric_sst()	Create a mesh from geovista.pantry.data sample data.
nemo_orca2()	Create a mesh from geovista.pantry.data sample data.
nemo_orca2_cloud(*[, zscale])	Create a point-cloud mesh from geovista.pantry.data sample data.
oisst_avhrr_sst()	Create a mesh from geovista.pantry.data sample data.
regular_grid(*[, resolution, radius])	Generate a regular grid given the resolution.
ww3_global_smc(*[, step])	Create a mesh from geovista.pantry.data sample data.
ww3_global_tri()	Create a mesh from geovista.pantry.data sample data.

モジュール内容

geovista.pantry.meshes.cloud_amount(*, preference=None)

Create a mesh from geovista.pantry.data sample data.

Generate a Met Office c768 unstructured cubed-sphere with optional 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:

PolyData

The unstructured cubed-sphere mesh.

ノート

Added in version 0.4.0.

geovista.pantry.meshes.dynamico()

Create a mesh from geovista.pantry.data sample data.

Generate a DYNAMICO icosahedral mesh.

Returns:

PolyData

The DYNAMICO mesh.

ノート

Added in version 0.3.0.

geovista.pantry.meshes.fesom()

Create a mesh from geovista.pantry.data sample data.

Generate a AWI-CM FESOM 1.4 mesh with Sea Surface Temperature data.

Returns:

PolyData

The FESOM mesh.

ノート

Added in version 0.1.0.

geovista.pantry.meshes.fvcom_tamar(*, preference=None, warp=False, factor=None)

Create a mesh from geovista.pantry.data sample data.

Generate a Plymouth Marine Laboratory (PML) Finite Volume Community Ocean Model (FVCOM) mesh of the Tamar Estuaries and Plymouth Sound.

Parameters:

preferencestr or Preference, optional

Render the mesh using cell or point data. Defaults to PREFERENCE.

warpbool, default=False

Warp the mesh nodes by the point data.

factorfloat, optional

The scale factor used to warp the mesh. Defaults to WARP_FACTOR.

Returns:

PolyData

The FVCOM mesh.

ノート

Added in version 0.1.0.

geovista.pantry.meshes.icon_soil()

Create a mesh from geovista.pantry.data sample data.

Generate an Icosahedral Nonhydrostatic Weather and Climate Model (ICON) global 160km resolution (R02B04 grid) triangular mesh with soil type data.

Returns:

PolyData

The ICON mesh.

ノート

Added in version 0.1.0.

geovista.pantry.meshes.lam_equator()

Create a mesh from geovista.pantry.data sample data.

Generate a C4 cubed-sphere Local Area Model (LAM) mesh located at the equator.

Returns:

PolyData

The LAM mesh.

ノート

Added in version 0.1.0.

geovista.pantry.meshes.lam_falklands()

Create a mesh from geovista.pantry.data sample data.

Generate a C4 cubed-sphere Local Area Model (LAM) mesh located over the Falkland Islands.

Returns:

PolyData

The LAM mesh.

ノート

Added in version 0.1.0.

geovista.pantry.meshes.lam_london()

Create a mesh from geovista.pantry.data sample data.

Generate a C4 cubed-sphere Local Area Model (LAM) mesh located over London, United Kingdom.

Returns:

PolyData

The LAM mesh.

ノート

Added in version 0.1.0.

geovista.pantry.meshes.lam_new_zealand()

Create a mesh from geovista.pantry.data sample data.

Generate a C4 cubed-sphere Local Area Model (LAM) mesh located over New Zealand.

Returns:

PolyData

The LAM mesh.

ノート

Added in version 0.1.0.

geovista.pantry.meshes.lam_pacific()

Create a mesh from geovista.pantry.data sample data.

Generate a high-resolution Local Area Model (LAM) mesh located over the Pacific Ocean.

Returns:

PolyData

The LAM mesh.

ノート

Added in version 0.1.0.

geovista.pantry.meshes.lam_polar()

Create a mesh from geovista.pantry.data sample data.

Generate a C4 cubed-sphere Local Area Model (LAM) mesh located over the Polar cap.

Returns:

PolyData

The LAM mesh.

ノート

Added in version 0.1.0.

geovista.pantry.meshes.lam_uk()

Create a mesh from geovista.pantry.data sample data.

Generate a C4 cubed-sphere Local Area Model (LAM) mesh located over the United Kingdom.

Returns:

PolyData

The LAM mesh.

ノート

Added in version 0.1.0.

geovista.pantry.meshes.lfric(*, resolution=None)

Load a pre-defined LFRic mesh available from the CACHE.

Get the LFRic model unstructured cubed-sphere at the specified resolution.

Parameters:

resolutionstr, optional

The resolution of the LFRic model mesh, which may be either c48, c96 or c192. Defaults to LFRIC_RESOLUTION. Also see LFRIC_RESOLUTIONS.

Returns:

PolyData

The LFRic cubed-sphere mesh.

ノート

Added in version 0.1.0.

geovista.pantry.meshes.lfric_orog(*, warp=False, factor=None)

Create a mesh from geovista.pantry.data sample data.

Generate a global surface altitude mesh.

Parameters:

warpbool, default=False

Warp the mesh nodes by the orography point data.

factorfloat, optional

The scale factor used to warp the mesh. Defaults to WARP_FACTOR.

Returns:

PolyData

The orography mesh.

ノート

Added in version 0.1.0.

geovista.pantry.meshes.lfric_sst()

Create a mesh from geovista.pantry.data sample data.

Generate a global Sea Surface Temperature (SST) mesh.

Returns:

PolyData

The SST mesh.

ノート

Added in version 0.1.0.

geovista.pantry.meshes.nemo_orca2()

Create a mesh from geovista.pantry.data sample data.

Generate a global Sea Water Potential Temperature ORCA2 mesh.

Returns:

PolyData

The ORCA2 mesh.

ノート

Added in version 0.1.0.

geovista.pantry.meshes.nemo_orca2_cloud(*, zscale=None)

Create a point-cloud mesh from geovista.pantry.data sample data.

Generate an ORCA2 point-cloud of Sea Water Potential Temperature gradients.

Parameters:

zscalefloat, optional

The proportional multiplier for z-axis zlevel. Defaults to ZLEVEL_SCALE_CLOUD.

Returns:

PolyData

The ORCA2 point-cloud.

ノート

Added in version 0.2.0.

geovista.pantry.meshes.oisst_avhrr_sst()

Create a mesh from geovista.pantry.data sample data.

Generate a global Sea Surface Temperature (SST) NOAA/NCEI OISST AVHRR mesh.

Returns:

PolyData

The SST mesh.

ノート

Added in version 0.1.0.

geovista.pantry.meshes.regular_grid(*, resolution=None, radius=None)

Generate a regular grid given the resolution.

Parameters:

resolutionstr, optional

In the format of rN, where N is the number of cells in latitude, and N * 1.5 cells in longitude. Defaults to REGULAR_RESOLUTION.

radiusfloat, optional

The radius of the sphere. Defaults to geovista.common.RADIUS.

Returns:

PolyData

The regular longitude/latitude grid mesh.

ノート

Added in version 0.3.0.

geovista.pantry.meshes.ww3_global_smc(*, step=None)

Create a mesh from geovista.pantry.data sample data.

Generate a global Sea Surface Wave Significant Height WAVEWATCH III (WW3) Spherical Multi-Cell (SMC) mesh.

Parameters:

stepint, default=0

The time-series offset.

Returns:

PolyData

The WW3 SMC mesh.

ノート

Added in version 0.1.0.

geovista.pantry.meshes.ww3_global_tri()

Create a mesh from geovista.pantry.data sample data.

Generate a global Sea Surface Wave Significant Height WAVEWATCH III (WW3) triangular mesh.

Returns:

PolyData

The WW3 mesh.

ノート

Added in version 0.1.0.

geovista.pantry.meshes.LFRIC_RESOLUTION: str = 'c96'

The default LFRic model unstructured cubed-sphere resolution.

geovista.pantry.meshes.LFRIC_RESOLUTIONS: list[str] = ['c48', 'c96', 'c192']

The available Met Office cubed-sphere assets.

geovista.pantry.meshes.PREFERENCE: geovista.common.Preference

The default mesh preference.

geovista.pantry.meshes.REGULAR_RESOLUTION: str = 'r60'

Default regular grid resolution.

geovista.pantry.meshes.WARP_FACTOR: float = 2e-05

The default warp factor for mesh points.

geovista.pantry.meshes.ZLEVEL_SCALE_CLOUD: float = 1e-05

Proportional multiplier for point-cloud levels/offsets.