@nirs4all/formats-wasm 0.2.11 → 0.2.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/THIRD_PARTY_NOTICES.md +49 -0
- package/nirs4all_formats_wasm_bg.wasm +0 -0
- package/package.json +4 -2
- package/reader-backports/hdf5-reader/Cargo.toml +119 -0
- package/reader-backports/hdf5-reader/LICENSE-APACHE +164 -0
- package/reader-backports/hdf5-reader/LICENSE-MIT +21 -0
- package/reader-backports/hdf5-reader/PROVENANCE.json +80 -0
- package/reader-backports/hdf5-reader/README.md +308 -0
- package/reader-backports/hdf5-reader/UPSTREAM-Cargo.toml +44 -0
- package/reader-backports/hdf5-reader/UPSTREAM-VCS.json +6 -0
- package/reader-backports/hdf5-reader/src/attribute_api.rs +847 -0
- package/reader-backports/hdf5-reader/src/btree_v1.rs +726 -0
- package/reader-backports/hdf5-reader/src/btree_v2.rs +2068 -0
- package/reader-backports/hdf5-reader/src/cache.rs +354 -0
- package/reader-backports/hdf5-reader/src/checksum.rs +56 -0
- package/reader-backports/hdf5-reader/src/chunk_index.rs +423 -0
- package/reader-backports/hdf5-reader/src/dataset.rs +4733 -0
- package/reader-backports/hdf5-reader/src/datatype_api.rs +497 -0
- package/reader-backports/hdf5-reader/src/error.rs +167 -0
- package/reader-backports/hdf5-reader/src/extensible_array.rs +1886 -0
- package/reader-backports/hdf5-reader/src/filters/deflate.rs +93 -0
- package/reader-backports/hdf5-reader/src/filters/fletcher32.rs +52 -0
- package/reader-backports/hdf5-reader/src/filters/lz4.rs +178 -0
- package/reader-backports/hdf5-reader/src/filters/mod.rs +326 -0
- package/reader-backports/hdf5-reader/src/filters/nbit.rs +586 -0
- package/reader-backports/hdf5-reader/src/filters/scaleoffset.rs +827 -0
- package/reader-backports/hdf5-reader/src/filters/shuffle.rs +99 -0
- package/reader-backports/hdf5-reader/src/fixed_array.rs +763 -0
- package/reader-backports/hdf5-reader/src/fractal_heap.rs +2029 -0
- package/reader-backports/hdf5-reader/src/global_heap.rs +284 -0
- package/reader-backports/hdf5-reader/src/group.rs +795 -0
- package/reader-backports/hdf5-reader/src/io.rs +413 -0
- package/reader-backports/hdf5-reader/src/lib.rs +916 -0
- package/reader-backports/hdf5-reader/src/local_heap.rs +261 -0
- package/reader-backports/hdf5-reader/src/messages/attribute.rs +304 -0
- package/reader-backports/hdf5-reader/src/messages/attribute_info.rs +96 -0
- package/reader-backports/hdf5-reader/src/messages/btree_k.rs +36 -0
- package/reader-backports/hdf5-reader/src/messages/continuation.rs +46 -0
- package/reader-backports/hdf5-reader/src/messages/dataspace.rs +259 -0
- package/reader-backports/hdf5-reader/src/messages/datatype.rs +938 -0
- package/reader-backports/hdf5-reader/src/messages/external_files.rs +50 -0
- package/reader-backports/hdf5-reader/src/messages/fill_value.rs +233 -0
- package/reader-backports/hdf5-reader/src/messages/filter_pipeline.rs +147 -0
- package/reader-backports/hdf5-reader/src/messages/group_info.rs +103 -0
- package/reader-backports/hdf5-reader/src/messages/layout.rs +476 -0
- package/reader-backports/hdf5-reader/src/messages/link.rs +170 -0
- package/reader-backports/hdf5-reader/src/messages/link_info.rs +127 -0
- package/reader-backports/hdf5-reader/src/messages/mod.rs +374 -0
- package/reader-backports/hdf5-reader/src/messages/modification_time.rs +83 -0
- package/reader-backports/hdf5-reader/src/messages/shared.rs +164 -0
- package/reader-backports/hdf5-reader/src/messages/shared_table.rs +67 -0
- package/reader-backports/hdf5-reader/src/messages/symbol_table_msg.rs +51 -0
- package/reader-backports/hdf5-reader/src/object_header.rs +1749 -0
- package/reader-backports/hdf5-reader/src/reference.rs +90 -0
- package/reader-backports/hdf5-reader/src/shared_message_table.rs +425 -0
- package/reader-backports/hdf5-reader/src/storage.rs +538 -0
- package/reader-backports/hdf5-reader/src/superblock.rs +285 -0
- package/reader-backports/hdf5-reader/src/symbol_table.rs +277 -0
- package/reader-backports/netcdf-reader/Cargo.toml +141 -0
- package/reader-backports/netcdf-reader/LICENSE-APACHE +164 -0
- package/reader-backports/netcdf-reader/LICENSE-MIT +21 -0
- package/reader-backports/netcdf-reader/PROVENANCE.json +55 -0
- package/reader-backports/netcdf-reader/README.md +308 -0
- package/reader-backports/netcdf-reader/UPSTREAM-Cargo.toml +48 -0
- package/reader-backports/netcdf-reader/UPSTREAM-VCS.json +6 -0
- package/reader-backports/netcdf-reader/src/cf/axes.rs +419 -0
- package/reader-backports/netcdf-reader/src/cf/bounds.rs +108 -0
- package/reader-backports/netcdf-reader/src/cf/crs.rs +269 -0
- package/reader-backports/netcdf-reader/src/cf/mod.rs +30 -0
- package/reader-backports/netcdf-reader/src/cf/time.rs +1122 -0
- package/reader-backports/netcdf-reader/src/classic/data.rs +1465 -0
- package/reader-backports/netcdf-reader/src/classic/header.rs +1097 -0
- package/reader-backports/netcdf-reader/src/classic/mod.rs +240 -0
- package/reader-backports/netcdf-reader/src/classic/storage.rs +211 -0
- package/reader-backports/netcdf-reader/src/classic/types.rs +93 -0
- package/reader-backports/netcdf-reader/src/classic/variable.rs +1162 -0
- package/reader-backports/netcdf-reader/src/error.rs +59 -0
- package/reader-backports/netcdf-reader/src/lib.rs +1531 -0
- package/reader-backports/netcdf-reader/src/masked.rs +173 -0
- package/reader-backports/netcdf-reader/src/nc4/attributes.rs +203 -0
- package/reader-backports/netcdf-reader/src/nc4/dimensions.rs +139 -0
- package/reader-backports/netcdf-reader/src/nc4/groups.rs +308 -0
- package/reader-backports/netcdf-reader/src/nc4/mod.rs +572 -0
- package/reader-backports/netcdf-reader/src/nc4/types.rs +309 -0
- package/reader-backports/netcdf-reader/src/nc4/variables.rs +420 -0
- package/reader-backports/netcdf-reader/src/types.rs +18 -0
- package/reader-backports/netcdf-reader/src/unpack.rs +113 -0
- package/reader-backports/netcdf-reader/src/user_defined.rs +569 -0
|
@@ -0,0 +1,308 @@
|
|
|
1
|
+
# netcdf-rust
|
|
2
|
+
|
|
3
|
+
[](https://crates.io/crates/hdf5-reader)
|
|
4
|
+
[](https://docs.rs/hdf5-reader)
|
|
5
|
+
[](https://crates.io/crates/hdf5-writer)
|
|
6
|
+
[](https://docs.rs/hdf5-writer)
|
|
7
|
+
[](https://crates.io/crates/netcdf-reader)
|
|
8
|
+
[](https://docs.rs/netcdf-reader)
|
|
9
|
+
[](https://crates.io/crates/netcdf-writer)
|
|
10
|
+
[](https://docs.rs/netcdf-writer)
|
|
11
|
+
|
|
12
|
+
Pure-Rust readers and writers for HDF5 and NetCDF. The published library dependency graph has no C libraries or build scripts; internal `unsafe` is limited to read-only memory mapping and performance-critical decoding/copy paths.
|
|
13
|
+
|
|
14
|
+
Reference tests, benchmarks, fixture generators, and fuzz targets may use native
|
|
15
|
+
tooling such as NetCDF-C/HDF5 through dev-only dependencies. Those paths are not
|
|
16
|
+
part of the library runtime dependency graph. Writer output is validated against
|
|
17
|
+
the reference C libraries (libhdf5 via h5py, netcdf-c via netCDF4-python) in
|
|
18
|
+
addition to round-tripping through the sibling reader crates.
|
|
19
|
+
|
|
20
|
+
## Crates
|
|
21
|
+
|
|
22
|
+
| Crate | Description |
|
|
23
|
+
|---|---|
|
|
24
|
+
| `hdf5-core` | Shared HDF5 format model and checksums (Jenkins lookup3, Fletcher-32) |
|
|
25
|
+
| `hdf5-reader` | Low-level HDF5 decoder (superblock, object headers, B-trees, chunked I/O, filters) |
|
|
26
|
+
| `hdf5-writer` | HDF5 encoder (contiguous/compact/chunked layouts, groups, attributes, filters, datatypes) |
|
|
27
|
+
| `netcdf-core` | Shared NetCDF data model (types, attributes, dimensions, variables) |
|
|
28
|
+
| `netcdf-reader` | NetCDF reader supporting CDF-1/2/5 classic and NetCDF-4 (HDF5-backed) formats |
|
|
29
|
+
| `netcdf-writer` | NetCDF writer for CDF-1/2/5 classic and NetCDF-4 (HDF5-backed) formats |
|
|
30
|
+
|
|
31
|
+
## Feature support
|
|
32
|
+
|
|
33
|
+
| Feature | Read | Write |
|
|
34
|
+
|---|---|---|
|
|
35
|
+
| Classic CDF-1 / CDF-2 / CDF-5 | ✓ | ✓ |
|
|
36
|
+
| NetCDF-4 (HDF5-backed) | ✓ | ✓ |
|
|
37
|
+
| Chunked layouts (incl. unlimited dims) | ✓ | ✓ |
|
|
38
|
+
| Filters: deflate, shuffle, fletcher32 | ✓ | ✓ |
|
|
39
|
+
| Filters: lz4, nbit, scaleoffset | ✓ | — |
|
|
40
|
+
| Compound / enum / opaque / array / vlen / string datatypes | ✓ | ✓ |
|
|
41
|
+
| Dimension scales (`DIMENSION_LIST` + `REFERENCE_LIST`) | ✓ | ✓ |
|
|
42
|
+
| CF conventions (unpack, mask, calendars) | ✓ | n/a |
|
|
43
|
+
| szip filter, virtual datasets | — | — |
|
|
44
|
+
|
|
45
|
+
The minimum supported Rust version is 1.81. Reads are hardened against malformed
|
|
46
|
+
input: bounds-checked cursors, cycle detection in B-tree/heap/object-header
|
|
47
|
+
traversals, recursion-depth limits, and file-size-bounded allocation. The reader
|
|
48
|
+
crates are exercised by a corpus/property/fuzz suite in addition to
|
|
49
|
+
reference-oracle tests against the C libraries.
|
|
50
|
+
|
|
51
|
+
Not yet supported (contributions welcome): writing the szip / lz4 / nbit /
|
|
52
|
+
scaleoffset filters; typed compound-value writing; appending to or updating an
|
|
53
|
+
existing file in place; HDF5 virtual datasets; and object-header messages larger
|
|
54
|
+
than 64 KiB.
|
|
55
|
+
|
|
56
|
+
## Usage
|
|
57
|
+
|
|
58
|
+
```rust
|
|
59
|
+
use netcdf_reader::{NcFile, NcSliceInfo, NcSliceInfoElem};
|
|
60
|
+
|
|
61
|
+
let file = NcFile::open("era5.nc")?;
|
|
62
|
+
println!("format: {:?}", file.format());
|
|
63
|
+
|
|
64
|
+
for var in file.variables()? {
|
|
65
|
+
println!(" var: {} {:?}", var.name(), var.shape());
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
// Read typed data (works for both classic and NetCDF-4)
|
|
69
|
+
let temp: ndarray::ArrayD<f32> = file.read_variable("temperature")?;
|
|
70
|
+
|
|
71
|
+
// Type-promoting read (any numeric type → f64)
|
|
72
|
+
let data = file.read_variable_as_f64("temperature")?;
|
|
73
|
+
|
|
74
|
+
// String variables (classic char arrays and NetCDF-4 NC_STRING)
|
|
75
|
+
let names = file.read_variable_as_strings("station_name")?;
|
|
76
|
+
|
|
77
|
+
// NetCDF-4 user-defined variables (enum, opaque, compound, array, vlen)
|
|
78
|
+
let quality = file.read_variable_user_defined("quality")?;
|
|
79
|
+
|
|
80
|
+
// CF conventions: unpack packed integer data (scale_factor + add_offset)
|
|
81
|
+
let unpacked = file.read_variable_unpacked("temperature")?;
|
|
82
|
+
|
|
83
|
+
// CF conventions: mask fill values + unpack in one call
|
|
84
|
+
let clean = file.read_variable_unpacked_masked("temperature")?;
|
|
85
|
+
|
|
86
|
+
// Hyperslab: read a single time step from a 4D variable
|
|
87
|
+
let sel = NcSliceInfo {
|
|
88
|
+
selections: vec![
|
|
89
|
+
NcSliceInfoElem::Index(0), // time=0
|
|
90
|
+
NcSliceInfoElem::Slice { start: 0, end: u64::MAX, step: 1 }, // all levels
|
|
91
|
+
NcSliceInfoElem::Slice { start: 0, end: u64::MAX, step: 1 }, // all lat
|
|
92
|
+
NcSliceInfoElem::Slice { start: 0, end: u64::MAX, step: 1 }, // all lon
|
|
93
|
+
],
|
|
94
|
+
};
|
|
95
|
+
let step: ndarray::ArrayD<f32> = file.read_variable_slice("temperature", &sel)?;
|
|
96
|
+
|
|
97
|
+
// Lazy iteration over time steps
|
|
98
|
+
for slice in file.iter_slices::<f32>("temperature", 0)? {
|
|
99
|
+
let data = slice?;
|
|
100
|
+
println!(" step shape: {:?}", data.shape());
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
// In-memory open with custom NC4 cache/filter options
|
|
104
|
+
let bytes = std::fs::read("era5.nc")?;
|
|
105
|
+
let file = NcFile::from_bytes_with_options(&bytes, netcdf_reader::NcOpenOptions {
|
|
106
|
+
chunk_cache_bytes: 8 * 1024 * 1024,
|
|
107
|
+
chunk_cache_slots: 257,
|
|
108
|
+
metadata_mode: netcdf_reader::NcMetadataMode::Strict,
|
|
109
|
+
#[cfg(feature = "netcdf4")]
|
|
110
|
+
filter_registry: None,
|
|
111
|
+
})?;
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
Using `hdf5-reader` directly:
|
|
115
|
+
|
|
116
|
+
```rust
|
|
117
|
+
use hdf5_reader::Hdf5File;
|
|
118
|
+
|
|
119
|
+
let file = Hdf5File::open("data.h5")?;
|
|
120
|
+
let ds = file.dataset("/group1/temperature")?;
|
|
121
|
+
let data: ndarray::ArrayD<f64> = ds.read_array()?;
|
|
122
|
+
|
|
123
|
+
// Hyperslab selection
|
|
124
|
+
use hdf5_reader::{SliceInfo, SliceInfoElem};
|
|
125
|
+
let sel = SliceInfo {
|
|
126
|
+
selections: vec![
|
|
127
|
+
SliceInfoElem::Slice { start: 0, end: 10, step: 1 },
|
|
128
|
+
SliceInfoElem::Index(5),
|
|
129
|
+
],
|
|
130
|
+
};
|
|
131
|
+
let slice: ndarray::ArrayD<f64> = ds.read_slice(&sel)?;
|
|
132
|
+
|
|
133
|
+
// String datasets
|
|
134
|
+
let labels = file.dataset("/labels")?.read_strings()?;
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### Writing
|
|
138
|
+
|
|
139
|
+
`netcdf-writer` builds a file from dimensions, variables, and attributes and
|
|
140
|
+
serializes it to any classic or NetCDF-4 format:
|
|
141
|
+
|
|
142
|
+
```rust
|
|
143
|
+
use netcdf_writer::{NcAttrValue, NcFileBuilder, NcWriteOptions};
|
|
144
|
+
|
|
145
|
+
let mut builder = NcFileBuilder::new();
|
|
146
|
+
let time = builder.add_unlimited_dimension("time")?;
|
|
147
|
+
let x = builder.add_dimension("x", 3)?;
|
|
148
|
+
|
|
149
|
+
builder.add_attribute("title", NcAttrValue::Chars("example".into()))?;
|
|
150
|
+
|
|
151
|
+
let temp = builder.add_variable::<f32>("temp", &[time, x])?;
|
|
152
|
+
builder.add_variable_attribute(temp, "units", NcAttrValue::Chars("K".into()))?;
|
|
153
|
+
builder.write_variable(temp, &[280.0_f32, 281.0, 282.0, 283.0, 284.0, 285.0])?;
|
|
154
|
+
|
|
155
|
+
// AutoClassic picks CDF-1/2/5 from the schema; other options force a format.
|
|
156
|
+
let (_format, bytes) = builder.to_vec(NcWriteOptions::default())?;
|
|
157
|
+
std::fs::write("out.nc", bytes)?;
|
|
158
|
+
|
|
159
|
+
// NetCDF-4 (HDF5-backed) output:
|
|
160
|
+
use netcdf_writer::NcWriteFormat;
|
|
161
|
+
let (_format, nc4_bytes) =
|
|
162
|
+
builder.to_vec(NcWriteOptions { format: NcWriteFormat::Nc4 })?;
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
`hdf5-writer` offers the same for raw HDF5 via `Hdf5Builder` / `DatasetBuilder`
|
|
166
|
+
/ `AttributeBuilder`.
|
|
167
|
+
|
|
168
|
+
## Features
|
|
169
|
+
|
|
170
|
+
**HDF5**
|
|
171
|
+
- Superblock v0-v3 and object header v1/v2 with checksum verification
|
|
172
|
+
- Compact, contiguous, and chunked layouts
|
|
173
|
+
- All chunk index types: v1/v2 B-tree, single-chunk, implicit, Fixed Array, Extensible Array
|
|
174
|
+
- Deflate, shuffle, Fletcher-32, N-Bit, ScaleOffset, and optional LZ4 filters
|
|
175
|
+
- Custom filters via `FilterRegistry`
|
|
176
|
+
- Fixed-length strings, HDF5 variable-length strings, and byte-vlen string datasets
|
|
177
|
+
- Dense-link resolution, soft-link resolution, optional external-link resolution, committed datatypes, global heap strings, and object references
|
|
178
|
+
- SOHM shared-message lookup, fractal heap managed/tiny/huge objects, and external raw data files
|
|
179
|
+
- Parallel chunk decoding, chunk caching, and object-header caching
|
|
180
|
+
- Range-backed opens via `Storage` backends (`BytesStorage`, `FileStorage`, `MmapStorage`)
|
|
181
|
+
|
|
182
|
+
**NetCDF**
|
|
183
|
+
- CDF-1, CDF-2, CDF-5, and NetCDF-4
|
|
184
|
+
- Automatic format detection
|
|
185
|
+
- Unified typed reads across formats
|
|
186
|
+
- Unified string reads for classic char arrays and NetCDF-4 string variables
|
|
187
|
+
- NetCDF-4 user-defined reads for enum, opaque, compound, fixed-size array,
|
|
188
|
+
and non-string vlen variables, including custom borrowed decoders
|
|
189
|
+
- Type promotion to `f64`, unpacking, masking, and combined CF helpers
|
|
190
|
+
- Coordinate-variable lookup plus CF axis/time discovery when `cf` is enabled
|
|
191
|
+
- Exact CF time decoding for standard, proleptic Gregorian, noleap, all_leap,
|
|
192
|
+
360_day, and Julian calendars when `cf` is enabled
|
|
193
|
+
- Slice reads, lazy slice iteration, and parallel NC4 slice reads
|
|
194
|
+
- Cache and filter configuration through `NcOpenOptions`, including in-memory and storage-backed opens
|
|
195
|
+
|
|
196
|
+
## Parallel-I/O Compatibility
|
|
197
|
+
|
|
198
|
+
This project reads files. It does not provide distributed parallel I/O APIs.
|
|
199
|
+
|
|
200
|
+
- PnetCDF-produced CDF-1, CDF-2, and CDF-5 files are supported as ordinary
|
|
201
|
+
classic-format NetCDF files. PnetCDF's MPI-IO API surface is not implemented.
|
|
202
|
+
- NetCDF-C files created with `nc_create_par` or Parallel HDF5 are supported
|
|
203
|
+
when the final file is a normal NetCDF-4/HDF5 file that uses HDF5 features
|
|
204
|
+
supported by `hdf5-reader`. Parallel access mode is an open-time API concern,
|
|
205
|
+
not a persistent file property.
|
|
206
|
+
- The Rayon APIs in this crate parallelize local decoding and independent byte
|
|
207
|
+
range reads inside one process. They are not equivalent to MPI-IO collective
|
|
208
|
+
or independent access modes.
|
|
209
|
+
- PnetCDF subfiling is out of scope for now because it is not an ordinary
|
|
210
|
+
single-file CDF-1/2/5 dataset.
|
|
211
|
+
|
|
212
|
+
## Feature flags
|
|
213
|
+
|
|
214
|
+
Minimum supported Rust version: 1.81.
|
|
215
|
+
|
|
216
|
+
```toml
|
|
217
|
+
[dependencies]
|
|
218
|
+
netcdf-reader = "0.9.3" # CDF-1/2/5 + NetCDF-4 (default)
|
|
219
|
+
netcdf-reader = { version = "0.9.3", default-features = false } # CDF-1/2/5 only
|
|
220
|
+
netcdf-writer = "0.9.3" # Classic + NetCDF-4 writer (default)
|
|
221
|
+
hdf5-writer = "0.9.3" # Raw HDF5 writer
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
| Flag | Default | Description |
|
|
225
|
+
|---|---|---|
|
|
226
|
+
| `netcdf4` | yes | NetCDF-4 support via `hdf5-reader` |
|
|
227
|
+
| `rayon` | yes | Parallel chunk reading |
|
|
228
|
+
| `lz4` | yes | LZ4 filter support (hdf5-reader) |
|
|
229
|
+
| `cf` | no | CF Conventions helpers (axis identification, time decoding, CRS extraction, bounds) |
|
|
230
|
+
|
|
231
|
+
## External Raw Data Files
|
|
232
|
+
|
|
233
|
+
HDF5 external raw data files are not resolved by default. To allow them for
|
|
234
|
+
trusted files, opt in with a resolver rooted at the directory that should
|
|
235
|
+
contain the external data. The filesystem resolver rejects absolute paths and
|
|
236
|
+
`..` components. On Unix, it opens paths relative to the resolver root with
|
|
237
|
+
`openat` and `O_NOFOLLOW`, so symlinks are rejected rather than followed. The
|
|
238
|
+
same confinement is applied by `FilesystemExternalLinkResolver` when external
|
|
239
|
+
links are enabled. On non-Unix platforms, the filesystem resolvers fall back to
|
|
240
|
+
canonicalize-then-open and attacker-writable resolver roots are out of scope.
|
|
241
|
+
|
|
242
|
+
```rust
|
|
243
|
+
use std::path::Path;
|
|
244
|
+
use std::sync::Arc;
|
|
245
|
+
|
|
246
|
+
use hdf5_reader::{FilesystemExternalFileResolver, Hdf5File, OpenOptions};
|
|
247
|
+
|
|
248
|
+
let path = Path::new("data.h5");
|
|
249
|
+
let base_dir = path.parent().unwrap_or_else(|| Path::new("."));
|
|
250
|
+
let file = Hdf5File::open_with_options(path, OpenOptions {
|
|
251
|
+
external_file_resolver: Some(Arc::new(FilesystemExternalFileResolver::new(base_dir))),
|
|
252
|
+
..Default::default()
|
|
253
|
+
})?;
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
## Custom filters
|
|
257
|
+
|
|
258
|
+
Register filters before opening files:
|
|
259
|
+
|
|
260
|
+
```rust
|
|
261
|
+
use hdf5_reader::{Hdf5File, OpenOptions};
|
|
262
|
+
use hdf5_reader::filters::FilterRegistry;
|
|
263
|
+
|
|
264
|
+
let mut registry = FilterRegistry::new();
|
|
265
|
+
registry.register(32001, Box::new(|_filter, data, _elem_size| {
|
|
266
|
+
// Custom decompression logic
|
|
267
|
+
Ok(data.to_vec())
|
|
268
|
+
}));
|
|
269
|
+
|
|
270
|
+
let file = Hdf5File::open_with_options("data.h5", OpenOptions {
|
|
271
|
+
filter_registry: Some(registry),
|
|
272
|
+
..Default::default()
|
|
273
|
+
})?;
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
## Testing
|
|
277
|
+
|
|
278
|
+
```sh
|
|
279
|
+
# Unit tests (no external dependencies)
|
|
280
|
+
cargo test --workspace
|
|
281
|
+
|
|
282
|
+
# Integration tests with generated fixtures
|
|
283
|
+
scripts/generate-fixtures.sh
|
|
284
|
+
cargo test --workspace
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
Small compatibility fixtures under `testdata/pnetcdf` and `testdata/parallel`
|
|
288
|
+
exercise standard CDF-1/2/5 and NetCDF-4 files matching layouts produced by
|
|
289
|
+
PnetCDF and parallel netCDF-C/HDF5 workflows. Reference C generators that use
|
|
290
|
+
those external parallel libraries live under `testdata/external`; they are not
|
|
291
|
+
library dependencies.
|
|
292
|
+
|
|
293
|
+
For reference comparisons and current benchmark results against
|
|
294
|
+
`georust/netcdf`, see [docs/benchmark-report.md](docs/benchmark-report.md).
|
|
295
|
+
|
|
296
|
+
## Releasing
|
|
297
|
+
|
|
298
|
+
See [RELEASING.md](RELEASING.md) for the release checklist and the required
|
|
299
|
+
publish order for all six crates.
|
|
300
|
+
|
|
301
|
+
## Known limitations
|
|
302
|
+
|
|
303
|
+
- SZIP is not built in (register via `FilterRegistry` if needed)
|
|
304
|
+
- ScaleOffset floating-point E-scale mode is not supported by the HDF5 decoder path
|
|
305
|
+
|
|
306
|
+
## License
|
|
307
|
+
|
|
308
|
+
MIT OR Apache-2.0
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
[package]
|
|
2
|
+
name = "hdf5-reader"
|
|
3
|
+
description = "Pure-Rust, read-only HDF5 file decoder with no C dependencies"
|
|
4
|
+
version.workspace = true
|
|
5
|
+
edition.workspace = true
|
|
6
|
+
rust-version.workspace = true
|
|
7
|
+
license.workspace = true
|
|
8
|
+
repository.workspace = true
|
|
9
|
+
homepage.workspace = true
|
|
10
|
+
readme = "../README.md"
|
|
11
|
+
documentation = "https://docs.rs/hdf5-reader"
|
|
12
|
+
keywords = ["hdf5", "decoder", "scientific-data", "read-only"]
|
|
13
|
+
categories = ["science", "parser-implementations"]
|
|
14
|
+
|
|
15
|
+
[lints]
|
|
16
|
+
workspace = true
|
|
17
|
+
|
|
18
|
+
[dependencies]
|
|
19
|
+
hdf5-core = { version = "0.9.3", path = "../hdf5-core" }
|
|
20
|
+
ndarray = { workspace = true }
|
|
21
|
+
thiserror = { workspace = true }
|
|
22
|
+
memmap2 = { workspace = true }
|
|
23
|
+
flate2 = { version = "1", default-features = false, features = ["rust_backend"] }
|
|
24
|
+
libc = "0.2"
|
|
25
|
+
lru = "0.16.3"
|
|
26
|
+
parking_lot = "0.12"
|
|
27
|
+
smallvec = "1"
|
|
28
|
+
|
|
29
|
+
[dev-dependencies]
|
|
30
|
+
tempfile = "3"
|
|
31
|
+
proptest = "1"
|
|
32
|
+
|
|
33
|
+
[features]
|
|
34
|
+
default = ["rayon", "lz4"]
|
|
35
|
+
lz4 = ["dep:lz4_flex"]
|
|
36
|
+
rayon = ["dep:rayon"]
|
|
37
|
+
|
|
38
|
+
[dependencies.lz4_flex]
|
|
39
|
+
version = "0.11"
|
|
40
|
+
optional = true
|
|
41
|
+
|
|
42
|
+
[dependencies.rayon]
|
|
43
|
+
version = "1"
|
|
44
|
+
optional = true
|