mirror of
https://github.com/Unidata/netcdf-cxx4.git
synced 2024-11-27 07:49:52 +08:00
79 lines
2.9 KiB
Markdown
79 lines
2.9 KiB
Markdown
[](https://travis-ci.org/Unidata/netcdf-cxx4)
|
|
|
|
netcdf-cxx4
|
|
===========
|
|
|
|
Official GitHub repository for netCDF-4 C++ library.
|
|
|
|
Note: The latest release of the historic C++ libraries, netCDF-4.2, may be downloaded from the following page:
|
|
|
|
* http://www.unidata.ucar.edu/downloads/netcdf/index.jsp
|
|
|
|
### Introduction
|
|
|
|
Lynton Appel, of the Culham Centre for Fusion Energy (CCFE) in
|
|
Oxfordshire, has developed and contributed a
|
|
Oxfordshire, has developed and contributed a
|
|
[netCDF-4 C++ library][netcdf-cxx4] that depends on an installed
|
|
netCDF-4 C library. The netCDF-4 C++ API was developed for use in
|
|
managing fusion research data from CCFE's innovative MAST (Mega Amp
|
|
Spherical Tokamak) experiment.
|
|
|
|
[netcdf-cxx4]: http://www.unidata.ucar.edu/downloads/netcdf/netcdf-cxx/
|
|
|
|
Appel's C++ implementation is a complete read/write interface for
|
|
netCDF-4, but can also be used as an alternative to the older netCDF-3
|
|
C++ interface, to write classic-format netCDF-3 files as well as
|
|
netCDF-4 classic model files. The new API is implemented as a layer
|
|
over the netCDF-4 C interface, which means bug fixes and performance
|
|
enhancements in the C interface will be immediately available to C++
|
|
developers as well. It replaces a previous partial netCDF-4 C++
|
|
interface developed by Shanna Forbes.
|
|
|
|
The new API makes use of standard C++ features such as namespaces,
|
|
exceptions, and templates, none of which were included in the first
|
|
netCDF-3 C++ API developed in the mid-90's. The earlier netCDF-3 C++
|
|
API is still supported and available in the source distribution, but
|
|
developers who are thinking of eventually upgrading to use of the
|
|
enhanced data model should consider using Lynton's new API.
|
|
|
|
We're grateful for Appel's development and CCFE's contribution of the
|
|
new open-source code for the netCDF-4 C++ API, and hope C++ developers
|
|
in the netCDF community will find it useful! Feedback is appreciated,
|
|
and should be directed to [Lynton Appel][la_email].
|
|
|
|
[la_email]: mailto:Lynton.Appel@ccfe.ac.uk
|
|
|
|
### Installation
|
|
|
|
Installing the C++ interface requires the additional flag
|
|
--enable-netcdf-4 to be used during the configure stage of the
|
|
installation, for example enter
|
|
|
|
./configure --enable-cxx-4 [plus other options]
|
|
|
|
Note that the "configure" script must be generated using
|
|
|
|
autoreconf -if
|
|
|
|
To build the C++ interface guide, change to the cxx4 directory of the
|
|
distribution and enter
|
|
|
|
doxygen
|
|
|
|
By default, HTML documentation will be installed in cxx4/doc/html;
|
|
other options may be specified according to the settings contained in
|
|
the file "Doxyfile" (details of alternative settings are documented at
|
|
[doxygen][dox_l]). Note that as a prerequisite for generating the
|
|
documentation, the system will need to have doxygen and
|
|
[Graphviz][g_l] installed.
|
|
|
|
|
|
[dox_l]: http://www.stack.nl/~dimitri/doxygen
|
|
[g_l]: http://www.graphviz.org/
|
|
|
|
|
|
### Examples of usage
|
|
|
|
Examples codes can be found by selecting the "Examples" tab.
|