Skip to content

Commit 4f2c2a3

Browse files
committed
add note about new CDL header APIs
1 parent 9eb18a0 commit 4f2c2a3

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

sneak_peek.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,21 @@ This is essentially a placeholder for the next release note ...
2727
+ none
2828

2929
* New APIs
30-
+ none
30+
+ A set of APIs that read the header of a CDL file header and allow users to
31+
query the metadata defined in the CDL file. These APIs can be useful for
32+
creating a program (such as an I/O benchmark) based on an output netCDF
33+
file from another application (a CDL file can be generated by running the
34+
utility `ncmpidump/ncdump`). See
35+
[PR #177](https://github.com/Parallel-NetCDF/PnetCDF/pull/177).
36+
* `cdl_hdr_open()` opens and parses the CDL file's header
37+
* `cdl_hdr_inq_format()` returns file format version
38+
* `cdl_hdr_inq_ndims()` returns number of dimensions defined in CDL file
39+
* `cdl_hdr_inq_dim()` returns metadata of a dimension
40+
* `cdl_hdr_inq_nvars()` returns number of variables
41+
* `cdl_hdr_inq_var()` returns metadata of a variable defined in CDL file
42+
* `cdl_hdr_inq_nattrs()` returns number of attributes of a given variable
43+
* `cdl_hdr_inq_attr()` returns metadata of an attribute
44+
* `cdl_hdr_close()` closes the CDL file
3145

3246
* API syntax changes
3347
+ none
@@ -64,7 +78,8 @@ This is essentially a placeholder for the next release note ...
6478
See [PR #161](https://github.com/Parallel-NetCDF/PnetCDF/pull/161).
6579

6680
* New example programs
67-
+ none
81+
+ examples/C/create_from_cdl.c shows how to call the new CDL header APIs to
82+
create a netCDF file with the same metadata.
6883

6984
* New programs for I/O benchmarks
7085
+ WRF-IO contains an extraction of the I/O kernel of WRF (Wether Research
@@ -75,6 +90,7 @@ This is essentially a placeholder for the next release note ...
7590
See [PR #165](https://github.com/Parallel-NetCDF/PnetCDF/pull/165).
7691

7792
* New test program
93+
+ test/cdf/tst_cdl_hdr_parser.c tests the new CDL header APIs.
7894
+ test/testcases/tst_grow_header.c tests header extent growth by re-entering
7995
the define mode multiple times and add more fix-sized and record variables.
8096

0 commit comments

Comments
 (0)