Difference between revisions of "EMK:Main Window"

From EMK Wiki
Jump to navigation Jump to search
 
(13 intermediate revisions by one other user not shown)
Line 4: Line 4:
 
*A series of Resource tabs on the left of the screen - these are used to select which type of Resource instances appear in the central Resource Panel.
 
*A series of Resource tabs on the left of the screen - these are used to select which type of Resource instances appear in the central Resource Panel.
 
*A central Resource Panel
 
*A central Resource Panel
*The Results Panel on the right. For more information see [[EMK:Results | Results]].
+
*The Results Panel on the right. For more information see '''''[[EMK:Results | Results]]'''''.
 
*Menu Bar - tabs at the top of the window to access various menus.
 
*Menu Bar - tabs at the top of the window to access various menus.
  
Line 20: Line 20:
 
   
 
   
  
'''Resource Panel'''
+
===Central Resource Panel===
 
 
The Resources Panel displays all instances of the selected Resource type that are defined in the current Working Directory. Clicking on a listed Instance highlights it, while double-clicking opens the associated Resource Window. The name of the Resource and its description is separated by the "" symbol.
 
  
 +
The Resources Panel displays all instances of the selected [[EMK:Resources | Resource]] type that are defined in the current Working Directory. Clicking on a listed Instance highlights it, while double-clicking opens the associated Resource Window. The name of the Resource and its description is separated by the "" symbol.
  
 
==Menu Bar==
 
==Menu Bar==
 
All EMarket functions can be accessed through drop down lists from the Menu bar of the Main Window. These lists are opened by clicking on the corresponding tab.
 
All EMarket functions can be accessed through drop down lists from the Menu bar of the Main Window. These lists are opened by clicking on the corresponding tab.
  
'''File Menu Fields'''
+
===File Menu Fields===
 
{|class="wikitable"
 
{|class="wikitable"
 
|-
 
|-
| '''Option''' || '''Sub-Option''' || '''Short Cut Key''' || '''Purpose'''
+
| '''Option''' || '''Purpose'''
 +
|-
 +
| ''Save Data'' || Saves a new version of the Resources file (''<Ctrl s>'')
 +
|-
 +
| ''Show Log'' || Opens the EMarket System Log Window (''<Ctrl l>'')
 +
|-
 +
| ''Working Directory'' || *''Find Working Directory:'' Opens a file system browser to allow selection of a Working Directory.
 +
*''Open Current Working Directory:'' Opens the current Working Directory folder in a Windows Explorer window.
 +
*''Reload Working Directory:'' Reloads the contents of a Working Directory into EMarket while it is running (this allows manual changes made to underlying data to be uploaded)
 +
*''Working Directory Selection List:'' Lists the most recent Working Directory locations and indicates the current selection with a Tick mark. Clicking on a non-checked list item switches it to the current Working Directory, EMarket then displays a "Changing Working Directory" message while it loads the input data from the new directory.
 +
|-
 +
| ''Demand Editor'' || This option opens the window which allows you to enter formulae to calculate regional Demands, for whichever Run is currently selected.
 +
|-
 +
| ''Set Process Priority'' ||  Sets the proportion of available processing time EMarket will request Windows to allocate to a Run. Available settings are:
 +
*Real Time (all available processing resource)
 +
*High
 +
*Above Normal
 +
*Normal
 +
*Below Normal
 +
*Low (makes EMarket run in the background so other applications can still be used).
 +
|-
 +
| ''Quit'' || Exits EMarket (''<Ctrl q>'')
 +
|}
 +
 
 +
 
 +
===Batch Menu Fields===
 +
{|class="wikitable"
 +
|-
 +
| ''Add run to Batch'' || Automatically opens the '''''[[EMK:Executing_a_Run#Batch_Window | Batch Window]]''''' and adds the Run Definition for the highlighted Run to the current Batch. (A new Batch is created if no current Batch exists). (''<Ctrl a>'')
 +
|-
 +
| ''Batch Queue'' || Opens the Batch Window (''<Ctrl b>'')
 +
|}
 +
 
 +
===Resources Menu Fields===
 +
{|class="wikitable"
 +
|-
 +
| ''New'' || Creates a new (empty) version of the Resource type selected in the Central Resource Panel and opens the relevant Resource Window
 +
|-
 +
| ''Copy'' || Copies the details of the particular Resource Instance currently highlighted in the Central Resource Panel to a new Resource Instance.
 +
|-
 +
| ''Edit'' || Allows you to edit the details of the Resource Instance currently highlighted in the Central Resource Panel
 +
|-
 +
| ''Delete'' || Deletes the entire Resource Instance currently highlighted in the Central Resource Panel
 +
|-
 +
| ''System Definitions'' || Opens the '''''System Definitions Window.'''''  (System Definitions are a means of defining substitute data values for multiple Runs)
 +
|-
 +
| ''Add Preset'' || Creates a predefined Hydro System Generator and saves it in the Generator list
 +
|-
 +
| ''<Resource>'' Resources Report || Opens a '''''Resources Report Window''''' for the Current Resource Type
 +
|-
 +
| ''Other Resources Report'' || Opens a '''''Resources Report Window''''' for the Resource selected from the drop down list
 +
|-
 +
| ''Export Resources'' || Allows Resource Definitions to be copied to the Windows clipboard
 +
|-
 +
| ''Import Resources'' || Allows Resource definitions to be imported from the Windows clipboard
 +
|-
 +
| ''Delete Resources'' || Opens a new Window with a list of Resource Instances for the selected Resource. By ticking the box beside a Resource Instance you can select it to be deleted. Pressing OK opens another popup saying delete selected <Resources>? Clicking OK on this deletes the ticked Resource Instances.
 +
|}
 +
The next 12 fields of the Resources menu are the same as the '''''Resource Tabs''''' on the left of the [[EMK:Main Window | Main Window]] Clicking each one opens the corresponding Resource Instances in the Central Resource Window.
 +
 
 +
===Results Menu Fields===
 +
{|class="wikitable"
 +
|-
 +
| ''View'' || Causes the relevant Output viewer to be launched in a new Window. This option is available when an individual [[EMK:Binary Output | Binary Output]] is selected in the Results Panel.
 +
|-
 +
| ''Report - Raw Data'' || Creates a csv file from the binary database for the highlighted Entity.Trait. The csv file can then be accessed through the '''Results Panel'''. This option is available when an individual [[EMK:Binary Output | Binary Output]] is selected in the Results Panel.
 +
|-
 +
| ''Report - Output Spec'' || Creates a csv file from the Output Specification selected from the popup list.  The csv file can then be accessed through the '''Results Panel'''. This option is available when an individual Run is selected in the Results Panel.
 
|-
 
|-
| ''Save Data'' || || Ctrl + S || Saves a new version of the Resources file
+
| ''Report Batch'' || Provides a list of all Report Resources - clicking one causes the Report Batch to be executed against the Run selected in the Results Panel. This option is available when an individual Run is selected in the Results Panel.
 
|-
 
|-
| ''Show Log'' || || Ctrl + L || Opens the EMarket System Log Window
+
| ''Delete'' || Deletes the currently selected file in the Results Panel.
 
|-
 
|-
| ''Working Directory'' || ''Find Working Directory'' ||  || Opens a file system browser to allow selection of a Working Directory.
+
| ''Open Directory'' || Opens the directory in Windows Explorer where the most recently selected Results set is saved.
 
|-
 
|-
| || Open Current Working Directory || Opens the current Working Directory folder in a Windows Explorer window.
+
| ''Archive Results'' || Saves the results of a Run in a user specified archive folder.
 
|}
 
|}
  
  
 +
===Windows Menu===
 +
The Windows Menu option lists all currently open EMarket windows (except the Main Window). Clicking on an item in the list makes it the current window and brings it to the front on-screen.
  
  
 +
[[EMK:CreatingForecasts | Creating EMarket Forecasts]]
  
 
[[EMK:EMarket User Manual | Back to User Manual Main Page]]
 
[[EMK:EMarket User Manual | Back to User Manual Main Page]]

Latest revision as of 14:21, 7 March 2013

Example Main Window

The Main Window opens upon launching EMarket and provides access to all EMarket functionality. It is made up of:

  • A series of Resource tabs on the left of the screen - these are used to select which type of Resource instances appear in the central Resource Panel.
  • A central Resource Panel
  • The Results Panel on the right. For more information see Results.
  • Menu Bar - tabs at the top of the window to access various menus.

The Resource and Result Panels can be re-sized by clicking on the central bar between them and dragging it sideways.

Features

  • The Title bar at the head of the window displays the location of the current Working Directory.
  • The Status Bar at the foot of the screen has four compartments. These are (from left to right):
    • Time: displays current time.
    • System Status: temporarily displays the latest recorded system event. Click this field to open the System Log Window for further details.
    • Batch Status: displays the number of Run Batches queued for execution. Click this field to open the Batch Window for further details.
    • Disk Status: displays the total free space and total used space in the Working directory in Megabytes, useful to monitor when forecasts are producing large data sets.
  • Right clicking anywhere in the central Resource Panel causes the drop-down Resource menu to appear. The functions of this list reproduce those available from the Resources Menu option.


Central Resource Panel

The Resources Panel displays all instances of the selected Resource type that are defined in the current Working Directory. Clicking on a listed Instance highlights it, while double-clicking opens the associated Resource Window. The name of the Resource and its description is separated by the "" symbol.

Menu Bar

All EMarket functions can be accessed through drop down lists from the Menu bar of the Main Window. These lists are opened by clicking on the corresponding tab.

File Menu Fields

Option Purpose
Save Data Saves a new version of the Resources file (<Ctrl s>)
Show Log Opens the EMarket System Log Window (<Ctrl l>)
Working Directory *Find Working Directory: Opens a file system browser to allow selection of a Working Directory.
  • Open Current Working Directory: Opens the current Working Directory folder in a Windows Explorer window.
  • Reload Working Directory: Reloads the contents of a Working Directory into EMarket while it is running (this allows manual changes made to underlying data to be uploaded)
  • Working Directory Selection List: Lists the most recent Working Directory locations and indicates the current selection with a Tick mark. Clicking on a non-checked list item switches it to the current Working Directory, EMarket then displays a "Changing Working Directory" message while it loads the input data from the new directory.
Demand Editor This option opens the window which allows you to enter formulae to calculate regional Demands, for whichever Run is currently selected.
Set Process Priority Sets the proportion of available processing time EMarket will request Windows to allocate to a Run. Available settings are:
  • Real Time (all available processing resource)
  • High
  • Above Normal
  • Normal
  • Below Normal
  • Low (makes EMarket run in the background so other applications can still be used).
Quit Exits EMarket (<Ctrl q>)


Batch Menu Fields

Add run to Batch Automatically opens the Batch Window and adds the Run Definition for the highlighted Run to the current Batch. (A new Batch is created if no current Batch exists). (<Ctrl a>)
Batch Queue Opens the Batch Window (<Ctrl b>)

Resources Menu Fields

New Creates a new (empty) version of the Resource type selected in the Central Resource Panel and opens the relevant Resource Window
Copy Copies the details of the particular Resource Instance currently highlighted in the Central Resource Panel to a new Resource Instance.
Edit Allows you to edit the details of the Resource Instance currently highlighted in the Central Resource Panel
Delete Deletes the entire Resource Instance currently highlighted in the Central Resource Panel
System Definitions Opens the System Definitions Window. (System Definitions are a means of defining substitute data values for multiple Runs)
Add Preset Creates a predefined Hydro System Generator and saves it in the Generator list
<Resource> Resources Report Opens a Resources Report Window for the Current Resource Type
Other Resources Report Opens a Resources Report Window for the Resource selected from the drop down list
Export Resources Allows Resource Definitions to be copied to the Windows clipboard
Import Resources Allows Resource definitions to be imported from the Windows clipboard
Delete Resources Opens a new Window with a list of Resource Instances for the selected Resource. By ticking the box beside a Resource Instance you can select it to be deleted. Pressing OK opens another popup saying delete selected <Resources>? Clicking OK on this deletes the ticked Resource Instances.

The next 12 fields of the Resources menu are the same as the Resource Tabs on the left of the Main Window Clicking each one opens the corresponding Resource Instances in the Central Resource Window.

Results Menu Fields

View Causes the relevant Output viewer to be launched in a new Window. This option is available when an individual Binary Output is selected in the Results Panel.
Report - Raw Data Creates a csv file from the binary database for the highlighted Entity.Trait. The csv file can then be accessed through the Results Panel. This option is available when an individual Binary Output is selected in the Results Panel.
Report - Output Spec Creates a csv file from the Output Specification selected from the popup list. The csv file can then be accessed through the Results Panel. This option is available when an individual Run is selected in the Results Panel.
Report Batch Provides a list of all Report Resources - clicking one causes the Report Batch to be executed against the Run selected in the Results Panel. This option is available when an individual Run is selected in the Results Panel.
Delete Deletes the currently selected file in the Results Panel.
Open Directory Opens the directory in Windows Explorer where the most recently selected Results set is saved.
Archive Results Saves the results of a Run in a user specified archive folder.


Windows Menu

The Windows Menu option lists all currently open EMarket windows (except the Main Window). Clicking on an item in the list makes it the current window and brings it to the front on-screen.


Creating EMarket Forecasts

Back to User Manual Main Page