:py:mod:`geovista.pantry.data` ============================== .. py:module:: geovista.pantry.data .. autoapi-nested-parse:: Download, cache and load geovista sample data. Notes ----- .. versionadded:: 0.5.0 .. !! processed by numpydoc !! Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: geovista.pantry.data.CloudPreference geovista.pantry.data.SampleStructuredXY geovista.pantry.data.SampleStructuredXYZ geovista.pantry.data.SampleUnstructuredXY Functions ~~~~~~~~~ .. autoapisummary:: geovista.pantry.data.capitalise geovista.pantry.data.cloud_amount geovista.pantry.data.dynamico geovista.pantry.data.fesom geovista.pantry.data.fvcom_tamar geovista.pantry.data.icon_soil geovista.pantry.data.lam_equator geovista.pantry.data.lam_falklands geovista.pantry.data.lam_london geovista.pantry.data.lam_new_zealand geovista.pantry.data.lam_pacific geovista.pantry.data.lam_polar geovista.pantry.data.lam_uk geovista.pantry.data.lfric_orog geovista.pantry.data.lfric_sst geovista.pantry.data.nemo_orca2 geovista.pantry.data.nemo_orca2_gradient geovista.pantry.data.oisst_avhrr_sst geovista.pantry.data.usgs_earthquakes geovista.pantry.data.ww3_global_smc geovista.pantry.data.ww3_global_tri Attributes ~~~~~~~~~~ .. autoapisummary:: geovista.pantry.data.CLOUD_AMOUNT_PREFERENCE .. py:class:: CloudPreference(*args, **kwds) Bases: :py:obj:`geovista.common.MixinStrEnum`, :py:obj:`enum.Enum` Enumeration of mesh types for cloud amount. .. rubric:: Notes .. versionadded:: 0.4.0 .. !! processed by numpydoc !! .. py:attribute:: HIGH :value: 'high' .. py:attribute:: LOW :value: 'low' .. py:attribute:: MEDIUM :value: 'medium' .. py:attribute:: MESH :value: 'mesh' .. py:attribute:: VERY_HIGH :value: 'very_high' .. py:class:: SampleStructuredXY Data container for structured surface. .. !! processed by numpydoc !! .. py:attribute:: data :type: numpy.typing.ArrayLike .. py:attribute:: lats :type: numpy.typing.ArrayLike .. py:attribute:: lons :type: numpy.typing.ArrayLike .. py:attribute:: name :type: str .. py:attribute:: ndim :type: int :value: 2 .. py:attribute:: steps :type: int .. py:attribute:: units :type: str .. py:class:: SampleStructuredXYZ Data container for structured volume. .. !! processed by numpydoc !! .. py:attribute:: data :type: numpy.typing.ArrayLike .. py:attribute:: lats :type: numpy.typing.ArrayLike .. py:attribute:: lons :type: numpy.typing.ArrayLike .. py:attribute:: name :type: str .. py:attribute:: ndim :type: int :value: 3 .. py:attribute:: steps :type: int .. py:attribute:: units :type: str .. py:attribute:: zlevel :type: numpy.typing.ArrayLike .. py:class:: SampleUnstructuredXY Data container for unstructured surface. .. !! processed by numpydoc !! .. py:attribute:: connectivity :type: numpy.typing.ArrayLike .. py:attribute:: data :type: numpy.typing.ArrayLike .. py:attribute:: face :type: numpy.typing.ArrayLike .. py:attribute:: lats :type: numpy.typing.ArrayLike .. py:attribute:: lons :type: numpy.typing.ArrayLike .. py:attribute:: name :type: str .. py:attribute:: ndim :type: int :value: 2 .. py:attribute:: node :type: numpy.typing.ArrayLike .. py:attribute:: start_index :type: int .. py:attribute:: steps :type: int .. py:attribute:: units :type: str .. py:function:: capitalise(title) Capitalise each word and replace inappropriate characters. :Parameters: **title** : :class:`python:str` The string title to be reformatted. :Returns: :class:`python:str` The capitalised title. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: 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: **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:`SampleUnstructuredXY` The unstructured spatial coordinates and data payload. .. rubric:: Notes .. versionadded:: 0.4.0 .. !! processed by numpydoc !! .. py:function:: dynamico() Download and cache unstructured surface sample data. Load DYNAMICO icosahedral unstructured mesh. :Returns: :obj:`SampleUnstructuredXY` The hexagonal/pentagonal unstructured spatial coordinates and data payload. .. rubric:: Notes .. versionadded:: 0.3.0 .. !! processed by numpydoc !! .. py:function:: fesom(step = None) Download and cache unstructured surface sample data. Load AWI-CM FESOM 1.4 unstructured mesh. :Parameters: **step** : :class:`python:int`, default=0 The time-series offset. :Returns: :obj:`SampleUnstructuredXY` The unstructured spatial coordinates and data payload. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: fvcom_tamar() Download and cache unstructured surface sample data. Load PML FVCOM unstructured mesh. :Returns: :obj:`SampleUnstructuredXY` The unstructured spatial coordinates and data payload. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: 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: :obj:`SampleUnstructuredXY` The unstructured spatial coordinates and data payload. .. rubric:: Notes .. versionadded:: 0.1.0 .. rubric:: References Sourced from http://icon-downloads.mpimet.mpg.de/dwd_grids.xml .. only:: latex .. !! processed by numpydoc !! .. py:function:: lam_equator() Download and cache unstructured surface sample data. Load the GungHo C4 cubed-sphere LAM unstructured mesh located over the equator. :Returns: :obj:`SampleUnstructuredXY` The unstructured spatial coordinates and connectivity. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: lam_falklands() Download and cache unstructured surface sample data. Load the GungHo C4 cubed-sphere LAM unstructured mesh located over the Falkland Islands. :Returns: :obj:`SampleUnstructuredXY` The unstructured spatial coordinates and connectivity. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: lam_london() Download and cache unstructured surface sample data. Load the GungHo C4 cubed-sphere LAM unstructured mesh located over London, UK. :Returns: :obj:`SampleUnstructuredXY` The unstructured spatial coordinates and connectivity. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: lam_new_zealand() Download and cache unstructured surface sample data. Load the GungHo C4 cubed-sphere LAM unstructured mesh located over New Zealand. :Returns: :obj:`SampleUnstructuredXY` The unstructured spatial coordinates and connectivity. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: lam_pacific() Download and cache unstructured surface sample data. Load a high-resolution LAM unstructured mesh located over the Pacific Ocean. :Returns: :obj:`SampleUnstructuredXY` The unstructured spatial coordinates and data payload. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: lam_polar() Download and cache unstructured surface sample data. Load the GungHo C4 cubed-sphere LAM unstructured mesh located over the Polar cap. :Returns: :obj:`SampleUnstructuredXY` The unstructured spatial coordinates and connectivity. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: lam_uk() Download and cache unstructured surface sample data. Load the GungHo C4 cubed-sphere LAM unstructured mesh located over the UK. :Returns: :obj:`SampleUnstructuredXY` The unstructured spatial coordinates and connectivity. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: lfric_orog() Download and cache unstructured surface sample data. Load CF UGRID global nodal orography unstructured mesh. :Returns: :obj:`SampleUnstructuredXY` The unstructured spatial coordinates and data payload. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: lfric_sst() Download and cache unstructured surface sample data. Load CF UGRID global unstructured mesh. :Returns: :obj:`SampleUnstructuredXY` The unstructured spatial coordinates and data payload. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: nemo_orca2() Download and cache structured surface sample data. Load NEMO ORCA2 curvilinear mesh. :Returns: :obj:`SampleStructuredXY` The curvilinear spatial coordinates and data payload. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: nemo_orca2_gradient() Download and cache point-cloud sample data. Load NEMO ORCA2 curvilinear mesh with gradient filter. :Returns: :obj:`SampleStructuredXYZ` The gradient filtered spatial coordinates and data payload. .. rubric:: Notes .. versionadded:: 0.2.0 .. !! processed by numpydoc !! .. py:function:: oisst_avhrr_sst() Download and cache structured surface sample data. Load NOAA/NCEI OISST AVHRR rectilinear mesh. :Returns: :obj:`SampleStructuredXY` The curvilinear spatial coordinates and data payload. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: usgs_earthquakes() Download and cache the USGS HoloViz large earthquake dataset. :Returns: :obj:`SampleStructuredXYZ` The spatial coordinates and data payload. .. rubric:: Notes .. versionadded:: 0.4.0 .. !! processed by numpydoc !! .. py:function:: ww3_global_smc(step = None) Download and cache unstructured surface sample data. Load the WAVEWATCH III (WW3) unstructured Spherical Multi-Cell (SMC) mesh. :Parameters: **step** : :class:`python:int`, default=0 The time-series offset. :Returns: :obj:`SampleUnstructuredXY` The unstructured spatial coordinates and data payload. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:function:: ww3_global_tri() Download and cache unstructured surface sample data. Load the WAVEWATCH III (WW3) unstructured triangular mesh. :Returns: :obj:`SampleUnstructuredXY` The unstructured spatial coordinates and data payload. .. rubric:: Notes .. versionadded:: 0.1.0 .. !! processed by numpydoc !! .. py:data:: CLOUD_AMOUNT_PREFERENCE :type: str :value: 'mesh' The default type of cloud amount mesh. .. !! processed by numpydoc !!