From 7c76642f33d8aa436c1e88a5c50fb55e3e6e712c Mon Sep 17 00:00:00 2001 From: Qianqian Fang Date: Tue, 1 Oct 2019 18:28:50 -0400 Subject: [PATCH] rename to eazyh5 to avoid spelling confusions-already got questions --- AUTHORS.txt | 2 +- ChangeLog.txt | 4 ++-- README.md | 26 +++++++++++++------------- decodevarname.m | 4 ++-- encodevarname.m | 4 ++-- loadh5.m | 4 ++-- regrouph5.m | 4 ++-- saveh5.m | 4 ++-- 8 files changed, 26 insertions(+), 26 deletions(-) diff --git a/AUTHORS.txt b/AUTHORS.txt index b76f98a..3c656a1 100644 --- a/AUTHORS.txt +++ b/AUTHORS.txt @@ -1,4 +1,4 @@ -EazyH5 is written by Qianqian Fang as part of the NeuroJData/OpenJData project. +EasyH5 is written by Qianqian Fang as part of the NeuroJData/OpenJData project. Qianqian is currently an Assistant Professor in the Department of Bioengineering at Northeastern University. diff --git a/ChangeLog.txt b/ChangeLog.txt index b9d78a2..217fa4c 100644 --- a/ChangeLog.txt +++ b/ChangeLog.txt @@ -2,7 +2,7 @@ Major updates are marked with a "*" -== EazyH5 v0.8 (Go - Japanese 5), FangQ == +== EasyH5 v0.8 (Go - Japanese 5), FangQ == 2019-09-30*[104a9ed] add regroup option for loadh5, change regexp, add demo 2019-09-30*[bb762a8] support saving and restoring non-ascii group and dataset names, like JSONLab @@ -16,7 +16,7 @@ Major updates are marked with a "*" 2019-09-22 [289d2b6] update readme 2019-09-22*[b09c80f] now reading data in creation order, fix #1, also reads specified node using rootpath -== EazyH5 v0.5 (Cinco - Spanish 5), FangQ == +== EasyH5 v0.5 (Cinco - Spanish 5), FangQ == 2019-09-19 [dc62ed5] update code name and version number 2019-09-19 [66de6e2] tracking creation order, need to use links to read in loadh5 diff --git a/README.md b/README.md index b4043c8..f1b7daf 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -# EazyH5 Toolbox - An easy-to-use HDF5 data interface (loadh5 and saveh5) +# EasyH5 Toolbox - An easy-to-use HDF5 data interface (loadh5 and saveh5) * Copyright (C) 2019 Qianqian Fang * License: GNU General Public License version 3 (GPL v3) or 3-clause BSD license, see LICENSE*.txt * Version: 0.8 (code name: Go - Japanese 5) -* URL: http://github.com/fangq/eazyh5 +* URL: http://github.com/fangq/easyh5 ## Overview -EazyH5 is a fully automated, fast, compact and portable MATLAB object to HDF5 +EasyH5 is a fully automated, fast, compact and portable MATLAB object to HDF5 exporter/importer. It contains two easy-to-use functions - `loadh5.m` and `saveh5.m`. The `saveh5.m` can handle almost all MATLAB data types, including structs, struct arrays, cells, cell arrays, real and complex arrays, strings, @@ -15,10 +15,10 @@ and `containers.Map` objects. All other data classes (such as a table, digraph, etc) can also be stored/loaded seemlessly using an undocumented data serialization interface (MATLAB only). -EazyH5 stores complex numerical arrays using a special compound data type in an +EasyH5 stores complex numerical arrays using a special compound data type in an HDF5 dataset. The real-part of the data are stored as `Real` and the imaginary part is stored as the `Imag` component. The `loadh5.m` automatically converts -such data structure to a complex array. Starting from v0.8, EazyH5 also supports +such data structure to a complex array. Starting from v0.8, EasyH5 also supports saving and loading sparse arrays using a compound dataset with 2 or 3 specialized subfields: `SparseArray`, `Real`, and, in the case of a sparse complex array, `Imag`. The sparse array dimension is stored as an attribute @@ -26,7 +26,7 @@ named `SparseArraySize`, attached with the dataset. Using the `deflate` filter to save compressed arrays is supported in v0.8 and later. Because HDF5 does not directly support 1-D/N-D cell arrays or struct arrays, -EazyH5 converts these data structures into data groups with names in the +EasyH5 converts these data structures into data groups with names in the following format ``` ['/hdf5/path/.../varname',num2str(idx1d)] @@ -39,11 +39,11 @@ below. ## Installation -The EazyH5 toolbox can be installed using a single command +The EasyH5 toolbox can be installed using a single command ``` - addpath('/path/to/eazyh5'); + addpath('/path/to/easyh5'); ``` -where the `/path/to/eazyh5` should be replaced by the unzipped folder +where the `/path/to/easyh5` should be replaced by the unzipped folder of the toolbox (i.e. the folder containing `loadh5.m/saveh5.m`). ## Usage @@ -88,16 +88,16 @@ Example: ``` ## Known problems -- EazyH5 currently does not support 2D cell and struct arrays +- EasyH5 currently does not support 2D cell and struct arrays - If a cell name ends with a number, such as `a10={...}`; `regrouph5` can not group the cell correctly - If a database/group name is longer than 63 characters, it may have the risk of being truncated -## Contribute to EazyH5 +## Contribute to EasyH5 Please submit your bug reports, feature requests and questions to the Github Issues page at -https://github.com/fangq/eazyh5/issues +https://github.com/fangq/easyh5/issues Please feel free to fork our software, making changes, and submit your revision back -to us via "Pull Requests". EazyH5 is open-source and welcome to your contributions! +to us via "Pull Requests". EasyH5 is open-source and welcome to your contributions! diff --git a/decodevarname.m b/decodevarname.m index 04379b8..ed1112c 100644 --- a/decodevarname.m +++ b/decodevarname.m @@ -25,9 +25,9 @@ % decodevarname('a_') % returns a_ as it is a valid variable name % decodevarname('x0xE58F98__0xE9878F_') % returns '变量' % -% this file is part of EazyH5 Toolbox: https://github.com/fangq/eazyh5 +% this file is part of EasyH5 Toolbox: https://github.com/fangq/easyh5 % -% License: GPLv3 or 3-clause BSD license, see https://github.com/fangq/eazyh5 for details +% License: GPLv3 or 3-clause BSD license, see https://github.com/fangq/easyh5 for details % isunpack=jsonopt('UnpackHex',1,varargin{:}); diff --git a/encodevarname.m b/encodevarname.m index 937c0a3..b336f2d 100644 --- a/encodevarname.m +++ b/encodevarname.m @@ -32,9 +32,9 @@ % encodevarname('a_') % returns a_ as it is a valid variable name % encodevarname('变量') % returns 'x0xE58F98__0xE9878F_' % -% this file is part of EazyH5 Toolbox: https://github.com/fangq/eazyh5 +% this file is part of EasyH5 Toolbox: https://github.com/fangq/easyh5 % -% License: GPLv3 or 3-clause BSD license, see https://github.com/fangq/eazyh5 for details +% License: GPLv3 or 3-clause BSD license, see https://github.com/fangq/easyh5 for details % if(~isempty(regexp(str,'^[^A-Za-z]','once'))) diff --git a/loadh5.m b/loadh5.m index 92f9553..94ea354 100644 --- a/loadh5.m +++ b/loadh5.m @@ -38,9 +38,9 @@ % a4=loadh5('test.h5','/a1') % % This function was adapted from h5load.m by Pauli Virtanen -% This file is part of EazyH5 Toolbox: https://github.com/fangq/eazyh5 +% This file is part of EasyH5 Toolbox: https://github.com/fangq/easyh5 % -% License: GPLv3 or 3-clause BSD license, see https://github.com/fangq/eazyh5 for details +% License: GPLv3 or 3-clause BSD license, see https://github.com/fangq/easyh5 for details % path = ''; diff --git a/regrouph5.m b/regrouph5.m index cf9e916..99776f5 100644 --- a/regrouph5.m +++ b/regrouph5.m @@ -37,9 +37,9 @@ % rawdata=loadh5('test.h5') % data=regrouph5(rawdata) % -% this file is part of EazyH5 Toolbox: https://github.com/fangq/eazyh5 +% this file is part of EasyH5 Toolbox: https://github.com/fangq/easyh5 % -% License: GPLv3 or 3-clause BSD license, see https://github.com/fangq/eazyh5 for details +% License: GPLv3 or 3-clause BSD license, see https://github.com/fangq/easyh5 for details % if(nargin<1) diff --git a/saveh5.m b/saveh5.m index ed6a809..a9ff175 100644 --- a/saveh5.m +++ b/saveh5.m @@ -33,9 +33,9 @@ function saveh5(data, fname, varargin) % saveh5(a(1),'test2.h5','rootname',''); % saveh5(a(1),'test2.h5','compression','deflate','compressarraysize',1); % -% this file is part of EazyH5 Toolbox: https://github.com/fangq/eazyh5 +% this file is part of EasyH5 Toolbox: https://github.com/fangq/easyh5 % -% License: GPLv3 or 3-clause BSD license, see https://github.com/fangq/eazyh5 for details +% License: GPLv3 or 3-clause BSD license, see https://github.com/fangq/easyh5 for details %