netcdf-c/docs
Dennis Heimbigner 11fe00ea05 Add filter support to NCZarr
Filter support has three goals:

1. Use the existing HDF5 filter implementations,
2. Allow filter metadata to be stored in the NumCodecs metadata format used by Zarr,
3. Allow filters to be used even when HDF5 is disabled

Detailed usage directions are define in docs/filters.md.

For now, the existing filter API is left in place. So filters
are defined using ''nc_def_var_filter'' using the HDF5 style
where the id and parameters are unsigned integers.

This is a big change since filters affect many parts of the code.

In the following, the terms "compressor" and "filter" and "codec" are generally
used synonomously.

### Filter-Related Changes:
* In order to support dynamic loading of shared filter libraries, a new library was added in the libncpoco directory; it helps to isolate dynamic loading across multiple platforms.
* Provide a json parsing library for use by plugins; this is created by merging libdispatch/ncjson.c with include/ncjson.h.
* Add a new _Codecs attribute to allow clients to see what codecs are being used; let ncdump -s print it out.
* Provide special headers to help support compilation of HDF5 filters when HDF5 is not enabled: netcdf_filter_hdf5_build.h and netcdf_filter_build.h.
* Add a number of new test to test the new nczarr filters.
* Let ncgen parse _Codecs attribute, although it is ignored.

### Plugin directory changes:
* Add support for the Blosc compressor; this is essential because it is the most common compressor used in Zarr datasets. This also necessitated adding a CMake FindBlosc.cmake file
* Add NCZarr support for the big-four filters provided by HDF5: shuffle, fletcher32, deflate (zlib), and szip
* Add a Codec defaulter (see docs/filters.md) for the big four filters.
* Make plugins work with windows by properly adding __declspec declaration.

### Misc. Non-Filter Changes
* Replace most uses of USE_NETCDF4 (deprecated) with USE_HDF5.
* Improve support for caching
* More fixes for path conversion code
* Fix misc. memory leaks
* Add new utility -- ncdump/ncpathcvt -- that does more or less the same thing as cygpath.
* Add a number of new test to test the non-filter fixes.
* Update the parsers
* Convert most instances of '#ifdef _MSC_VER' to '#ifdef _WIN32'
2021-09-02 17:04:26 -06:00
..
images Added uniLogo.png to make dist. 2021-08-24 12:50:21 -06:00
obsolete Misc. source comment typos 2018-04-26 23:04:01 -04:00
old Spelling fixes 2019-09-18 08:03:01 -06:00
static-pages Update links to netCDF-java documentation. 2021-02-26 15:11:10 -07:00
.gitignore Fix up documentation to replace old auth documentation 2017-08-20 18:27:48 -06:00
all-error-codes.md introduce error code NC_EPNETCDF for errors at PnetCDF level 2018-07-29 15:33:08 -05:00
architecture.dox Use PnetCDF instead of parallel-netcdf to avoid confusion with 2018-09-17 17:18:48 -05:00
attribute_conventions.md There was a request to extend the provenance information 2018-08-25 21:44:41 -06:00
auth.html Misc. source comment typos 2018-04-26 23:04:01 -04:00
auth.md The pr does some cleanup on the internal documentation 2018-06-29 15:06:27 -06:00
building-with-cmake.md
byterange.dox changed/removed references to jetstream remotetest instance. 2020-01-03 13:12:58 -07:00
cdl.dox Misc. source comment typos 2018-04-26 23:04:01 -04:00
CMakeLists.txt Move to Version 2 NCZarr Extended Meta-Data 2021-07-17 16:55:30 -06:00
COPYRIGHT.md Updating files to refer to the top-level COPYRIGHT file. 2018-12-04 15:52:43 -07:00
credits.md Spelling fixes 2019-09-18 08:03:01 -06:00
dispatch.dox Spelling fixes 2019-09-18 08:03:01 -06:00
docmap.pdf
Doxyfile.developer Bump version numbers for the next development cycle. 2021-08-17 10:41:07 -06:00
Doxyfile.in Remove obsolete doxygen tags. 2021-08-24 12:42:32 -06:00
Doxyfile.user Added a stand-alone user level doxygen configuration file. It must be used from the top-level netcdf-c directory, e.g. doxygen docs/Doxyfile.user. 2020-05-07 16:23:43 -06:00
DoxygenLayout.xml
esg.md
FAQ.md Update links 2021-02-26 15:14:37 -07:00
file_format_specifications.md This PR adds EXPERIMENTAL support for accessing data in the 2020-06-28 18:02:47 -06:00
filters.md Add filter support to NCZarr 2021-09-02 17:04:26 -06:00
footer.html Update footer.html and Doxyfile to use local Unidata image. 2021-08-24 12:38:40 -06:00
groups.dox
header.html
indexing.dox Provide a Number of fixes/improvements to NCZarr 2020-11-19 17:01:04 -07:00
inmeminternal.dox Spelling fixes 2019-09-18 08:03:01 -06:00
inmemory.md Spelling fixes 2019-09-18 08:03:01 -06:00
install-fortran.md
internal.dox Change (again), and hopefully simplify, the file model inference algorithm. 2019-09-29 12:59:28 -06:00
known_problems.md Spelling fixes 2019-09-18 08:03:01 -06:00
mainpage.dox Tweaked docs to fix dead references introduced as part of separating out NUG from netCDF-C. 2020-03-27 14:21:25 -06:00
Makefile.am Clean up orphaned file entry causing a failure in 'make distcheck' 2021-08-13 11:30:08 -06:00
nczarr.md Add filter support to NCZarr 2021-09-02 17:04:26 -06:00
netcdf-50x50.png
netcdf.m4 Spelling fixes 2019-09-18 08:03:01 -06:00
notes.md
release_header.html Added release to release header. 2016-11-21 11:23:02 -07:00
release.css
tests.md Added a document to catalog what the various tests are. 2016-06-06 14:51:57 -06:00
testserver.dox Update d4ts.war and dts.war build instructions 2021-02-26 15:14:57 -07:00
tutorial.dox Update links to netCDF-java documentation. 2021-02-26 15:11:10 -07:00
unidata_logo_cmyk.png
windows-binaries.md Correct a typo. 2021-08-25 14:58:35 -06:00