Add NetCDFCFReader support Network Common Data Form

doc/source/api/readers/index.rst

@@ -42,6 +42,7 @@ Reader Classes
     MFIXReader
     MetaImageReader
     MultiBlockPlot3DReader
+    NetCDFCFReader
     NIFTIReader
     NRRDReader
     OBJReader

pyvista/core/utilities/__init__.py

@@ -189,6 +189,7 @@
     MetaImageReader,
     MFIXReader,
     MultiBlockPlot3DReader,
+    NetCDFCFReader,
     NIFTIReader,
     NRRDReader,
     OBJReader,

pyvista/core/utilities/reader.py

@@ -92,6 +92,8 @@ def get_reader(filename, force_ext=None):
     +----------------+---------------------------------------------+
     | ``.mhd``       | :class:`pyvista.MetaImageReader`            |
     +----------------+---------------------------------------------+
+    | ``.nc``        | :class:`pyvista.NetCDFReader`               |
+    +----------------+---------------------------------------------+
     | ``.nii``       | :class:`pyvista.NIFTIReader`                |
     +----------------+---------------------------------------------+
     | ``.nii.gz``    | :class:`pyvista.NIFTIReader`                |
@@ -2577,6 +2579,27 @@ class GambitReader(BaseReader):
     _vtk_class_name = "vtkGAMBITReader"
 
 
+class NetCDFCFReader(BaseReader):
+    """NetCDFCFReader for .nc files.
+
+    .. versionadded:: 0.44.0
+
+    Examples
+    --------
+    >>> import pyvista as pv
+    >>> from pyvista import examples
+    >>> filename = examples.download_tos_O1_2001_2002(load=False)
+    >>> reader = pv.get_reader(filename)
+    >>> grid = reader.read()
+    >>> _ = grid.set_active_scalars("tos")
+    >>> grid.plot()
+
+    """
+
+    _vtk_module_name = "vtkIONetCDF"
+    _vtk_class_name = "vtkNetCDFCFReader"
+
+
 CLASS_READERS = {
     # Standard dataset readers:
     '.bmp': BMPReader,
@@ -2601,6 +2624,7 @@ class GambitReader(BaseReader):
     '.jpg': JPEGReader,
     '.mha': MetaImageReader,
     '.mhd': MetaImageReader,
+    '.nc': NetCDFCFReader,
     '.neu': GambitReader,
     '.nhdr': NRRDReader,
     '.nii': NIFTIReader,

pyvista/examples/downloads.py

@@ -7750,3 +7750,44 @@ def download_prism(load=True):  # pragma: no cover
 
 
 _dataset_prism = _SingleFileDownloadableDatasetLoader('prism.neu')
+
+
+def download_tos_O1_2001_2002(load=True):  # pragma: no cover
+    """Download the TOS_O1_2001_2002 dataset.
+
+    Sea surface temperatures collected by PCMDI for use by the IPCC.
+    From `Example netCDF files <https://www.unidata.ucar.edu/software/netcdf/examples/files.html>`_ .
+
+    .. versionadded:: 0.44.0
+
+    Parameters
+    ----------
+    load : bool, default: True
+        Load the dataset after downloading it when ``True``.  Set this
+        to ``False`` and only the filename will be returned.
+
+    Returns
+    -------
+    pyvista.ImageData | str
+        DataSet or filename depending on ``load``.
+
+    Examples
+    --------
+    >>> import pyvista as pv
+    >>> from pyvista import examples
+    >>> filename = examples.download_tos_O1_2001_2002(load=False)
+    >>> reader = pv.get_reader(filename)
+    >>> grid = reader.read()
+    >>> _ = grid.set_active_scalars("tos")
+    >>> grid.plot()
+
+    .. seealso::
+
+        :ref:`TOS_O1_2001_2002 Dataset <tos_o1_2001_2002_dataset>`
+            See this dataset in the Dataset Gallery for more info.
+
+    """
+    return _download_dataset(_dataset_tos_O1_2001_2002, load=load)
+
+
+_dataset_tos_O1_2001_2002 = _SingleFileDownloadableDatasetLoader('tos_O1_2001-2002.nc')

tests/core/test_reader.py

@@ -1036,3 +1036,13 @@ def test_gambitreader():
 
     mesh = reader.read()
     assert all([mesh.n_points, mesh.n_cells])
+
+
+def test_netcdfcfreader():
+    filename = examples.download_tos_O1_2001_2002(load=False)
+    reader = pv.get_reader(filename)
+    assert isinstance(reader, pv.NetCDFCFReader)
+    assert reader.path == filename
+
+    mesh = reader.read()
+    assert all([mesh.n_points, mesh.n_cells])