Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Using VIBE with ICE"

(→‎Creating a VIBE Model)
(→‎Using ICE to run VIBE (Virtual Integrated Battery Environment) simulations)
Line 13: Line 13:
  
 
[[File:Vibe_model.png]]
 
[[File:Vibe_model.png]]
 +
 +
To start, the user should select the ''VIBE Model'' item and click ''Finish''. This will open the "VIBE Model" form.
 +
  
 
==== Creating a VIBE Model ====
 
==== Creating a VIBE Model ====
  
−
To start, the user should select the ''VIBE Model'' item and click ''Finish''. This will open the "VIBE Model" form, pictured below.
+
In this initial example, the "VIBE Model" form (pictured below) will be populated with the information for the default "VIBE Model" case, which is suitable for this tutorial.
 +
 
 +
Advanced users can customize the variables in this form to suit their use case.
  
 
[[File:Vibe_Model_1.png]]
 
[[File:Vibe_Model_1.png]]
  
−
In this initial example, the form will be populated with the information for the default "VIBE Model" case, which is suitable for this tutorial.
+
The "VIBE Model" form should be exported to a VIBE readable file using the combo box in the upper right hand corner.
  
−
{{note|Advanced users can customize the variables in this form to suit their use case.}}
+
Select ''Export to VIBE INI Format'' from the dropdown menu and click ''GO!'' to write the input file.
−
 
+
−
The "VIBE Model" form can be exported to a VIBE readable file using the combo box in the upper right hand corner.
+
  
 
[[File:ICE_VIBE_process_select_stc.png]]
 
[[File:ICE_VIBE_process_select_stc.png]]
  
−
Click ''GO!'' and ICE will write the input file.
 
  
−
==== Running a VIBE Simulation ====
+
==== Creating a VIBE Launcher ====
  
−
===== VIBE Launcher =====
+
The next step is to add the "VIBE Launcher" item to the workflow.
−
To run the simulation specified in the file that was just written out create a new item the same way that the ‘VIBE Model’ item was created, but choose the ‘VIBE Launcher’ item from the list now. Again, the form will be populated with some default information about how to launch a VIBE simulation. To use the input file, simply choose it from the drop down menu labeled ‘Input File’. The file will be named the same thing as the VIBE Model Item that was just used on the left side, in the Item list.
+
 
 +
Just as before, click the ''Create an Item'' button (stylized as a '+') in the "Item Viewer" view pane/tab.
 +
 
 +
[[File:Create_an_item.png]]
 +
 
 +
This will present the user with a dialog that lists available ICE plugins (including three VIBE-related items), as show below.
 +
 
 +
This time select ''VIBE Launcher'' from the list and click ''Finish''. This will open the "VIBE Launcher" form.
 +
 
 +
[[File:ICE_VIBE_launcher_stc.png]]
 +
 
 +
The "VIBE Launcher" form (pictured below) will be populated with the information for the default "VIBE Launcher" case, which is suitable for this tutorial.
  
 
[[File:Vibe_Launcher_conf.png]]
 
[[File:Vibe_Launcher_conf.png]]
  
−
'''Fig 4.''' Choose the input file from the Input File dropdown menu. All VIBE input files generated in ICE have the .conf extension
+
The "VIBE Model" form's output should have resulted in a <tt>*.conf</tt> input file that should be saved in the default ICE development directory—the input file is called <tt>VIBE_Model_1.conf</tt> in this case.
 +
 
 +
To locate the input file, the user can select ''Browse...'' if the file is not automatically populated in the "Input File" combo box, as pictured above.
 +
 
 +
 
 +
==== Run the Simulation ====
 +
To run the simulation save the item (''File'' > ''Save'') and then click ''Go!''
  
−
===== Run the Simulation =====
+
[[File:ICE_VIBE_launcher_GO_stc.png]]
−
To run the simulation save the item and then click ‘Go!’ in the upper right hand corner.  A console will pop up displaying the standard output from the simulation.
+
  
 
The VIBE Model item can be created inside of the existing project. Simply right click on that project in your Project Explorer window and choose New -> Other -> Create Item Wizard, then hit the 'Next' button and select 'VIBE Model' from the list of all of the available plugins.  
 
The VIBE Model item can be created inside of the existing project. Simply right click on that project in your Project Explorer window and choose New -> Other -> Create Item Wizard, then hit the 'Next' button and select 'VIBE Model' from the list of all of the available plugins.  

Revision as of 10:38, 28 November 2016

Using ICE to run VIBE (Virtual Integrated Battery Environment) simulations

ICE provides three items that can be used to configure and run VIBE simulations:

  • VIBE Key-Value Pair – Allows the user to specify variable values in a simulation. This item is optional.
  • VIBE Launcher – Runs the specified simulation.
  • VIBE Model – Allows the user to configure the simulation setup parameters.

To select one of these items from the list of available plugins in ICE, click the Create an Item button (stylized as a '+') in the "Item Viewer" view pane/tab.

Create an item.png

This will present the user with a dialog that lists available ICE plugins (including three VIBE-related items), as show below.

Vibe model.png

To start, the user should select the VIBE Model item and click Finish. This will open the "VIBE Model" form.


Creating a VIBE Model

In this initial example, the "VIBE Model" form (pictured below) will be populated with the information for the default "VIBE Model" case, which is suitable for this tutorial.

Advanced users can customize the variables in this form to suit their use case.

Vibe Model 1.png

The "VIBE Model" form should be exported to a VIBE readable file using the combo box in the upper right hand corner.

Select Export to VIBE INI Format from the dropdown menu and click GO! to write the input file.

ICE VIBE process select stc.png


Creating a VIBE Launcher

The next step is to add the "VIBE Launcher" item to the workflow.

Just as before, click the Create an Item button (stylized as a '+') in the "Item Viewer" view pane/tab.

Create an item.png

This will present the user with a dialog that lists available ICE plugins (including three VIBE-related items), as show below.

This time select VIBE Launcher from the list and click Finish. This will open the "VIBE Launcher" form.

ICE VIBE launcher stc.png

The "VIBE Launcher" form (pictured below) will be populated with the information for the default "VIBE Launcher" case, which is suitable for this tutorial.

Vibe Launcher conf.png

The "VIBE Model" form's output should have resulted in a *.conf input file that should be saved in the default ICE development directory—the input file is called VIBE_Model_1.conf in this case.

To locate the input file, the user can select Browse... if the file is not automatically populated in the "Input File" combo box, as pictured above.


Run the Simulation

To run the simulation save the item (File > Save) and then click Go!

ICE VIBE launcher GO stc.png

The VIBE Model item can be created inside of the existing project. Simply right click on that project in your Project Explorer window and choose New -> Other -> Create Item Wizard, then hit the 'Next' button and select 'VIBE Model' from the list of all of the available plugins.

New other.png

Fig 5. Right-click on the existing project to add an item

Create item wiz.png

Fig 6. Choose 'Create Item Wizard'

Vibe model added.png

Fig 7.The VIBE Model item is now added to your project

Similarly,the other VIBE items can be added in order to run the simulation.

Retrieved from "https://wiki.eclipse.org/index.php?title=Using_VIBE_with_ICE&oldid=412241"

Back to the top