Changes between Version 2 and Version 3 of FAQ_LoaderUpDownload

Timestamp:

Jul 6, 2006 12:30:35 PM (18 years ago)

Author:

dkearney

Comment:

--

FAQ_LoaderUpDownload

@@ -140 +140 @@
         sys.exit(-1)
 
+    # check to see if the user uploaded their own data
+    # or if they inputted the values
     inputType = lib.get('input.loader.current')
     if inputType == 'Uploaded data':
+        # they uploaded their datafile
+        # we need to write this data to a file so our science code can read it
+        # find the location of where rappture stored the data from their file
+        # and store the data int the writeData variable
         writeDataLocation = lib.get('input.loader.upload.to')
         writeData = lib.get(writeDataLocation+'.current')
     else:
+        # they manually entered their data into the GUI
+        # grab each value and create a string we can write to a file.
         start = lib.get('input.string(start).current')
         end = lib.get('input.string(end).current')
@@ -150 +158 @@
         writeData = '%s\n%s\n%s' % (start,end,step)
 
+    # prepare our semi-unique file name
     outFileName = 'inputDeck.' + getDriverId(inDeckName)
     fh = open(outFileName, 'w')
     if fh != None:
+        # write our input deck to the file
         fh.write(writeData)
         fh.close()
 
     # run the science code
-    getCommandOutput('./sineIt.py %s' % outFileName)
-
+    dirpath = os.path.dirname(sys.argv[0])
+    getCommandOutput('%s/sineIt.py %s' % (dirpath,outFileName))
+
+    # our science code outputted the answer to a file
+    # grab that file and add the answer to the Rappture library object
     dataFileName = outFileName + '.out'
+    data = ''
 
     # try to open our data file
     try:
         dFH = open(dataFileName)
+
+        # read the data from the data file
+        data = dFH.read()
+        dFH.close()
     except IOError:
         # we'll pass on dealing with the exception for now
-        # we'll just exit with a message
-        print 'Error opening file %s' % dataFileName
-        sys.exit(-1)
-
-    data = dFH.read()
-    dFH.close()
-
+        # send a message to the user letting them know there was an error
+        errMsg = 'Error opening file %s' % dataFileName
+        lib.put('output.string(errorLog).current',errMsg,1)
+
+
+    # store the data inside of the rappture library
     lib.put('output.curve(sin_data).about.label','sin curve')
     lib.put('output.curve(sin_data).about.label','sample output of the sin function')
     lib.put('output.curve(sin_data).component.xy',data)
 
+    # remove any temporary files
+    try:
+        os.remove(outFileName)
+        os.remove(dataFileName)
+    except OSError:
+        # we were unable to remove the files,
+        # send a note to the user
+        errMsg = 'Error while removing tmp files'
+        lib.put('output.string(errorLog).current',errMsg,1)
+
+    # signal to the Rappture GUI that processing has completed
     Rappture.result(lib)
+
+    # exit gracefully
     sys.exit(0)
 
@@ -232 +262 @@
 }}}
 
-
-
-
+== How it works ==
+
+As always, first the user starts simulation and the graphical user interface comes up. 
+
+
+By clicking on the loader (drop down menu) and choosing the "Upload" option the user 
+can pick a file from their local computer and have it uploaded to the rappture graphical 
+user interface. 
+
+After the user uploads their data, it is stored in the xml file at the location described in the loader:
+{{{
+<input>
+  <loader>
+    <upload>
+      <to>input.string(uploadedFile)</to>
+      <prompt>Upload Input Deck.</prompt>
+    </upload>
+  </loader>
+...
+}}}
+In this case the contents of the uploaded file was saved to ''input.string(uploadedFile).current'' as described by the path ''input.loader.upload.to''.
+
+Next the user clicks the simulate button. Rappture writes the inputs to the driver.xml file and executes the tool command (wrapper.py).
+wrapper.py reads the xml file, checks to see if the user uploaded data to the graphical user interface or manually filled in the values.
+You can check to see if the user uploaded data by comparing the value of ''input.loader.current'' to the string 'Uploaded data'. If they match, then you know the user uploaded data into the graphical user interface. As the wrapper.py script shows, to get the data that was uploaded by the user, simply issue a get command with the "upload to" location specified.
+
+In the wrapper.py python script above we issue these commands:
+{{{ 
+        writeDataLocation = lib.get('input.loader.upload.to')
+        writeData = lib.get(writeDataLocation+'.current')
+}}}
+
+now writeData holds the information that was uploaded and we can write it to a file, which is what the science code expects.
+
+{{{
+    # prepare our semi-unique file name
+    outFileName = 'inputDeck.' + getDriverId(inDeckName)
+    fh = open(outFileName, 'w')
+    if fh != None:
+        # write our input deck to the file
+        fh.write(writeData)
+        fh.close()
+}}}
+
+After writing the data to a file, we call the science code with the name of the input deck. The science code reads the input deck, calculates its science and writes the answer back to a file. The wrapper.py script then reads and parses the result file from the science code and places the results back into the rappture library.