README.rst

branch
development
changeset 54
5a2e8efdaae9
parent 51
a4ca2b6d67f5
child 63
a41f71f80c1d
--- a/README.rst	Wed Feb 03 16:18:14 2021 +0200
+++ b/README.rst	Thu Feb 04 10:19:13 2021 +0200
@@ -8,15 +8,17 @@
 * Download the processed files and graphs
 * Delete an existing measurement from the SCC (with appropriate privileges)
 
-The main functions are implemented in a class (SCC) that you can also import 
-and use in your custom scripts.
 
-The script does not provide any feedback if a file upload fails. Before using
+The script provides limited feedback when a file upload fails. Before using
 the script, you will need to upload some files manually and be confident that 
 your SCC file format and processing settings are correct.
 
 Please note that this is not part of the "official" SCC tools.
 
+In principle, the main functions are implemented in a class (SCC) that you can also import
+and use in your custom scripts. However, error handling has to be improved in this case. If you are interested
+in such use, please contact me at ioannis@inoe.ro.
+
 Any suggestions for improvements and new features are more than welcome.
 
 Installation
@@ -72,11 +74,20 @@
 
    scc_access -c ./path/to/settings.yaml upload-file 20110101po01.nc 125
 
-By default, the SCC will reject an uploaded file, if the specified measurement id already exists on the server. You
+By default, the SCC will reject an uploaded file if the specified measurement id already exists on the server. You
 can instruct the script to delete any existing measurement before uploading using the `--force_upload` flag::
 
    scc_access upload-file 20110101po01.nc 125 -p --force_upload
 
+When uploading a measurement you can require that the processing is delayed by a specified number of hours. This
+can be used to assure that your files are processed using model input data, that typically have a delay of more than
+24 hours. You can specify the delay (in hours) using the --delay option::
+
+   scc_access upload-file 20110101po01.nc 125 --delay 48
+
+.. note::
+   When specifying a delay, the script will not wait to download the output files.
+
 If you want to delete an existing measurement id from the database use the `delete`
 command and the measurement id::
     
@@ -134,6 +145,7 @@
 
     optional arguments:
       -h, --help            show this help message and exit
+      --delay DELAY         Delay processing by the specified number of hours (0 to 96).
       -p, --process         Wait for the processing results.
       --force_upload        If measurement ID exists on SCC, delete before
                             uploading.

mercurial