ifference between revisions of "EMO:Data Storage Directory Structure"

From EMO Wiki
Jump to navigation Jump to search
 
(59 intermediate revisions by 2 users not shown)
Line 5: Line 5:
  
  
−
== Program Files ==
+
=== Program Files ===
−
During the installation process you can choose where ''EMarketOffer'' places its program files (default C:\Program Files\Ellsoft\EMO).  This folder contains the ''EMarketOffer'' executable and the dlls (dynamic link libraries) required by the program.   
+
During the installation process you can choose where ''EMarketOffer'' places its program files (default C:\Program Files\Energy Link\EMO).  This folder contains the ''EMarketOffer'' executable and the dlls (dynamic link libraries) required by the program.  On 64 bit Windows systems the default directory is "Program Files (x86)".
  
 +
'''Warning!''' You should not attempt to modify or move the location of any of these files after installation - doing so will cause the program to malfunction.
 +
 +
== Data Files ==
 +
 +
During installation ''EMarketOffer'' creates a data directory structure containing these folders:
 +
*Connection
 +
*Forecast
 +
*Inputs
 +
*Licence
 +
*Maps
 +
*Positions
 +
*Reports
 +
*Results
 +
*Settings
 +
 +
You can select the location for the data folders during the installation process. For performance reasons it is recommended that the data folder be located on the same computer as the ''EMarketOffer'' executable.
 +
 +
===The Connection Folder===
 +
The information required to connect ''EMarketOffer'' to external databases is stored here.
 +
 +
{|class="wikitable"
 +
! File !! Purpose !! Comment
 +
|-
 +
|
 +
:''<Configuration_Name>''.xml<br/>Where <Configuration_Name> is the name of a previously created '''''Database Connectivity Configuration'''''.
 +
|
 +
:Stores database connectivity data referred to during program launch
 +
|
 +
:Editing, deleting or moving this file may cause ''EMarketOffer'' to malfunction.
 +
|}
 +
 +
===The Forecast Folder===
 +
This folder stores the definitions of Forecasts and Powerflow Cases (.xml format).  The results (outputs) of Forecasts and Powerflows are stored in binary format in the Results folder.  Scenarios are stored in the Results folder in their entirety (definition and results in one .scn binary file per Scenario).
 +
 +
{|class="wikitable"
 +
! Sub-Folder !! File !! Purpose !! Comment
 +
|-
 +
! rowspan="2" | Forecasts
 +
|
 +
:''<My_Forecast>.ibn''
 +
|
 +
:Contains the output in binary form of the last run of the 'My_Forecast' Forecast Definition
 +
|
 +
:One .ibn file will exist for each currently available Forecast Definition that has been run.<br/>
 
----
 
----
−
'''Warning!''' You should not attempt to modify or move the location of any of these files after installation - doing so will cause the program to malfunction.
+
:NOTE: Deleting a Forecast Definition using the '''''[[EMO:Control_Panel_Components#The_Data_Source_Manager|Main Window Data Source Manager]]''''' will delete the associated .ibn file.
 +
|-
 +
|
 +
:''Forecasts.xml''
 +
|
 +
:Contains the latest Definitions for all current Forecasts.
 +
|
 +
:In editing or deleting this file you run the risk of losing all current Forecast Definitions and associated results data.
 +
|-
 +
! rowspan="2" | Powerflows
 +
|
 +
:''<My_Powerflow>.ibn''
 +
|
 +
:Contains the output in binary form of the last run of the 'My_Powerflow' Powerflow Case Definition
 +
|
 +
:One .ibn file will exist for each currently available Powerflow Case Definition that has been run.<br/>
 
----
 
----
 +
:NOTE: Deleting a Powerflow Case Definition using the '''''[[EMO:Control_Panel_Components#The_Data_Source_Manager|Main Window Data Source Manager]]''''' will delete the associated .ibn file.
 +
|-
 +
|
 +
:''Powerflows.xml''
 +
|
 +
:Contains the latest Definitions for all current Powerflow Cases.
 +
|
 +
:In editing or deleting this file you run the risk of losing all current Powerflow Case Definitions and associated results data.
 +
|-
 +
! Library
 +
|
 +
:''<My_Component>.xml''
 +
|
 +
:Contains the definition for a saved '''''Powerflow Case''''' or '''''Forecast Component'''''.
 +
|
 +
|}
 +
 +
===The Inputs Folder===
 +
The Inputs folder may contain several folders and sub-folders as shown below:
 +
*Demand
 +
*Grid
 +
**Grid\Ellsoft
 +
**Grid\EM6
 +
***Grid\EM6\BaseGrid
 +
***Grid\EM6\Constraints
 +
***Grid\EM6\Equations
 +
***Grid\EM6\Reratings
 +
**Grid\EMO
 +
*Offers
 +
*Reserves
 +
 +
The Grid\EMO and Reserves folders contain the data which is updated on Energy Link's web site each day, and is the grid and reserves data that we continue to support (includes all grid data from 22-Jul-09 and reserves from January 2010).  If present, the Grid\Ellsoft and Grid\EM6 folders contain grid data that we no longer support.
 +
 +
== Offers ==
 +
''EMarketOffer'' can load Offers from a database or from file.  Offers files in the standard CSV format as provided on http://www.electricityinfo.co.nz can be placed in the Offers folder, which can also be used as a library for user-defined/amended Offers data.
 +
 +
NOTE: This folder is created during installation for convenience; however ''EMarketOffer'' can read properly formatted files from any location.
 +
 +
== Grid ==
 +
''EMarketOffer'' uses accurate Transmission System data for analysis of historical periods and as input into '''''Forecast Definitions''''' and '''''Powerflow Cases'''''.
 +
 +
The '''''[[EMO:Input Data|Input Data]]''''' section contains details on each file type.
 +
 +
==The Licence Folder==
 +
Your customised license file is stored in the License folder.
 +
 +
'''Warning!''' This file contains important information about your installation.  It is encrypted and you should not attempt to edit this file in any way.  The program will fail to startup if the licence file is missing or altered.
 +
 +
==The Maps Folder==
 +
Data required to support the Mapping function is stored here.
 +
{|class="wikitable"
 +
! Folder !! Purpose
 +
|-
 +
|
 +
:''NZ''
 +
|
 +
:Specifies a collection of maps (typically NZ) and contains the configuration data files (.config) for the full set of maps. Maps from only one collection can be displayed at a time.
 +
|-
 +
|
 +
:''Large Maps''
 +
|
 +
:Contains low level detail Map graphics in .emf format
 +
|-
 +
|
 +
:''Medium Maps''
 +
|
 +
:Contains medium level detail Map graphics in .emf format
 +
|-
 +
|
 +
:''Small''
 +
|
 +
:Contains high level detail Map graphics in .emf format
 +
|}
 +
 +
==The Positions Folder==
 +
Map position details for Transmission System elements are stored here.
 +
 +
{|class="wikitable"
 +
! File !! Purpose !! Comment
 +
|-
 +
|
 +
:''NodePositions.csv''
 +
|
 +
:Contains Map positions of Market Nodes.
 +
|
 +
:Updated automatically as Nodes are added and re-positioned through the '''''[[EMO:The Presentation Interface|Presentation Interface]]''''' - should not be edited manually.
 +
|-
 +
|
 +
:''SubstationPositions.csv''
 +
|
 +
:Contains Map positions of Substations
 +
|
 +
|}
 +
 +
==The Reports Folder==
 +
This is the default folder for storing '''''Report Output''''' files, which are typically in .csv format and named according to their data content and date range.
  
−
== Data Files ==
+
 
−
During installation ''EMarketOffer'' creates a data directory structure containing the following folders:
+
==The Results Folder==
−
[[File:Data Files.PNG|400px|thumb|right|Figure 1 - The Directory Structure]]
+
 
 +
The Results folder contains the output in binary form of Scenarios (.csn), Forecasts (.ibn) and Powerflows (.ibn).
 +
 
 +
 
 +
==The Settings Folder==
 +
User settings files are stored in here.
 +
 
 +
{|class="wikitable"
 +
! File !! Purpose
 +
|-
 +
|
 +
:''Companies.xml''
 +
|
 +
:Contains the latest '''''Company''''' definition details
 +
|-
 +
|
 +
:''EmbeddedGens.xml''
 +
|
 +
:Contains the latest list of '''''Embedded Generators''''', e.g. wind farms
 +
|-
 +
|
 +
:''ExcludedEquations.xml''
 +
|
 +
:Contains the latest list of '''''Equations Constraints''''' to be excluded when loading Transmission System data into a '''''Forecast Definition'''''
 +
|-
 +
|
 +
:''InsetState.csv''
 +
|
 +
:Contains the position of inset maps when EMO is closed down
 +
|-
 +
|
 +
:''Regions.xml''
 +
|
 +
:Contains the latest '''''Region''''' set definitions
 +
|-
 +
|
 +
:''Reports.xml''
 +
|
 +
:Contains information about batch reports
 +
|-
 +
|
 +
:''UIState.xml''
 +
|
 +
:Contains information about the state of EMO when it is closed down, e.g. Window state, selected view
 +
|-
 +
|
 +
:''UserSettings.xml''
 +
|
 +
:Contains information about settings such as database connections and user-defined views.
 +
|-
 +
|
 +
:''WatchLists.xml''
 +
|
 +
:Contains the latest '''''lists of Watched items'''''
 +
|}
 +
 
 +
 
 +
[[Main Page|Home]]

Latest revision as of 14:43, 17 March 2014

EMarketOffer creates two separate directory structures during installation:

  • Program files
  • Data files


Program Files

During the installation process you can choose where EMarketOffer places its program files (default C:\Program Files\Energy Link\EMO). This folder contains the EMarketOffer executable and the dlls (dynamic link libraries) required by the program. On 64 bit Windows systems the default directory is "Program Files (x86)".

Warning! You should not attempt to modify or move the location of any of these files after installation - doing so will cause the program to malfunction.

Data Files

During installation EMarketOffer creates a data directory structure containing these folders:

  • Connection
  • Forecast
  • Inputs
  • Licence
  • Maps
  • Positions
  • Reports
  • Results
  • Settings

You can select the location for the data folders during the installation process. For performance reasons it is recommended that the data folder be located on the same computer as the EMarketOffer executable.

The Connection Folder

The information required to connect EMarketOffer to external databases is stored here.

File Purpose Comment
<Configuration_Name>.xml
Where <Configuration_Name> is the name of a previously created Database Connectivity Configuration.
Stores database connectivity data referred to during program launch
Editing, deleting or moving this file may cause EMarketOffer to malfunction.

The Forecast Folder

This folder stores the definitions of Forecasts and Powerflow Cases (.xml format). The results (outputs) of Forecasts and Powerflows are stored in binary format in the Results folder. Scenarios are stored in the Results folder in their entirety (definition and results in one .scn binary file per Scenario).

Sub-Folder File Purpose Comment
Forecasts
<My_Forecast>.ibn
Contains the output in binary form of the last run of the 'My_Forecast' Forecast Definition
One .ibn file will exist for each currently available Forecast Definition that has been run.
NOTE: Deleting a Forecast Definition using the Main Window Data Source Manager will delete the associated .ibn file.
Forecasts.xml
Contains the latest Definitions for all current Forecasts.
In editing or deleting this file you run the risk of losing all current Forecast Definitions and associated results data.
Powerflows
<My_Powerflow>.ibn
Contains the output in binary form of the last run of the 'My_Powerflow' Powerflow Case Definition
One .ibn file will exist for each currently available Powerflow Case Definition that has been run.
NOTE: Deleting a Powerflow Case Definition using the Main Window Data Source Manager will delete the associated .ibn file.
Powerflows.xml
Contains the latest Definitions for all current Powerflow Cases.
In editing or deleting this file you run the risk of losing all current Powerflow Case Definitions and associated results data.
Library
<My_Component>.xml
Contains the definition for a saved Powerflow Case or Forecast Component.

The Inputs Folder

The Inputs folder may contain several folders and sub-folders as shown below:

  • Demand
  • Grid
    • Grid\Ellsoft
    • Grid\EM6
      • Grid\EM6\BaseGrid
      • Grid\EM6\Constraints
      • Grid\EM6\Equations
      • Grid\EM6\Reratings
    • Grid\EMO
  • Offers
  • Reserves

The Grid\EMO and Reserves folders contain the data which is updated on Energy Link's web site each day, and is the grid and reserves data that we continue to support (includes all grid data from 22-Jul-09 and reserves from January 2010). If present, the Grid\Ellsoft and Grid\EM6 folders contain grid data that we no longer support.

Offers

EMarketOffer can load Offers from a database or from file. Offers files in the standard CSV format as provided on http://www.electricityinfo.co.nz can be placed in the Offers folder, which can also be used as a library for user-defined/amended Offers data.

NOTE: This folder is created during installation for convenience; however EMarketOffer can read properly formatted files from any location.

Grid

EMarketOffer uses accurate Transmission System data for analysis of historical periods and as input into Forecast Definitions and Powerflow Cases.

The Input Data section contains details on each file type.

The Licence Folder

Your customised license file is stored in the License folder.

Warning! This file contains important information about your installation. It is encrypted and you should not attempt to edit this file in any way. The program will fail to startup if the licence file is missing or altered.

The Maps Folder

Data required to support the Mapping function is stored here.

Folder Purpose
NZ
Specifies a collection of maps (typically NZ) and contains the configuration data files (.config) for the full set of maps. Maps from only one collection can be displayed at a time.
Large Maps
Contains low level detail Map graphics in .emf format
Medium Maps
Contains medium level detail Map graphics in .emf format
Small
Contains high level detail Map graphics in .emf format

The Positions Folder

Map position details for Transmission System elements are stored here.

File Purpose Comment
NodePositions.csv
Contains Map positions of Market Nodes.
Updated automatically as Nodes are added and re-positioned through the Presentation Interface - should not be edited manually.
SubstationPositions.csv
Contains Map positions of Substations

The Reports Folder

This is the default folder for storing Report Output files, which are typically in .csv format and named according to their data content and date range.


The Results Folder

The Results folder contains the output in binary form of Scenarios (.csn), Forecasts (.ibn) and Powerflows (.ibn).


The Settings Folder

User settings files are stored in here.

File Purpose
Companies.xml
Contains the latest Company definition details
EmbeddedGens.xml
Contains the latest list of Embedded Generators, e.g. wind farms
ExcludedEquations.xml
Contains the latest list of Equations Constraints to be excluded when loading Transmission System data into a Forecast Definition
InsetState.csv
Contains the position of inset maps when EMO is closed down
Regions.xml
Contains the latest Region set definitions
Reports.xml
Contains information about batch reports
UIState.xml
Contains information about the state of EMO when it is closed down, e.g. Window state, selected view
UserSettings.xml
Contains information about settings such as database connections and user-defined views.
WatchLists.xml
Contains the latest lists of Watched items


Home

Retrieved from "http://emo.energylink.co.nz/index.php?title=EMO:Data_Storage_Directory_Structure&oldid=6207"