:py:mod:`geovista.pantry.meshes` ================================ .. py:module:: geovista.pantry.meshes .. autoapi-nested-parse:: Download, cache, load and transform geovista sample data into a pyvista mesh. Notes ----- .. versionadded:: 0.5.0 .. !! processed by numpydoc !! Module Contents --------------- Functions ~~~~~~~~~ .. autoapisummary:: geovista.pantry.meshes.cloud_amount geovista.pantry.meshes.dynamico geovista.pantry.meshes.fesom geovista.pantry.meshes.fvcom_tamar geovista.pantry.meshes.icon_soil geovista.pantry.meshes.lam_equator geovista.pantry.meshes.lam_falklands geovista.pantry.meshes.lam_london geovista.pantry.meshes.lam_new_zealand geovista.pantry.meshes.lam_pacific geovista.pantry.meshes.lam_polar geovista.pantry.meshes.lam_uk geovista.pantry.meshes.lfric geovista.pantry.meshes.lfric_orog geovista.pantry.meshes.lfric_sst geovista.pantry.meshes.nemo_orca2 geovista.pantry.meshes.nemo_orca2_cloud geovista.pantry.meshes.oisst_avhrr_sst geovista.pantry.meshes.regular_grid geovista.pantry.meshes.ww3_global_smc geovista.pantry.meshes.ww3_global_tri Attributes ~~~~~~~~~~ .. autoapisummary:: geovista.pantry.meshes.LFRIC_RESOLUTION geovista.pantry.meshes.LFRIC_RESOLUTIONS geovista.pantry.meshes.PREFERENCE geovista.pantry.meshes.REGULAR_RESOLUTION geovista.pantry.meshes.WARP_FACTOR geovista.pantry.meshes.ZLEVEL_SCALE_CLOUD .. py:function:: cloud_amount(preference = None) Create a mesh from :mod:`geovista.pantry.data` sample data. Generate a Met Office c768 unstructured cubed-sphere with optional cloud amount data. :Parameters: **preference** : :class:`python:str` or :obj:`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: :obj:`PolyData ` The unstructured cubed-sphere mesh. .. rubric:: Notes .. versionadded:: 0.4.0 .. !! processed by numpydoc !! .. py:function:: dynamico() Create a mesh from :mod:`geovista.pantry.data` sample data. Generate a DYNAMICO icosahedral mesh. :Returns: :obj:`PolyData ` The DYNAMICO mesh. .. rubric:: Notes .. versionadded:: 0.3.0 .. !! processed by numpydoc !! .. py:function:: fesom() Create a mesh from :mod:`geovista.pantry.data` sample data. Generate a AWI-CM FESOM 1.4 mesh with Sea Surface Temperature data. :Returns: :obj:`PolyData ` The FESOM mesh. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: fvcom_tamar(preference = None, warp = False, factor = None) Create a mesh from :mod:`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: **preference** : :class:`python:str` or :obj:`Preference `, optional Render the mesh using ``cell`` or ``point`` data. Defaults to :data:`PREFERENCE`. **warp** : :class:`python:bool`, default=False Warp the mesh nodes by the ``point`` data. **factor** : :class:`python:float`, optional The scale factor used to warp the mesh. Defaults to :data:`WARP_FACTOR`. :Returns: :obj:`PolyData ` The FVCOM mesh. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: icon_soil() Create a mesh from :mod:`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: :obj:`PolyData ` The ICON mesh. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: lam_equator() Create a mesh from :mod:`geovista.pantry.data` sample data. Generate a C4 cubed-sphere Local Area Model (LAM) mesh located at the equator. :Returns: :obj:`PolyData ` The LAM mesh. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: lam_falklands() Create a mesh from :mod:`geovista.pantry.data` sample data. Generate a C4 cubed-sphere Local Area Model (LAM) mesh located over the Falkland Islands. :Returns: :obj:`PolyData ` The LAM mesh. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: lam_london() Create a mesh from :mod:`geovista.pantry.data` sample data. Generate a C4 cubed-sphere Local Area Model (LAM) mesh located over London, United Kingdom. :Returns: :obj:`PolyData ` The LAM mesh. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: lam_new_zealand() Create a mesh from :mod:`geovista.pantry.data` sample data. Generate a C4 cubed-sphere Local Area Model (LAM) mesh located over New Zealand. :Returns: :obj:`PolyData ` The LAM mesh. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: lam_pacific() Create a mesh from :mod:`geovista.pantry.data` sample data. Generate a high-resolution Local Area Model (LAM) mesh located over the Pacific Ocean. :Returns: :obj:`PolyData ` The LAM mesh. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: lam_polar() Create a mesh from :mod:`geovista.pantry.data` sample data. Generate a C4 cubed-sphere Local Area Model (LAM) mesh located over the Polar cap. :Returns: :obj:`PolyData ` The LAM mesh. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: lam_uk() Create a mesh from :mod:`geovista.pantry.data` sample data. Generate a C4 cubed-sphere Local Area Model (LAM) mesh located over the United Kingdom. :Returns: :obj:`PolyData ` The LAM mesh. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: lfric(resolution = None) Load a pre-defined LFRic mesh available from the :obj:`~geovista.cache.CACHE`. Get the LFRic model unstructured cubed-sphere at the specified `resolution`. :Parameters: **resolution** : :class:`python:str`, optional The resolution of the LFRic model mesh, which may be either ``c48``, ``c96`` or ``c192``. Defaults to :data:`LFRIC_RESOLUTION`. Also see :data:`LFRIC_RESOLUTIONS`. :Returns: :obj:`PolyData ` The LFRic cubed-sphere mesh. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: lfric_orog(warp = False, factor = None) Create a mesh from :mod:`geovista.pantry.data` sample data. Generate a global surface altitude mesh. :Parameters: **warp** : :class:`python:bool`, default=False Warp the mesh nodes by the orography ``point`` data. **factor** : :class:`python:float`, optional The scale factor used to warp the mesh. Defaults to :data:`WARP_FACTOR`. :Returns: :obj:`PolyData ` The orography mesh. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: lfric_sst() Create a mesh from :mod:`geovista.pantry.data` sample data. Generate a global Sea Surface Temperature (SST) mesh. :Returns: :obj:`PolyData ` The SST mesh. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: nemo_orca2() Create a mesh from :mod:`geovista.pantry.data` sample data. Generate a global Sea Water Potential Temperature ORCA2 mesh. :Returns: :obj:`PolyData ` The ORCA2 mesh. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: nemo_orca2_cloud(zscale = None) Create a point-cloud mesh from :mod:`geovista.pantry.data` sample data. Generate an ORCA2 point-cloud of Sea Water Potential Temperature gradients. :Parameters: **zscale** : :class:`python:float`, optional The proportional multiplier for z-axis ``zlevel``. Defaults to :data:`ZLEVEL_SCALE_CLOUD`. :Returns: :obj:`PolyData ` The ORCA2 point-cloud. .. rubric:: Notes .. versionadded:: 0.2.0 .. !! processed by numpydoc !! .. py:function:: oisst_avhrr_sst() Create a mesh from :mod:`geovista.pantry.data` sample data. Generate a global Sea Surface Temperature (SST) NOAA/NCEI OISST AVHRR mesh. :Returns: :obj:`PolyData ` The SST mesh. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: regular_grid(resolution = None, radius = None) Generate a regular grid given the `resolution`. :Parameters: **resolution** : :class:`python:str`, optional In the format of ``rN``, where ``N`` is the number of cells in latitude, and ``N * 1.5`` cells in longitude. Defaults to :data:`REGULAR_RESOLUTION`. **radius** : :class:`python:float`, optional The radius of the sphere. Defaults to :data:`geovista.common.RADIUS`. :Returns: :obj:`PolyData ` The regular longitude/latitude grid mesh. .. rubric:: Notes .. versionadded:: 0.3.0 .. !! processed by numpydoc !! .. py:function:: ww3_global_smc(step = None) Create a mesh from :mod:`geovista.pantry.data` sample data. Generate a global Sea Surface Wave Significant Height WAVEWATCH III (WW3) Spherical Multi-Cell (SMC) mesh. :Parameters: **step** : :class:`python:int`, default=0 The time-series offset. :Returns: :obj:`PolyData ` The WW3 SMC mesh. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: ww3_global_tri() Create a mesh from :mod:`geovista.pantry.data` sample data. Generate a global Sea Surface Wave Significant Height WAVEWATCH III (WW3) triangular mesh. :Returns: :obj:`PolyData ` The WW3 mesh. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:data:: LFRIC_RESOLUTION :type: str :value: 'c96' The default LFRic model unstructured cubed-sphere resolution. .. !! processed by numpydoc !! .. py:data:: LFRIC_RESOLUTIONS :type: list[str] :value: ['c48', 'c96', 'c192'] The available Met Office cubed-sphere assets. .. !! processed by numpydoc !! .. py:data:: PREFERENCE :type: geovista.common.Preference The default mesh preference. .. !! processed by numpydoc !! .. py:data:: REGULAR_RESOLUTION :type: str :value: 'r60' Default regular grid resolution. .. !! processed by numpydoc !! .. py:data:: WARP_FACTOR :type: float :value: 2e-05 The default warp factor for mesh points. .. !! processed by numpydoc !! .. py:data:: ZLEVEL_SCALE_CLOUD :type: float :value: 1e-05 Proportional multiplier for point-cloud levels/offsets. .. !! processed by numpydoc !!