f1eaefd91e
Update the following documentation files:
## docs/FAQ.md
* Discuss the use of UTF-8 names under Windows 10+.
## docs/filters.md
* Add documentation about NCzarr filters.
* Specifically Codec support and HDF5 <-> Codec translation
* Add documentation about standard filters
## docs/dispatch.md
* Convert from .dox format to .md (markdown) format.
* Add discussion about the user defined dispatch tables.
* Update the example.
* Abbreviate the NC_infermodel documentation and move the more detailed discusion to the companion *dinternal.md* documenation.
## docs/internal.md
This is a (mostly) new file that attempts to provide detailed
descriptions about how various features are implemented inside
the netcdf-c library. The topics currently covered the
following.
### Including C++ Code in the netcdf-c Library {#intern_c++}
The state of C compiler technology has reached the point where
it is possible to include C++ code into the netcdf-c library
code base. The document describes how to do this.
### Managing instances of complex data types
The document describes how to properly handle instances of
complex types (those with variable length). This involves
having functions that can recursively walk instances of such
types to perform various actions on them. These new functions
are intended to replace the *nc_free_vlen*, *nc_free_vlens* and
*nc_free_string* functions in *netcdf.h*.
### Inferring File Types
As described in the companion document -- docs/dispatch.md --
when *nc\_create()* or *nc\_open()* is called, the library must
figure out what kind of file is being created or opened. Once it
has figured out the file kind, the appropriate "dispatch table"
can be used to process that file.
As a result of the introduction of remote data access to the netcdf-c
library, the path arguments to *nc\_open()* and *nc\_create()* have
been extended to support URLs as paths. Processing URLs requires
some significant changes to the file inference algorithm. The
details of that processing are recorded in the document.
|
||
|---|---|---|
| .github | ||
| cmake | ||
| conda.recipe | ||
| ctest_scripts | ||
| dap4_test | ||
| docs | ||
| examples | ||
| fuzz | ||
| h5_test | ||
| hdf4_test | ||
| include | ||
| libdap2 | ||
| libdap4 | ||
| libdispatch | ||
| libhdf4 | ||
| libhdf5 | ||
| liblib | ||
| libncpoco | ||
| libncxml | ||
| libnczarr | ||
| libsrc | ||
| libsrc4 | ||
| libsrcp | ||
| nc_perf | ||
| nc_test | ||
| nc_test4 | ||
| ncdap_test | ||
| ncdump | ||
| ncgen | ||
| ncgen3 | ||
| nctest | ||
| nczarr_test | ||
| NUG | ||
| oc2 | ||
| plugins | ||
| unit_test | ||
| .gitignore | ||
| acinclude.m4 | ||
| appveyor.yml | ||
| bootstrap | ||
| cmake_uninstall.cmake.in | ||
| CMakeInstallation.cmake | ||
| CMakeLists.txt | ||
| COMPILE.cmake.txt | ||
| config.h.cmake.in | ||
| config.h.cmake.in.old-works | ||
| configure.ac | ||
| COPYRIGHT | ||
| CTestConfig.cmake.in | ||
| CTestCustom.cmake | ||
| dods.m4 | ||
| FixBundle.cmake.in | ||
| INSTALL.md | ||
| lib_flags.am | ||
| libnetcdf.settings.in | ||
| Makefile.am | ||
| mclean | ||
| nc-config.cmake.in | ||
| nc-config.in | ||
| netcdf.pc.in | ||
| netCDFConfig.cmake.in | ||
| PostInstall.cmake | ||
| postinstall.sh.in | ||
| README.md | ||
| RELEASE_NOTES.md | ||
| test_common.in | ||
| test_prog.c | ||
| test-driver-verbose | ||
| wjna | ||
Unidata NetCDF
About
The Unidata network Common Data Form (netCDF) is an interface for scientific data access and a freely-distributed software library that provides an implementation of the interface. The netCDF library also defines a machine-independent format for representing scientific data. Together, the interface, library, and format support the creation, access, and sharing of scientific data. The current netCDF software provides C interfaces for applications and data. Separate software distributions available from Unidata provide Java, Fortran, Python, and C++ interfaces. They have been tested on various common platforms.
Properties
NetCDF files are self-describing, network-transparent, directly
accessible, and extendible. Self-describing means that a netCDF file
includes information about the data it contains. Network-transparent
means that a netCDF file is represented in a form that can be accessed
by computers with different ways of storing integers, characters, and
floating-point numbers. Direct-access means that a small subset of a
large dataset may be accessed efficiently, without first reading through
all the preceding data. Extendible means that data can be appended to
a netCDF dataset without copying it or redefining its structure.
Use
NetCDF is useful for supporting access to diverse kinds of scientific data in heterogeneous networking environments and for writing application software that does not depend on application-specific formats. For information about a variety of analysis and display packages that have been developed to analyze and display data in netCDF form, see
More information
For more information about netCDF, see
Latest releases
You can obtain a copy of the latest released version of netCDF software for various languages:
Copyright
Copyright and licensing information can be found here, as well as in the COPYRIGHT file accompanying the software
Installation
To install the netCDF-C software, please see the file INSTALL in the netCDF-C distribution, or the (usually more up-to-date) document:
Documentation
A language-independent User's Guide for netCDF, and some other language-specific user-level documents are available from:
- Language-independent User's Guide
- NetCDF-C Tutorial
- Fortran-90 User's Guide
- Fortran-77 User's Guide
- netCDF-Java/Common Data Model library
- netCDF4-python
A mailing list, netcdfgroup@unidata.ucar.edu, exists for discussion of the netCDF interface and announcements about netCDF bugs, fixes, and enhancements. For information about how to subscribe, see the URL
Feedback
We appreciate feedback from users of this package. Please send comments, suggestions, and bug reports to support-netcdf@unidata.ucar.edu.