User Tools

Site Tools


howtos:toolcoding:getprojectexportpath

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
howtos:toolcoding:getprojectexportpath [2013/06/04 13:45]
shona.weldon
howtos:toolcoding:getprojectexportpath [2013/06/04 13:46] (current)
shona.weldon
Line 15: Line 15:
  
 ===== How To ===== ===== How To =====
-==== For exporting results for a project ====+==== For exporting ​files as results for a project ====
 There is a sub routine called getProjectExportPath_v2.t (potentially updated version number over time). ​ That subroutine takes the following as inputs/​outputs:​ There is a sub routine called getProjectExportPath_v2.t (potentially updated version number over time). ​ That subroutine takes the following as inputs/​outputs:​
   * inputStringSet[] - this is a string set with 3 entries in ORDER:   * inputStringSet[] - this is a string set with 3 entries in ORDER:
     * exportDataDir - this is the root of where the returned path starts - you must ensure this part of the path is previously made it building like this:     * exportDataDir - this is the root of where the returned path starts - you must ensure this part of the path is previously made it building like this:
-<​code>​ buildstring ($exportDataDirRoot,​ $modelHome, "/",​ "/​exportData/"​)+<​code>​ buildstring ($exportDataDirRoot,​ $modelHome, "/",​ "/​exportData/"​) ​</​code>​
     * subjectArea - this is actually the **last** part of the path and set it to the subject area for the files you are exporting (eg commercial, residential,​ elecProd etc)     * subjectArea - this is actually the **last** part of the path and set it to the subject area for the files you are exporting (eg commercial, residential,​ elecProd etc)
     * projectAppendText - $modelName - this is an environment variable which is the model base name of the model family ​     * projectAppendText - $modelName - this is an environment variable which is the model base name of the model family ​
Line 29: Line 29:
   * inputStringSet[] - this is a string set with 3 entries in ORDER:   * inputStringSet[] - this is a string set with 3 entries in ORDER:
     * exportDataDir - this is the root of where the returned path starts - you must ensure this part of the path is previously made it building like this:     * exportDataDir - this is the root of where the returned path starts - you must ensure this part of the path is previously made it building like this:
-<​code>​ buildstring ($viewInputsStorePath,​ $modelHome, "/",​ $modelVersion,​ "/​viewData/​IndividualViews/"​)+<​code>​ buildstring ($viewInputsStorePath,​ $modelHome, "/",​ $modelVersion,​ "/​viewData/​IndividualViews/"​)</​code>​
     * subjectArea - this is actually the **last** part of the path and is best set to the view name     * subjectArea - this is actually the **last** part of the path and is best set to the view name
     * projectAppendText - Just set to the string "​Proj"​ for projection. ​ Recall in the case of exports you want this to be the model base name of the model family but NOT in this case because you do not want the output files to be model family specific.     * projectAppendText - Just set to the string "​Proj"​ for projection. ​ Recall in the case of exports you want this to be the model base name of the model family but NOT in this case because you do not want the output files to be model family specific.
   * exportDirSet[] - this is where the string containing the constructed path will be.  You will have to then make this into an informant and extract the string from this set to use it   * exportDirSet[] - this is where the string containing the constructed path will be.  You will have to then make this into an informant and extract the string from this set to use it
   * outProjectParams[projParms] - This contains all the other info you may want for exporting data related to your project (see background info about projects) HOWEVER in the case of view data we don't need this information   * outProjectParams[projParms] - This contains all the other info you may want for exporting data related to your project (see background info about projects) HOWEVER in the case of view data we don't need this information
- 
  
  
howtos/toolcoding/getprojectexportpath.1370353540.txt.gz ยท Last modified: 2013/06/04 13:45 by shona.weldon