Skip to content

Commit c82f306

Browse files
committed
doc
1 parent 1a48741 commit c82f306

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

Readme.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ The NetCDF4 functions also work with GNU Octave when
77
[octave-netcdf](https://octave.sourceforge.io/netcdf/index.html)
88
is installed.
99

10-
## hdf5
10+
## HDF5
1111

1212
* Check that a dataset exists in file:
1313

1414
```matlab
1515
h5exists(filename, dataset_name)
1616
```
1717
18-
* Save a varable to a dataset. If dataset exists, the existing dataset shape must match the variable.
18+
* Save a variable to a dataset. If dataset exists, the existing dataset shape must match the variable.
1919
2020
```matlab
2121
h5save(filename, dataset_name, dataset)
@@ -33,15 +33,15 @@ is installed.
3333
h5variables(filename)
3434
```
3535
36-
### netcdf
36+
## NetCDF4
3737
3838
* Check that a variable exists in file:
3939
4040
```matlab
4141
ncexists(filename, variable_name)
4242
```
4343
44-
* Save a varable to a dataset. If dataset exists, the existing dataset shape must match the variable.
44+
* Save a variable to a dataset. If dataset exists, the existing dataset shape must match the variable.
4545
4646
```matlab
4747
ncsave(filename, variable_name, variable)
@@ -72,3 +72,15 @@ is installed.
7272
```matlab
7373
expanduser(path)
7474
```
75+
76+
## unit tests
77+
78+
The files
79+
[test_hdf5.m](./test_hdf5.m)
80+
and
81+
[test_netcdf.m](./test_netcdf.m)
82+
are meant to be each run serially.
83+
That is, if using Matlab
84+
[runtests](https://www.mathworks.com/help/matlab/ref/runtests.html)
85+
don't use
86+
['UseParallel', true](https://www.mathworks.com/help/parallel-computing/run-matlab-functions-with-automatic-parallel-support.html).

0 commit comments

Comments
 (0)