From 804488c637f70cf21ba268e16a8c875f16a7ae25 Mon Sep 17 00:00:00 2001 From: Christopher Eykamp Date: Fri, 16 May 2014 18:44:26 +0200 Subject: [PATCH] More documentation --- README.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.rst b/README.rst index d4f39e12..c322d6d9 100644 --- a/README.rst +++ b/README.rst @@ -84,9 +84,17 @@ the operation of iGUESS. Note that if a dataset is updated, the new data will be immediately available to modules (as iGUESS only stores pointers to the data), but if metadata changes (including bounding box), those changes will not be reflected in iGUESS until the harvester has been run. This could potentially cause a problem if datasets are used to denote Areas of Interest for a module. * wpsstart.py + + wpsstart.py is responsible for initiating a module run. When a module is run by clicking the Run button on the web interface, a message is set to the Rails server, which in turn calls wpsstart, passing a list of all the parameters which the WPS server needs to run the module. The primary task of wpsstart is to assemble these parameters into the format required by WPSClient, which makes the actual call to the WPS server. Therefore, wpsstart almost entirely consists of rather ugly parameter munging code. + * wpscheck.py + + When wpscheck is run, it will visit each running module, check its status, and make any necessary updates to the database, including registering any datasets created by the module. wpscheck should be run from cron, and should be scheduled to run frequently, say once per minute. The more frequently the process runs, the more responsive the system will feel. + * deleteDataset.py + When the user unregisters a dataset, deleteDataset gets called. deleteDataset's primary job is to ensure that any abandoned datasets on the iGUESS server are deleted. + Support