remove unused import

Author: scivision

+hdf5nc/h5exists.m

@@ -1,21 +1,23 @@
 function exists = h5exists(filename, varnames)
 % check if variable(s) exists in HDF5 file
 %
+% parameters
+% ----------
 % filename: HDF5 filename
 % varname: name of variable inside HDF5 file
 %
+% returns
+% -------
 % exists: boolean (scalar or vector)
 
 arguments
   filename (1,1) string
   varnames (1,:) string
 end
 
-import hdf5nc.h5variables
-
 i = startsWith(varnames, "/");
 varnames(i) = extractAfter(varnames(i), 1);
 % NOT contains because we want exact string match
-exists = ismember(varnames, h5variables(filename));
+exists = ismember(varnames, hdf5nc.h5variables(filename));
 
 end % function

+hdf5nc/h5save.m

@@ -2,6 +2,7 @@ function h5save(filename, varname, A, opts)
 % H5SAVE
 % create or append to HDF5 file
 % parent folder (file directory) must already exist
+
 arguments
   filename (1,1) string
   varname (1,1) string
@@ -10,8 +11,6 @@ function h5save(filename, varname, A, opts)
   opts.type string = string.empty
 end
 
-import hdf5nc.h5exists
-
 if isnumeric(A)
   mustBeReal(A)
 end
@@ -34,7 +33,7 @@ function h5save(filename, varname, A, opts)
   sizeA = size(A);
 end
 
-if isfile(filename) && h5exists(filename, varname)
+if isfile(filename) && hdf5nc.h5exists(filename, varname)
   exist_file(filename, varname, A, sizeA)
 else
   new_file(filename, varname, A, sizeA)
@@ -44,8 +43,8 @@ function h5save(filename, varname, A, opts)
 
 
 function exist_file(filename, varname, A, sizeA)
-import hdf5nc.h5size
-diskshape = h5size(filename, varname);
+
+diskshape = hdf5nc.h5size(filename, varname);
 if length(diskshape) >= 2
   % start is always a row vector, regardless of shape of array
   start = ones(1,ndims(A));

+hdf5nc/h5variables.m

@@ -1,14 +1,26 @@
-function [names, groups] = h5variables(filename, group)
-% get dataset names and groups in an HDF5 file
+function [names, groups] = h5variables(file, group)
+% get dataset names in a file
+% Optionally, get first level of groups in a file.
+%
+% parameters
+% ----------
+% file: filename
+% group: group name (optional)
+%
+% returns
+% -------
+% names: variable names
+% groups: file groups
+
 arguments
-  filename (1,1) string
+  file (1,1) string
   group string = string.empty
 end
 
 names = string.empty;
 groups = string.empty;
 
-finf = h5info(expanduser(filename));
+finf = h5info(expanduser(file));
 ds = finf.Datasets;
 if isempty(ds)
   return

+hdf5nc/ncsave.m

@@ -10,8 +10,6 @@ function ncsave(filename, varname, A, opts)
   opts.type string = string.empty
 end
 
-import hdf5nc.ncexists
-
 filename = expanduser(filename);
 
 if isempty(opts.dims)
@@ -42,7 +40,7 @@ function ncsave(filename, varname, A, opts)
 % coerce if needed
 A = coerce_ds(A, opts.type);
 
-if isfile(filename) && ncexists(filename, varname)
+if isfile(filename) && hdf5nc.ncexists(filename, varname)
   exist_file(filename, varname, A, sizeA)
 else
   new_file(filename, varname, A, sizeA, ncdims)
@@ -52,8 +50,8 @@ function ncsave(filename, varname, A, opts)
 
 
 function exist_file(filename, varname, A, sizeA)
-import hdf5nc.ncsize
-diskshape = ncsize(filename, varname);
+
+diskshape = hdf5nc.ncsize(filename, varname);
 
 if all(diskshape == sizeA)
   ncwrite(filename, varname, A)
@@ -71,7 +69,6 @@ function new_file(filename, varname, A, sizeA, ncdims)
 folder = fileparts(filename);
 assert(isfolder(folder), '%s is not a folder, cannot create %s', folder, filename)
 
-
 if isscalar(A)
   nccreate(filename, varname, 'Datatype', class(A), 'Format', 'netcdf4')
 elseif isvector(A)

+hdf5nc/ncvariables.m

@@ -1,5 +1,14 @@
 function names = ncvariables(filename)
-% get dataset names and groups in an NetCDF4 file
+% get dataset names in a file
+%
+% parameters
+% ----------
+% file: filename
+%
+% returns
+% -------
+% names: variable names
+
 arguments
   filename (1,1) string
 end

Readme.md

@@ -6,9 +6,9 @@
 
 These HDF5 and NetCDF4 functions should be built into Matlab itself, but since they're not yet, we provide them.
 
-## HDF5
+## Usage
 
-This package is setup as a Matlab package, so we assume you have either:
+This package is a Matlab package, so we assume you have either:
 
 ```matlab
 import hdf5nc.*
@@ -22,6 +22,15 @@ Run selftests by:
 runtests('hdf5nc')
 ```
 
+### HDF5
+
+Matlab R2020b uses HDF5 1.8.12.
+
+```matlab
+[major,minor,rel] = H5.get_libversion()
+```
+
+
 * Check that a dataset exists in file:
 
     ```matlab
@@ -46,7 +55,13 @@ runtests('hdf5nc')
     h5variables(filename)
     ```
 
-## NetCDF4
+### NetCDF4
+
+Matlab R2020b uses NetCDF4 4.7.3.
+
+```matlab
+netcdf.inqLibVers
+```
 
 * Check that a variable exists in file:
 
@@ -71,11 +86,3 @@ runtests('hdf5nc')
     ```matlab
     ncvariables(filename)
     ```
-
-## General utilities
-
-* expand a leading tilde to the current user home directory
-
-    ```matlab
-    expanduser(path)
-    ```