Skip to content

Commit eb3002a

Browse files
committed
[doc] add installation instructions
1 parent eef972e commit eb3002a

File tree

5 files changed

+22
-10
lines changed

5 files changed

+22
-10
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
* Copyright (C) 2019,2022,2025 Qianqian Fang <q.fang at neu.edu>
66
* License: GNU General Public License version 3 (GPL v3) or 3-clause BSD license, see LICENSE*.txt
77
* Version: 0.9 (code name: Daseot - Korean 5)
8-
* URL: http://github.com/NeuroJSON/easyh5
9-
* Compatibility: MATLAB R2010b or newer
8+
* URL: https://github.com/NeuroJSON/easyh5
9+
* Compatibility: MATLAB R2010b or newer and GNU Octave 5.0 or newer
1010
* Acknowledgement: This project is supported by US National Institute of Health (NIH)
1111
grant [U24-NS124027 (NeuroJSON)](https://reporter.nih.gov/project-details/10308329)
1212

@@ -46,11 +46,23 @@ below.
4646

4747
The EasyH5 toolbox can be installed using a single command
4848
```
49-
addpath('/path/to/easyh5');
49+
addpath('/path/to/easyh5');
5050
```
5151
where the `/path/to/easyh5` should be replaced by the unzipped folder
5252
of the toolbox (i.e. the folder containing `loadh5.m/saveh5.m`).
5353

54+
In v0.8 and newer releases, EasyH5 supports GNU Octave 5.x or later.
55+
In order to use EasyH5 with Octave, one must install a toolbox named oct-hdf5
56+
by running the following command in Octave once
57+
```
58+
pkg install https://github.com/fangq/oct-hdf5/archive/refs/heads/main.zip
59+
pkg load oct-hdf5
60+
```
61+
62+
EasyH5 supports MATLAB R2010b or newer. However, `saveh5` can not save empty
63+
arrays for MATLAB releases before 2015.
64+
65+
5466
## Usage
5567

5668
### `saveh5` - Save a MATLAB struct (array) or cell (array) into an HDF5 file

jdatadecode.m

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
% jsondecode for MATLAB R2016b or later)
88
%
99
% This function implements the JData Specification Draft 3 (Jun. 2020)
10-
% see http://github.com/NeuroJSON/jdata for details
10+
% see https://github.com/NeuroJSON/jdata for details
1111
%
1212
% authors:Qianqian Fang (q.fang <at> neu.edu)
1313
%
@@ -55,7 +55,7 @@
5555
% license:
5656
% BSD or GPL version 3, see LICENSE_{BSD,GPLv3}.txt files for details
5757
%
58-
% -- this function is part of JSONLab toolbox (http://iso2mesh.sf.net/cgi-bin/index.cgi?jsonlab)
58+
% -- this function is part of JSONLab toolbox (https://iso2mesh.sf.net/cgi-bin/index.cgi?jsonlab)
5959
%
6060

6161
newdata = data;

jdataencode.m

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66
% jdata=jdataencode(data, 'Param1',value1, 'Param2',value2,...)
77
%
88
% Annotate a MATLAB struct or cell array into a JData-compliant data
9-
% structure as defined in the JData spec: http://github.com/NeuroJSON/jdata.
9+
% structure as defined in the JData spec: https://github.com/NeuroJSON/jdata.
1010
% This encoded form servers as an intermediate format that allows unambiguous
1111
% storage, exchange of complex data structures and easy-to-serialize by
1212
% json encoders such as savejson and jsonencode (MATLAB R2016b or newer)
1313
%
1414
% This function implements the JData Specification Draft 3 (Jun. 2020)
15-
% see http://github.com/NeuroJSON/jdata for details
15+
% see https://github.com/NeuroJSON/jdata for details
1616
%
1717
% author: Qianqian Fang (q.fang <at> neu.edu)
1818
%
@@ -69,7 +69,7 @@
6969
% license:
7070
% BSD or GPL version 3, see LICENSE_{BSD,GPLv3}.txt files for details
7171
%
72-
% -- this function is part of JSONLab toolbox (http://iso2mesh.sf.net/cgi-bin/index.cgi?jsonlab)
72+
% -- this function is part of JSONLab toolbox (https://iso2mesh.sf.net/cgi-bin/index.cgi?jsonlab)
7373
%
7474

7575
if (nargin == 0)

mergestruct.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
% license:
1717
% BSD or GPL version 3, see LICENSE_{BSD,GPLv3}.txt files for details
1818
%
19-
% -- this function is part of JSONLab toolbox (http://iso2mesh.sf.net/cgi-bin/index.cgi?jsonlab)
19+
% -- this function is part of JSONLab toolbox (https://iso2mesh.sf.net/cgi-bin/index.cgi?jsonlab)
2020
%
2121

2222
if (~isstruct(s1) || ~isstruct(s2))

varargin2struct.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
% license:
2020
% BSD or GPL version 3, see LICENSE_{BSD,GPLv3}.txt files for details
2121
%
22-
% -- this function is part of JSONLab toolbox (http://iso2mesh.sf.net/cgi-bin/index.cgi?jsonlab)
22+
% -- this function is part of JSONLab toolbox (https://iso2mesh.sf.net/cgi-bin/index.cgi?jsonlab)
2323
%
2424

2525
len = length(varargin);

0 commit comments

Comments
 (0)