netcdf-c/libnczarr/zincludes.h
Dennis Heimbigner d953899559 Move to Version 2 NCZarr Extended Meta-Data
re: https://github.com/zarr-developers/zarr-specs/issues/41

After discussions with the Zarr community, it was decided to
convert to a new representation of the NCZarr meta-data extensions: version 2.
These extensions store information necessary to mapping the Zarr data model
to the netcdf-4 data model.

The basic change is to remove the NCZarr specific objects: .nczarr, .nczgroup, .nczarray, and .nczattr.
The contents of these objects is moved into the corresponding existing Zarr objects as special keys. The mapping is as follows:

* ''.nczarr'' => ''/.zgroup/_NCZARR_SUPERBLOCK_''
* ''.nczgroup => ''.zgroup/_NCZARR_GROUP_''
* ''.nczarray => ''.zarray/_NCZARR_ARRAY_''
* ''.nczattr => ''.zattr/_NCZARR_ATTR_''

Backward compatibility is maintained by looking for the object ''/.nczarr''
and if found, then assuming that the dataset is in the older version 1 format.
This compatibility only supports reading of such version 1 datasets.

Documentation and test cases are also added.

Misc. Other Changes:
1. The json parsing code was added to the general library instead of nczarr only (ncjson.c, ncjson.h).
2. Improved support for different platform paths by allowing conversion
   to a single common path representation.
3. Add some new error codes.
4. Modify nccopy usage to mention the new chunking specification.
2021-07-17 16:55:30 -06:00

67 lines
1.1 KiB
C

/* Copyright 2018-2018 University Corporation for Atmospheric
Research/Unidata. */
/**
* @file This header file contains the common set of headers
* in proper order.
* This header should not be included in
* code outside libzarr.
*
* @author Dennis Heimbigner, Ed Hartnett
*/
#ifndef ZINCLUDES_H
#define ZINCLUDES_H
#include "config.h"
#ifndef __cplusplus
#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <string.h>
#include <stddef.h> /* size_t, ptrdiff_t */
#include <assert.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#endif
#ifdef _WIN32
#include <malloc.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
#include "netcdf.h"
#include "ncdispatch.h"
#include "nc4internal.h"
#include "nc4dispatch.h"
#include "ncuri.h"
#include "nclist.h"
#include "ncbytes.h"
#include "ncauth.h"
#include "nclog.h"
#include "ncrc.h"
#include "ncindex.h"
#include "ncjson.h"
#include "zmap.h"
#include "zinternal.h"
#include "zdispatch.h"
#include "zprovenance.h"
#include "zodom.h"
#include "zchunking.h"
#include "zcache.h"
#include "zarr.h"
#include "zdebug.h"
#ifdef __cplusplus
}
#endif
#endif /* ZINCLUDES_H */