1- # EazyH5 Toolbox - An easy-to-use HDF5 data interface (loadh5 and saveh5)
1+ # EasyH5 Toolbox - An easy-to-use HDF5 data interface (loadh5 and saveh5)
22
33* Copyright (C) 2019 Qianqian Fang <q.fang at neu.edu>
44* License: GNU General Public License version 3 (GPL v3) or 3-clause BSD license, see LICENSE* .txt
55* Version: 0.8 (code name: Go - Japanese 5)
6- * URL: http://github.com/fangq/eazyh5
6+ * URL: http://github.com/fangq/easyh5
77
88## Overview
99
10- EazyH5 is a fully automated, fast, compact and portable MATLAB object to HDF5
10+ EasyH5 is a fully automated, fast, compact and portable MATLAB object to HDF5
1111exporter/importer. It contains two easy-to-use functions - ` loadh5.m ` and
1212` saveh5.m ` . The ` saveh5.m ` can handle almost all MATLAB data types, including
1313structs, struct arrays, cells, cell arrays, real and complex arrays, strings,
1414and ` containers.Map ` objects. All other data classes (such as a table, digraph,
1515etc) can also be stored/loaded seemlessly using an undocumented data serialization
1616interface (MATLAB only).
1717
18- EazyH5 stores complex numerical arrays using a special compound data type in an
18+ EasyH5 stores complex numerical arrays using a special compound data type in an
1919HDF5 dataset. The real-part of the data are stored as ` Real ` and the imaginary
2020part is stored as the ` Imag ` component. The ` loadh5.m ` automatically converts
21- such data structure to a complex array. Starting from v0.8, EazyH5 also supports
21+ such data structure to a complex array. Starting from v0.8, EasyH5 also supports
2222saving and loading sparse arrays using a compound dataset with 2 or 3
2323specialized subfields: ` SparseArray ` , ` Real ` , and, in the case of a sparse
2424complex array, ` Imag ` . The sparse array dimension is stored as an attribute
2525named ` SparseArraySize ` , attached with the dataset. Using the ` deflate ` filter
2626to save compressed arrays is supported in v0.8 and later.
2727
2828Because HDF5 does not directly support 1-D/N-D cell arrays or struct arrays,
29- EazyH5 converts these data structures into data groups with names in the
29+ EasyH5 converts these data structures into data groups with names in the
3030following format
3131```
3232 ['/hdf5/path/.../varname',num2str(idx1d)]
@@ -39,11 +39,11 @@ below.
3939
4040## Installation
4141
42- The EazyH5 toolbox can be installed using a single command
42+ The EasyH5 toolbox can be installed using a single command
4343```
44- addpath('/path/to/eazyh5 ');
44+ addpath('/path/to/easyh5 ');
4545```
46- where the ` /path/to/eazyh5 ` should be replaced by the unzipped folder
46+ where the ` /path/to/easyh5 ` should be replaced by the unzipped folder
4747of the toolbox (i.e. the folder containing ` loadh5.m/saveh5.m ` ).
4848
4949## Usage
@@ -88,16 +88,16 @@ Example:
8888```
8989
9090## Known problems
91- - EazyH5 currently does not support 2D cell and struct arrays
91+ - EasyH5 currently does not support 2D cell and struct arrays
9292- If a cell name ends with a number, such as ` a10={...} ` ; ` regrouph5 ` can not group the cell correctly
9393- If a database/group name is longer than 63 characters, it may have the risk of being truncated
9494
95- ## Contribute to EazyH5
95+ ## Contribute to EasyH5
9696
9797Please submit your bug reports, feature requests and questions to the Github Issues page at
9898
99- https://github.com/fangq/eazyh5 /issues
99+ https://github.com/fangq/easyh5 /issues
100100
101101Please feel free to fork our software, making changes, and submit your revision back
102- to us via "Pull Requests". EazyH5 is open-source and welcome to your contributions!
102+ to us via "Pull Requests". EasyH5 is open-source and welcome to your contributions!
103103
0 commit comments