MNT Add usage examples for 'perms' and 'qs'

README.rst

@@ -20,7 +20,7 @@ EMBL utilities
 Examples
 ========
 
-Submitjob
+submitjob
 ---------
 
 Save this into ``myscript.job`` and launch with ``submitjob myscript.job``. If using SLURM you can use ``submit-slurm`` instead::
@@ -42,3 +42,35 @@ Save this into ``myscript.job`` and launch with ``submitjob myscript.job``. If u
     # Some more jobs to run as part of the same array
     python compute_something_else.py
     python validate.py
+
+perms
+-----
+
+Display permissions of path to reach the file, resolving any symlinks along the way ::
+
+    % perms /g/scb2/bork/mocat/software/R/3.4.1/bin/R
+
+    -r-xr-xr-x  3     mocat     mocat  9468     Jan  1   1970   /g/bork3/home/mocat/nix/store/6549ws1c4y0ibj3qyfmd7d0kzyfzgzcd-R-3.4.1/bin/R
+    dr-xr-xr-x  2     mocat     mocat  4096     Jan  1   1970   /g/bork3/home/mocat/nix/store/6549ws1c4y0ibj3qyfmd7d0kzyfzgzcd-R-3.4.1/bin
+    dr-xr-xr-x  6     mocat     mocat  4096     Jan  1   1970   /g/bork3/home/mocat/nix/store/6549ws1c4y0ibj3qyfmd7d0kzyfzgzcd-R-3.4.1
+    drwxr-xr-x  6717  mocat     mocat  3424256  Feb  14  19:22  /g/bork3/home/mocat/nix/store
+    drwxr-xr-x  7     mocat     mocat  4096     Mar  25  2017   /g/bork3/home/mocat/nix
+    drwxr-xr-x  16    mocat     mocat  4096     Feb  14  19:27  /g/bork3/home/mocat
+    drwxr-x--t  86    adm_bork  bork   8192     Nov  3   10:51  /g/bork3/home
+    drwxr-xr-x  32    adm_bork  bork   4096     Apr  4   2017   /g/bork3
+    drwxr-xr-x  10    root      root   0        Feb  19  13:31  /g
+    drwxr-xr-x  36    root      root   4096     Oct  12  15:40  /
+
+qs
+--
+
+Show status of different clusters::
+
+    % qs alpha beta sigma
+
+               Host       CPU  CPU-Free       MEM  MEM-Free   Usage %   Avail %      Rank
+              alpha        64        57  940.4GiB  486.2GiB     28.62     50.70      2.99
+               beta        64        24  234.9GiB      0.0B     80.25      0.00      0.00
+              sigma        92        10  173.5GiB   90.8GiB     68.54      9.77      0.12
+    ---------------  --------  --------  --------  --------  --------  --------  --------
+             GLOBAL       220        91    1.3TiB  577.0GiB     61.49     17.56