The package gathers various tools and libraries for CGNS end-users and Python application developpers. The The main object of pyCGNS is to provide the application developpers with a Python interface to CGNS/SIDS, the CGNS data model. The CFD General Notation System (CGNS) is both a data model for CFD and an implementation of this data model. CGNS should not be reduced to a file format and you can understand why by using pyCGNS without any file at all for your actual CFD data!
There are seven sub-modules in pyCGNS, some of them are libraries of functions, some other are tools and some are gathering various scripts and examples. The MAP and PAT modules are the most important modules: map the CGNS/SIDS data model the CGNS/Python implementation. The WRA module contains wrapper on CGNS/MLL and a MLL-like set of functions that uses the CGNS/Python mapping as implementation. The NAV module supports the CGNS.NAV graphical browser, with nice features about tree exploration, copy/paste and even global node changes. Then, the VAL module is a parser engine for CGNS/Python tree compliance checking. The CGNS.VAL tool can analyze your CGNS/HDF5 file and returns you a list of diagnostics.
The package uses numpy, cython and HDF5 you should install before pyCGNS. The CGNS.NAV graphical tool uses Qt and has a VTK viewer, the tool requires the Qt libs, VTK libs and their python interfaces. The CGNS/SIDS data model has a mapping the HDF5 for file storage. The MAP module uses CHLone instead of CGNS/MLL to map its CGNS/Python trees to HDF5.
The listed chapters are the introduction chapters, each MAP, PAT, WRA, NAV, VAL module has its own documentation which doesn’t appear below. Click on the modules icons above to get their documentation.