CGNS

About

The CFD General Notation System (CGNS) provides a standard for recording and recovering computer data associated with the numerical solution of fluid dynamics equations.

Bugs/Feature and issue tracking

https://github.com/CGNS/CGNS/issues

Installation

Installation Instructions using cmake

1. Install HDF5 on your system.

• HDF5 can use the standard GNU autotools, so ./configure, make, sudo make install should install HDF5 without problems on most systems.
  1. Unpack the tar ball containing the source code into some directory.
  2. Create a new directory in which to build the library.
  3. Use cmake to initialize the build tree. shell user@hostname:build_path$ cmake /path/to/cgns/sources/
  4. Use ccmake to edit the control variables as needed. shell user@hostname:build_path$ ccmake .
• The path to the HDF5 library should be specified with CMAKE_PREFIX_PATH=$HDF_DIR for linking with a specific HDF5 version.
  • If HDF5 is built with parallel-IO support via MPI, the HDF5_NEED_MPI flag must be set to true.
  • If HDF5 is built with zlib and szip support, these need to be flagged with HDF5_NEED_ZLIB and HDF5_NEED_SZIP as well as the paths for those libraries.
• Fortran can be enabled by toggling the CGNS_ENABLE_FORTRAN variable.
  • A view of the attempt to autodetect the correct interface between Fortran and C is show, setting the value of FORTRAN_NAMING.
  • For gfortran and pgf90 the value of FORTRAN_NAMING should be LOWERCASE_.
• The build system must be reconfigured after variable changes by pressing c. Variables who's value has changed are marked with a * in the interface.
• After configuration, the Makefiles must be generated by pressing g.
  1. Use cmake to build the library. shell user@hostname:build_path$ cmake --build .
• A colorized review of the build process should follow.
• It will use make as a backend by default (ninja can also be used as a cmake backend)
  1. Installation of the library. shell user@hostname:build_path$ cmake --install .
• You must have permissions to alter the directory where CGNS will be installed.
• The installation is accomplished with the install target of the makefile (in case of a make backend)

Installation Instructions using make

1. Install HDF5 on your system.
   • HDF5 can use the standard GNU autotools, so ./configure, make, sudo make install should install HDF5 without problems on most systems.
2. Typically the standard ./configure, make, make install will suffice.
   
3. Sample scripts for building parallel CGNS can be found in src/SampleScripts.

License

The distribution and use of the CGNS software is covered by the following license:

This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.

2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.

3. This notice may not be removed or altered from any source distribution.

This license is borrowed from the zlib/libpng License:

https://opensource.org/license/zlib

and supersedes the GNU Lesser General Public License (LGPL) which previously governed the use and distribution of the software.

For details on the policy governing the distribution of the CGNS standard and software see:

https://cgns.github.io/governance/committee.html#distribution

Development

CGNS exists thanks to the contribution of many people. CGNS employs a gitflow branching model, which is summarized as follows ^1: