howtos:toolcoding:subroutinepackage
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
|
howtos:toolcoding:subroutinepackage [2013/06/04 12:31] shona.weldon |
howtos:toolcoding:subroutinepackage [2013/06/04 12:38] shona.weldon |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| Subroutines are reusable code files that can be called from views. The advantage of using them is there is only one copy of common code which makes it more maintainable and also gives consistency to how you interact with your views. | Subroutines are reusable code files that can be called from views. The advantage of using them is there is only one copy of common code which makes it more maintainable and also gives consistency to how you interact with your views. | ||
| - | We have developed a set of subroutines you can use as a starting point. Below is a .zip file which is a package of files to get you started and the rest of this article describes how to use them. | + | We have developed a set of subroutines you can use as a starting point. Please contact your whatIf? support person to get the package |
| - | + | ||
| - | This is the subroutine package that should be unzipped in your model account directory. Something like /models/myModel/Vx/views to create a subdirectory called subroutines. | + | |
| - | + | ||
| - | {{:howtos:toolcoding:subroutines.zip|}} | + | |
| Please consider these **use at your own risk**. We are not supporting them but are just providing them as a starting point from which you can modify them as you wish! | Please consider these **use at your own risk**. We are not supporting them but are just providing them as a starting point from which you can modify them as you wish! | ||
| Line 33: | Line 29: | ||
| Now you are ready to write views that use subroutines. See below info about the examples that are a part of the sub routine bundle you have downloaded and extracted. | Now you are ready to write views that use subroutines. See below info about the examples that are a part of the sub routine bundle you have downloaded and extracted. | ||
| + | |||
| + | ===== Data Storing for views - viewData ===== | ||
| + | There are 3 places to store data outside the model: primaryData, referenceData, and viewData. The viewData directory holds files that inform views as they run for things like: | ||
| + | * user interaction from previous runs | ||
| + | * the setup for the reference scenario such as start year for projection, projection style etc | ||
| + | * in the case of caness all the aggregation mapping files for the big energy and emissions views | ||
| + | |||
| + | ===== Data Storing for views - viewData ===== | ||
| ===== Examples ===== | ===== Examples ===== | ||
| - | In that new folder you will find an examples sub folder with some example views: | + | In that new folder you will find an TemplateViews sub folder with some example views: |
| - | levelVarProjection.t | + | levelVarProjection_<verson>.t |
| * This type of view projects a variable which holds variables which are not share variables, like rates or efficiency levels etc | * This type of view projects a variable which holds variables which are not share variables, like rates or efficiency levels etc | ||
| * It gives several different ways to project this variable through a menu command | * It gives several different ways to project this variable through a menu command | ||
howtos/toolcoding/subroutinepackage.txt · Last modified: 2013/06/04 12:38 by shona.weldon
Page Tools
