auto publish

Author: scivision

+stdlib/absolute.m

@@ -1,15 +1,20 @@
 function c = absolute(p, base, expand_tilde, use_java)
-%% absolute(p)
-% path need not exist
-% absolute path will be relative to pwd if not exist
+%% ABSOLUTE Determine absolute path
+% c = absolute(p);
+% Path "p" need not exist.
+% Absolute path will be relative to pwd if path does not exist.
+%
+% c = absolute(p, base);
+% the "base" path is used instead of pwd.
 %
 %%% Inputs
 % * p: path to make absolute
 % * base: if present, base on this instead of cwd
 % * expand_tilde: expand ~ to username if present
 %%% Outputs
-% * c: resolved path
-% does not normalize
+% * c: absolute path
+%
+% does not normalize path
 % non-existant path is made absolute relative to pwd
 arguments
   p (1,1) string

+stdlib/auto_chunk_size.m

@@ -1,6 +1,6 @@
 function csize = auto_chunk_size(dims)
-%% auto_chunk_size(dims)
-% automatically determine HDF5 / NetCDF4 chunk size.
+%% AUTO_CHUNK_SIZE determine HDF5 / NetCDF4 chunk size
+%
 % based on https://github.com/h5py/h5py/blob/master/h5py/_hl/filters.py
 % refer to https://support.hdfgroup.org/HDF5/Tutor/layout.html
 %

+stdlib/canonical.m

@@ -1,13 +1,11 @@
 function c = canonical(p, expand_tilde, use_java)
-%% canonical(p)
-% If exists, canonical absolute path is returned
-% if path does not exist, normalized relative path is returned
+%% CANONICAL Canonicalize path
+% c = canonical(p);
+% If exists, canonical absolute path is returned.
+% if path does not exist, normalized relative path is returned.
+% UNC paths are not canonicalized.
 %
-% NOTE: some network file systems are not resolvable by Matlab Java
-% subsystem, but are sometimes still valid--so return
-% unmodified path if this occurs.
-%
-% This also resolves Windows short paths to full long paths.
+% This also resolves Windows short paths to long paths.
 %
 %%% Inputs
 % * p: path to make canonical

+stdlib/checkRAM.m

@@ -1,5 +1,5 @@
 function [OK,newSizeBytes,freebytes] = checkRAM(newSize, myclass)
-%% checkRAM(newSize, myclass)
+%% CHECKRAN estimate if RAM will fit a new array
 % checks that requested memory for the new array won't exceed AVAILABLE RAM with Matlab
 %
 % This script is optimistic as Matlab won't always be able to

+stdlib/cpu_count.m

@@ -1,5 +1,5 @@
 function N = cpu_count
-%CPU_COUNT how many CPUs
+%% CPU_COUNT how many CPUs are available
 N = maxNumCompThreads;
 if N < 2  % happens on some HPC
   N = feature('NumCores');

+stdlib/cpu_load.m

@@ -2,6 +2,7 @@
 %% CPU_LOAD get total physical CPU load
 % https://docs.oracle.com/en/java/javase/21/docs/api/jdk.management/com/sun/management/OperatingSystemMXBean.html#getCpuLoad()
 % Returns the "recent cpu usage" for the whole system.
+%
 % This value is a double in the [0.0,1.0] interval.
 % A value of 0.0 means that all CPUs were idle during the recent period of time observed, while a value of 1.0 means that all CPUs were actively running 100% of the time during the recent period being observed.
 % All values betweens 0.0 and 1.0 are possible depending of the activities going on in the system.

+stdlib/create_symlink.m

@@ -1,6 +1,13 @@
 function ok = create_symlink(target, link)
-%% create_symlink create symbolic link
-% https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/Files.html#createSymbolicLink(java.nio.file.Path,java.nio.file.Path,java.nio.file.attribute.FileAttribute...)
+%% CREATE_SYMLINK create symbolic link
+%
+%%% Inputs
+% * target: path to link to
+% * link: path to create link at
+%%% Outputs
+% * ok: true if successful
+%
+% Ref: https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/nio/file/Files.html#createSymbolicLink(java.nio.file.Path,java.nio.file.Path,java.nio.file.attribute.FileAttribute...)
 
 arguments
   target (1,1) string

+stdlib/diskfree.m

@@ -1,8 +1,10 @@
 function freebytes = diskfree(direc)
-%% diskfree(direc)
+%% DISKFREE disk free space
 % returns disk free space in bytes
+%
 % example:  diskfree('/')
-% https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html#getUsableSpace()
+%
+% Ref: https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html#getUsableSpace()
 arguments
   direc (1,1) string {mustBeFolder}
 end

+stdlib/exists.m

@@ -1,6 +1,11 @@
 function ok = exists(p, use_java)
-%% exists does path exist
-% https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html#exists()
+%% EXIST does path exist
+%%% Inputs
+% * p: path to check
+%%% Outputs
+% * ok: true if exists
+%
+% Ref: https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/File.html#exists()
 
 arguments
   p (1,1) string

+stdlib/expanduser.m

@@ -1,13 +1,12 @@
 function e = expanduser(p, use_java)
-%% expanduser(path)
-% expands tilde ~ into user home directory
+%% EXPANDUSER expands tilde ~ into user home directory
 %
 % Useful for Matlab functions that can't handle ~
 %
 %%% Inputs
 % * p: path to expand, if tilde present
 %%% Outputs
-% * expanded: expanded path
+% * e: expanded path
 arguments
   p (1,1) string
   use_java (1,1) logical = false