You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/read.md
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,24 +1,25 @@
1
-
# Hdf5JavaLib: Read Capabilities (Version 0.2.1)
1
+
# Hdf5JavaLib: Read Capabilities (Version 0.3.0)
2
2
3
-
Hdf5JavaLib is a pure Java library for reading HDF5 files, released as version 0.2.1. This guide helps users read datasets in the root group using examples from the `org.hdf5javalib.examples.read` package. The library reads HDF5 files generated by the C++ HDF5 library, supporting compound datasets, multi-dimensional data, and various datatypes. New in version 0.2.1: enhanced sequential and parallel streaming, array flattening, slicing, reducing along axes, filtering with coordinate lists, and custom type converters for compound datasets.
3
+
Hdf5JavaLib is a pure Java library for reading HDF5 files, released as version 0.3.0. This guide helps users read datasets in the root group using examples from the `org.hdf5javalib.examples.read` package. The library reads HDF5 files generated by the C++ HDF5 library, supporting compound datasets, multi-dimensional data, and various datatypes. Version 0.3.0 and higher should support all hdf5 files.
4
4
5
5
## Setup
6
6
7
7
### Add the Dependency
8
8
9
-
Add Hdf5JavaLib to your project via [Maven Central](https://search.maven.org/artifact/org.hdf5javalib/hdf5javalib/0.2.1/jar):
9
+
Add Hdf5JavaLib to your project via [Maven Central](https://search.maven.org/artifact/org.hdf5javalib/hdf5javalib/0.3.0/jar):
10
10
11
11
```xml
12
12
<dependency>
13
13
<groupId>org.hdf5javalib</groupId>
14
14
<artifactId>hdf5javalib</artifactId>
15
-
<version>0.2.1</version>
15
+
<version>0.3.0</version>
16
16
</dependency>
17
17
```
18
18
19
19
### Requirements
20
20
- Java 17 or higher.
21
-
- No external HDF5 dependencies.
21
+
- Runtime support for org.slf4j, automatically included in springboot projects or link in slf4j-api and logback runtimes.
22
+
- No external HDF5 dependencies required.
22
23
23
24
### Alternative: Build from Source
24
25
1. Clone the repository:
@@ -38,7 +39,7 @@ Add Hdf5JavaLib to your project via [Maven Central](https://search.maven.org/art
38
39
39
40
## Read Capabilities
40
41
41
-
Hdf5JavaLib supports reading datasets in the root group (`/`), including:
42
+
Hdf5JavaLib supports full dataset and group paths, for example reading datasets in the root group (`/`) or subgroups ('/G1/DS1'), including:
42
43
-**Compound Datasets**: Structured data with fields like integers, strings, floats, and nested compounds (e.g., `CompoundData` with `fixed_point`, `floating_point`). Supports mapping to custom Java classes or records with custom type converters.
43
44
-**Scalar Datasets**: Single values (e.g., fixed-point, floating-point, strings).
@@ -60,6 +61,8 @@ Hdf5JavaLib supports reading datasets in the root group (`/`), including:
60
61
-**Metadata**: Partial support for SNODs (symbol table nodes).
61
62
-**Streaming**: Sequential and parallel streaming for efficient data processing, with Spliterators for all dataset types.
62
63
-**Advanced Operations**: Array flattening, dimensional slicing, reduction along axes, and filtering with coordinate lists via `FlattenedArrayUtils`.
64
+
-**V1** and **V2**: Version 1 and 2 hdf file structures.
65
+
-**NASA**: Tested against at least 2 actual NASA datafiles, `ATL03_20250302235544_11742607_007_01.h5` and `ATL03_20250302235544_11742607_006_01.h5`, found at [https://nsidc.org/data/atl03/versions/5](https://nsidc.org/data/atl03/versions/5)
The HDF5Examples repository (or directory in the HDF5 source distribution) contains code samples demonstrating how to use the HDF5 library across various programming languages. Below, I'll explain the purpose of the specified directories based on their structure and contents. Note that the examples are practical code snippets (e.g., .c files) that compile and run to illustrate specific HDF5 API features.
0 commit comments