netcdf-c/docs
Dennis Heimbigner df3636b959 Mitigate S3 test interference + Unlimited Dimensions in NCZarr
This PR started as an attempt to add unlimited dimensions to NCZarr.
It did that, but this exposed significant problems with test interference.
So this PR is mostly about fixing -- well mitigating anyway -- test
interference.

The problem of test interference is now documented in the document docs/internal.md.
The solutions implemented here are also describe in that document.
The solution is somewhat fragile but multiple cleanup mechanisms
are provided. Note that this feature requires that the
AWS command line utility must be installed.

## Unlimited Dimensions.
The existing NCZarr extensions to Zarr are modified to support unlimited dimensions.
NCzarr extends the Zarr meta-data for the ".zgroup" object to include netcdf-4 model extensions. This information is stored in ".zgroup" as dictionary named "_nczarr_group".
Inside "_nczarr_group", there is a key named "dims" that stores information about netcdf-4 named dimensions. The value of "dims" is a dictionary whose keys are the named dimensions. The value associated with each dimension name has one of two forms
Form 1 is a special case of form 2, and is kept for backward compatibility. Whenever a new file is written, it uses format 1 if possible, otherwise format 2.
* Form 1: An integer representing the size of the dimension, which is used for simple named dimensions.
* Form 2: A dictionary with the following keys and values"
   - "size" with an integer value representing the (current) size of the dimension.
   - "unlimited" with a value of either "1" or "0" to indicate if this dimension is an unlimited dimension.

For Unlimited dimensions, the size is initially zero, and as variables extend the length of that dimension, the size value for the dimension increases.
That dimension size is shared by all arrays referencing that dimension, so if one array extends an unlimited dimension, it is implicitly extended for all other arrays that reference that dimension.
This is the standard semantics for unlimited dimensions.

Adding unlimited dimensions required a number of other changes to the NCZarr code-base. These included the following.
* Did a partial refactor of the slice handling code in zwalk.c to clean it up.
* Added a number of tests for unlimited dimensions derived from the same test in nc_test4.
* Added several NCZarr specific unlimited tests; more are needed.
* Add test of endianness.

## Misc. Other Changes
* Modify libdispatch/ncs3sdk_aws.cpp to optionally support use of the
   AWS Transfer Utility mechanism. This is controlled by the
   ```#define TRANSFER```` command in that file. It defaults to being disabled.
* Parameterize both the standard Unidata S3 bucket (S3TESTBUCKET) and the netcdf-c test data prefix (S3TESTSUBTREE).
* Fixed an obscure memory leak in ncdump.
* Removed some obsolete unit testing code and test cases.
* Uncovered a bug in the netcdf-c handling of big-endian floats and doubles. Have not fixed yet. See tst_h5_endians.c.
* Renamed some nczarr_tests testcases to avoid name conflicts with nc_test4.
* Modify the semantics of zmap\#ncsmap_write to only allow total rewrite of objects.
* Modify the semantics of zodom to properly handle stride > 1.
* Add a truncate operation to the libnczarr zmap code.
2023-09-26 16:56:48 -06:00
..
images Correct error in make dist 2022-06-10 14:08:57 -06:00
obsolete
old
static-pages Added another old static html page in preparation for updating. 2022-12-19 14:55:31 -07:00
.gitignore
all-error-codes.md Working towards writing the quick start for plugins and integrating it into doxygen. 2022-10-05 13:31:49 -06:00
architecture.dox
attribute_conventions.md Changed attribute case in documentation in support of https://github.com/Unidata/netcdf-c/issues/2481 2022-08-19 13:28:51 -06:00
auth.md Fix some problems with Earthdata authorization. 2023-06-10 18:51:13 -06:00
building-with-cmake.md
byterange.md Improve S3 Documentation and Support 2023-04-25 17:15:06 -06:00
cloud.md Mitigate S3 test interference + Unlimited Dimensions in NCZarr 2023-09-26 16:56:48 -06:00
CMakeLists.txt Improve S3 Documentation and Support 2023-04-25 17:15:06 -06:00
COPYRIGHT.md
credits.md
dispatch.md Bring up-to-date with main 2023-01-17 16:28:45 -07:00
docmap.pdf
Doxyfile.developer Bump version strings to reflect next development version. 2023-03-13 15:43:44 -06:00
Doxyfile.in Improve S3 Documentation and Support 2023-04-25 17:15:06 -06:00
Doxyfile.user Update issue with make distcheck 2023-04-12 14:14:38 -06:00
DoxygenLayout.xml
esg.md
FAQ.md
file_format_specifications.md
filters.md Update docs/filters.md and RELEASENOTES.md 2023-06-23 13:42:16 -06:00
footer.html
groups.dox
header.html
indexing.dox
inmeminternal.dox
inmemory.md
install-fortran.md
internal.md Mitigate S3 test interference + Unlimited Dimensions in NCZarr 2023-09-26 16:56:48 -06:00
known_problems.md Merge pull request #2530 from Unidata/v4.9.1-wellspring.wif 2022-11-09 12:44:18 -07:00
logging.md added fortran 2023-04-06 10:04:12 -06:00
mainpage.dox Fix DAP4 remotetest server 2022-11-15 20:29:21 -07:00
Makefile.am Improve S3 Documentation and Support 2023-04-25 17:15:06 -06:00
nczarr.md Mitigate S3 test interference + Unlimited Dimensions in NCZarr 2023-09-26 16:56:48 -06:00
netcdf-50x50.png
netcdf.m4
notes.md fixed some doxygen warnings 2022-05-28 18:54:08 +03:00
quantize.md moved quantize error documentation 2022-06-23 09:51:09 +02:00
quickstart_filters.md re-added quickstart filters document. 2023-02-01 11:20:40 -07:00
quickstart_paths.md Improve S3 Documentation and Support 2023-04-25 17:15:06 -06:00
release_header.html
release.css
tests.md
testserver.dox
tutorial.dox
unidata_logo_cmyk.png
windows-binaries.md Incorporated GitHub-generated release notes into the manually managed release notes, and updated the list of included dependencies for Windows installer downloads. 2022-06-10 14:43:50 -06:00