ifference between revisions of "EMK:Resources"
(Created page with "{{#hidens:}} The Resource is a core concept in EMarket. It is a specific Instance of an EMarket modelling or data formatting element. By creating multiple Instances of the sam...") |
|||
| (18 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
The Resource is a core concept in EMarket. It is a specific Instance of an EMarket modelling or data formatting element. By creating multiple Instances of the same Resource type (e.g. Generator), alternative scenarios can be rapidly created and analysed. | The Resource is a core concept in EMarket. It is a specific Instance of an EMarket modelling or data formatting element. By creating multiple Instances of the same Resource type (e.g. Generator), alternative scenarios can be rapidly created and analysed. | ||
| − | The list below shows the names of | + | The list below shows the names of the Resources used in EMarket. Clicking on a name will take you to the relevant page for more information on the Resource. |
[[EMK:Executing a Run | Batch]] | [[EMK:Executing a Run | Batch]] | ||
| Line 27: | Line 27: | ||
[[EMK:Output Specs | Output Specification]] | [[EMK:Output Specs | Output Specification]] | ||
| + | |||
| + | |||
| + | ==The Resources File== | ||
| + | EMarket uses a text file to record the configuration of all available Resources in a Working Directory. | ||
| + | |||
| + | The file is called '''Resourcesnnnn.txt''' (where '''nnnn''' is the resource file version number), and it is stored in the '''Saved''' folder of the current Working Directory. | ||
| + | |||
| + | A version of the Resources file is created when each of the following events takes place: | ||
| + | *EMarket is opened | ||
| + | *EMarket is closed | ||
| + | *A Run is executed | ||
| + | *The '''Save Data''' function is used | ||
| + | |||
| + | The Resources file, along with the Forecast input data, captures all the information required for EMarket to produce Forecasts. Resources files can be copied, archived and retrieved from archive. Retrieved files will faithfully reproduce all Resource Instances in the Working Directory at the time of archiving. | ||
| + | |||
| + | Note: Another, smaller file, called the Run Resource file is created every time a Run is executed. This file is stored under the individual Run results folder under the Results directory and contains details about the Run execution. This file ensures that Forecast data can always be tracked back to the modelling environment under which it was created. | ||
| + | |||
| + | ==Managing Resources== | ||
| + | EMarket provides the following features to assist in managing Resources: | ||
| + | *'''Creating, Copying and Deleting Resources''' | ||
| + | *'''Exporting/Importing Resources''' | ||
| + | *'''Resources Report''' | ||
| + | *'''Presets''' | ||
| + | |||
| + | ===Creating, Copying and Deleting Resources=== | ||
| + | In order to create, copy or delete a Resource Instance the appropriate Resource type must be displayed in the Central Resources Panel. This is achieved by clicking on the correct Resource tab on the left of the '''''[[EMK:Main Window | Main Window]]'''''. | ||
| + | |||
| + | {|class="wikitable" | ||
| + | |- | ||
| + | | ''Creating a new (blank) Resource Instance || ''<insert>'' or right click then ''New'' | ||
| + | |- | ||
| + | | ''Deleting an existing Resource Instance || ''<Delete>'' or right click then ''Delete'', then select ''Yes'' or press ''<y>'' | ||
| + | |- | ||
| + | | ''Copying an existing resource Instance'' || ''<Ctrl c>'' or right click then ''copy'' | ||
| + | |- | ||
| + | | ''Editing an existing Resource Instance'' || Double click or right click then ''Edit'' | ||
| + | |} | ||
| + | |||
| + | ===Exporting/Importing Resources=== | ||
| + | '''Exporting Resources''' | ||
| + | |||
| + | The Export Resources feature allows you to save Resource Instances for subsequent re-use or distribution to other users. The feature is only available for the Resource type currently displayed in the '''''[[EMK:Main_Window#Central_Resource_Panel | Central Resource Panel]]'''''. Resource Instances can be exported either to a text file or to the Windows clipboard. | ||
| + | |||
| + | To export a Resource Instance: | ||
| + | #Select ''Export Resources'' from the drop down '''''Resources Menu''''' in the '''''[[EMK:Main Window|Main Window]]''''' | ||
| + | #Select whether you want to export ''To File'' or ''To Clipboard'' | ||
| + | #Check the boxes beside which Resource Instances you want to export | ||
| + | #If exporting ''To Clipboard'', clicking OK will copy the Resource Instance(s) to the clipboard. If exporting ''To File'', press OK and then specify where you want to save the exported file(s) | ||
| + | |||
| + | '''Importing Resources''' | ||
| + | |||
| + | This feature complements the Export Resources function and is used to restore Resources Instances from a text file or the Windows Clipboard. | ||
| + | |||
| + | To import a Resource Instance: | ||
| + | #Select ''Import Resources'' from the drop down '''''Resources Menu''''' in the Main Window | ||
| + | #Select whether you want to import ''From File'', ''From Clipboard'' or ''From Multiple Reports on Clipboard'' | ||
| + | #If importing ''From Clipboard'' ensure that the clipboard contains at least one valid Resource description, then press ''Yes'' | ||
| + | #If importing ''From File'' select the file containing the Resource Instance(s) and double click on it or press ''Open'' | ||
| + | #''From Multiple Reports on Clipboard'' allows you to import multiple Resources of different types at the same time | ||
| + | #Press the OK button | ||
| + | |||
| + | Note: The message "No Resources Imported" is displayed if no valid Resource Instances can be found in the file or clipboard. | ||
| + | |||
| + | ===Resources Report=== | ||
| + | [[File:Resource Report.jpg|300px|thumb|right|Example of a Run Resource Report]] | ||
| + | The Resources Report contains a summarised view of all Resource Instances of a particular type. | ||
| + | |||
| + | It is accessed through the drop down '''''Resources Menu''''' on the Main Window by clicking on the ''<Resource Type> Resource Report''. For example if the Run Resource is currently displayed in the Central Resource Panel then clicking on ''Run Resource Report'' will open the Run Resource Report. | ||
| + | |||
| + | The Resources Report appears in a separate window. Its exact format depends upon the Resource type being Reported. The general format has the following features: | ||
| + | *One row for each Instance of the Resource type in the Working Directory | ||
| + | *One column for each individual Entity.Trait associated with the Resource type | ||
| + | |||
| + | '''Additional Features''' | ||
| + | |||
| + | The following features are accessible through the drop down '''Commands''' menu at the top of the window. | ||
| + | {|class="wikitable" | ||
| + | |- | ||
| + | | ''Copy All'' || Copies all the information to the Windows clipboard for pasting into Microsoft Word or Excel | ||
| + | |- | ||
| + | | ''Edit'' || Opens a Resource Editor loaded with the details of the currently selected Resource Instance. (The 'current' Instance is selected by clicking on the Resource Report row containing the Instance details). | ||
| + | |- | ||
| + | | ''Import Info'' || Imports data from the clipboard that has been configured to exactly match the format of the data produced by the 'Copy All' feature. | ||
| + | |||
| + | '''Warning:''' This feature is provided to allow expert users to edit Resource Instances independently of EMarket's user interface. The imported data is NOT validated and use of this feature is recommended for experts only. | ||
| + | |} | ||
| + | |||
| + | ===Presets=== | ||
| + | Specific Resource Instances are placed outside of your ability to configure them. This is done because the resource is: | ||
| + | *Too complex for configuration through a user interface; or | ||
| + | *Highly specialised to a particular market, i.e. has specific rules of operation which, if altered, could have unfavourable effects on EMarket's ability to produce useful Forecasts. | ||
| + | |||
| + | Currently EMarket for the New Zealand market comes with Resource Presets for each of the main Hydro systems: Waikato, Waitaki, Clutha and Manapouri. | ||
| + | |||
| + | Preset Hydro Systems can be added to the list of available Generators by selecting ''Add Preset'' from the drop down '''''Resources Menu''''' in the Main Window. | ||
| + | |||
| + | Some parameters of Presets are accessible to user modification. Therefore, to allow for modelling of different scenarios involving Preset Resource Instances, it is possible to copy a Preset to create another version of the System. | ||
| + | |||
| + | |||
| + | [[EMK:EMarket User Manual | Back to User Manual Main Page]] | ||
Latest revision as of 09:05, 8 February 2013
The Resource is a core concept in EMarket. It is a specific Instance of an EMarket modelling or data formatting element. By creating multiple Instances of the same Resource type (e.g. Generator), alternative scenarios can be rapidly created and analysed.
The list below shows the names of the Resources used in EMarket. Clicking on a name will take you to the relevant page for more information on the Resource.
The Resources File
EMarket uses a text file to record the configuration of all available Resources in a Working Directory.
The file is called Resourcesnnnn.txt (where nnnn is the resource file version number), and it is stored in the Saved folder of the current Working Directory.
A version of the Resources file is created when each of the following events takes place:
- EMarket is opened
- EMarket is closed
- A Run is executed
- The Save Data function is used
The Resources file, along with the Forecast input data, captures all the information required for EMarket to produce Forecasts. Resources files can be copied, archived and retrieved from archive. Retrieved files will faithfully reproduce all Resource Instances in the Working Directory at the time of archiving.
Note: Another, smaller file, called the Run Resource file is created every time a Run is executed. This file is stored under the individual Run results folder under the Results directory and contains details about the Run execution. This file ensures that Forecast data can always be tracked back to the modelling environment under which it was created.
Managing Resources
EMarket provides the following features to assist in managing Resources:
- Creating, Copying and Deleting Resources
- Exporting/Importing Resources
- Resources Report
- Presets
Creating, Copying and Deleting Resources
In order to create, copy or delete a Resource Instance the appropriate Resource type must be displayed in the Central Resources Panel. This is achieved by clicking on the correct Resource tab on the left of the Main Window.
| Creating a new (blank) Resource Instance | <insert> or right click then New |
| Deleting an existing Resource Instance | <Delete> or right click then Delete, then select Yes or press <y> |
| Copying an existing resource Instance | <Ctrl c> or right click then copy |
| Editing an existing Resource Instance | Double click or right click then Edit |
Exporting/Importing Resources
Exporting Resources
The Export Resources feature allows you to save Resource Instances for subsequent re-use or distribution to other users. The feature is only available for the Resource type currently displayed in the Central Resource Panel. Resource Instances can be exported either to a text file or to the Windows clipboard.
To export a Resource Instance:
- Select Export Resources from the drop down Resources Menu in the Main Window
- Select whether you want to export To File or To Clipboard
- Check the boxes beside which Resource Instances you want to export
- If exporting To Clipboard, clicking OK will copy the Resource Instance(s) to the clipboard. If exporting To File, press OK and then specify where you want to save the exported file(s)
Importing Resources
This feature complements the Export Resources function and is used to restore Resources Instances from a text file or the Windows Clipboard.
To import a Resource Instance:
- Select Import Resources from the drop down Resources Menu in the Main Window
- Select whether you want to import From File, From Clipboard or From Multiple Reports on Clipboard
- If importing From Clipboard ensure that the clipboard contains at least one valid Resource description, then press Yes
- If importing From File select the file containing the Resource Instance(s) and double click on it or press Open
- From Multiple Reports on Clipboard allows you to import multiple Resources of different types at the same time
- Press the OK button
Note: The message "No Resources Imported" is displayed if no valid Resource Instances can be found in the file or clipboard.
Resources Report
The Resources Report contains a summarised view of all Resource Instances of a particular type.
It is accessed through the drop down Resources Menu on the Main Window by clicking on the <Resource Type> Resource Report. For example if the Run Resource is currently displayed in the Central Resource Panel then clicking on Run Resource Report will open the Run Resource Report.
The Resources Report appears in a separate window. Its exact format depends upon the Resource type being Reported. The general format has the following features:
- One row for each Instance of the Resource type in the Working Directory
- One column for each individual Entity.Trait associated with the Resource type
Additional Features
The following features are accessible through the drop down Commands menu at the top of the window.
| Copy All | Copies all the information to the Windows clipboard for pasting into Microsoft Word or Excel |
| Edit | Opens a Resource Editor loaded with the details of the currently selected Resource Instance. (The 'current' Instance is selected by clicking on the Resource Report row containing the Instance details). |
| Import Info | Imports data from the clipboard that has been configured to exactly match the format of the data produced by the 'Copy All' feature.
Warning: This feature is provided to allow expert users to edit Resource Instances independently of EMarket's user interface. The imported data is NOT validated and use of this feature is recommended for experts only. |
Presets
Specific Resource Instances are placed outside of your ability to configure them. This is done because the resource is:
- Too complex for configuration through a user interface; or
- Highly specialised to a particular market, i.e. has specific rules of operation which, if altered, could have unfavourable effects on EMarket's ability to produce useful Forecasts.
Currently EMarket for the New Zealand market comes with Resource Presets for each of the main Hydro systems: Waikato, Waitaki, Clutha and Manapouri.
Preset Hydro Systems can be added to the list of available Generators by selecting Add Preset from the drop down Resources Menu in the Main Window.
Some parameters of Presets are accessible to user modification. Therefore, to allow for modelling of different scenarios involving Preset Resource Instances, it is possible to copy a Preset to create another version of the System.