Add NetCDFCFReader support Network Common Data Form

[tkoyama010]

Overview

Add NetCDFCFReader support Network Common Data Form.

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()

Details

• https://vtk.org/doc/nightly/html/classvtkNetCDFCFReader.html
• https://en.wikipedia.org/wiki/NetCDF

[codecov]

Codecov Report

Attention: Patch coverage is 87.50000% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 96.97%. Comparing base (06e7a8f) to head (2e1b830).
Report is 3 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff            @@
##             main    #6027    +/-   ##
========================================
  Coverage   96.96%   96.97%            
========================================
  Files         141      141            
  Lines       24532    24655   +123     
========================================
+ Hits        23788    23909   +121     
- Misses        744      746     +2     

[tkoyama010]

@pyvista-bot preview

[tkoyama010]

@pyvista-bot preview

[tkoyama010]

@pyvista-bot preview

[pyvista-bot]

🚀 Deployed on https://6635f72aa93f24c652cbe63e--meek-duckanoo-d2f5ec.netlify.app

[pyvista-bot]

🚀 Deployed on https://6635f7978606ebc73ab38d2e--meek-duckanoo-d2f5ec.netlify.app

[pyvista-bot]

🚀 Deployed on https://6635fc12a93f24c949cbe669--meek-duckanoo-d2f5ec.netlify.app

[tkoyama010]

@bjlittle I guess you are interested in this reader.

[bjlittle]

@tkoyama010 Yup, sure am ... But it's not clear to me how you control deserializing the variables in the NetCDF file into a mesh.

I'm guessing it's not truly generic and must conform to a specific format for the VTK reader.

I'll hit the VTK docs and look at the example NetCDF file ...

[bjlittle]

@tkoyama010 This looks like a great addition 😄

Note that, you should probably update the supported file types and readers in the doc-string of get_reader for the ".nc" supported files.

Also, as an aside, the example file that you load tos_O1_2001-2002.nc has a time dimension with 24 time steps ... is it possible to control from the NetCDFCFReader API which index in the time dimension will be loaded into the tos variable on the resultant mesh?

[tkoyama010]

Note that, you should probably update the supported file types and readers in the doc-string of get_reader for the ".nc" supported files.

Thanks! Resolved in 50489ca.

Also, as an aside, the example file that you load tos_O1_2001-2002.nc has a time dimension with 24 time steps ... is it possible to control from the NetCDFCFReader API which index in the time dimension will be loaded into the tos variable on the resultant mesh?

Good idea! I'm checking to see if we can use any vtkNetCDFReader methods.

[bjlittle]

@tkoyama010 Once you've resolved your conflicts, then we can bank this pull-request 👍

I wouldn't expect you to extend the API of the reader in this pull-request to control features of the NetCDF reader ... save that for another time.

But I'd love to know whether you think this is easily possible and what it would involve.

[tkoyama010]

Also, as an aside, the example file that you load tos_O1_2001-2002.nc has a time dimension with 24 time steps ... is it possible to control from the NetCDFCFReader API which index in the time dimension will be loaded into the tos variable on the resultant mesh?

I found it and will add it as property to this Reader.
Need to search more.

https://gitlab.kitware.com/vtk/vtk/-/blob/v9.3.0/IO/NetCDF/Testing/Python/NetCDFReader.py#L27

reader.SetVariableArrayStatus("tos",1)

Note

• https://vtk.org/doc/nightly/html/classvtkNetCDFReader.html