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"

 
(27 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
=== Using ICE to run VIBE (Virtual Integrated Battery Environment) simulations ===
+
== Introduction ==
  
−
ICE provides 3 items that can be used to configure and run VIBE simulations.  To view a list of all of the available plugins in ICE click the ‘Create an Item’ button on the left-hand viewport of the ICE interface.
+
ICE provides three items that can be used to configure and run Virtual Integrated Battery Environment (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.
  
−
[[File:Create_an_item.png]]
 
  
−
'''Fig 1.''' Use the ‘Create an item’ button to create a new VIBE related item.
+
== Creating a VIBE Model ==
  
−
There are three VIBE related items that are available for use:
+
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.
  
−
'''VIBE Key-Value Pair'''
+
[[File:Create_an_item.png]]
−
The VIBE Key-Value Pair Item allows you to specify variable values in a simulation. This item is optional.
+
−
 
+
−
'''VIBE Launcher'''
+
−
The Caebat Launcher Item runs the specified simulation. 
+
  
−
'''VIBE Model'''
+
This will present the user with a dialog that lists available ICE plugins (including three VIBE-related items), as shown below.
−
The VIBE Model Item allows you to configure the simulation setup parameters.
+
  
 
[[File:Vibe_model.png]]
 
[[File:Vibe_model.png]]
  
−
'''Fig 2.''' The Item Selector has 3 VIBE related items
+
To start, the user should select the ''VIBE Model'' item and click ''Finish''. This will open the "VIBE Model" form.
  
−
To begin a simple run, select the ‘VIBE Model’ item.  The form will be populated with the information for the default ‘VIBE Model’ case. As you become more familiar with all of the settings you can customize the default case to your taste.  When you are done exploring this form you can simply click the ‘Go!’ button next to ‘Export to VIBE INI Format’ to write out the input file.
+
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]]
  
−
'''Fig 3.''' The VIBE Model form can be exported to a VIBE readable file using the upper right controls.
+
Select ''Export to VIBE INI format'' from the combo box, and click ''Go!'' to write the input file.
  
−
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.
+
[[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.
 +
 
 +
[[File:ICE_create_item_stc_2.png]]
 +
 
 +
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 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.
+
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.
  
−
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.  
+
 
 +
== Running the Simulation ==
 +
To run the simulation, save the item (''File'' > ''Save'') and then click ''Go!''
 +
 
 +
[[File:ICE_VIBE_launcher_GO_stc.png]]
 +
 
 +
 
 +
== Adding VIBE to an Existing Project ==
 +
 
 +
VIBE items can also be created within an existing project.
 +
 
 +
In the "Project Explorer" view pane, right click on the project and choose ''New'' > ''Other''. This action will prompt the "Select a Wizard" dialog.
  
 
[[File:New_other.png]]
 
[[File:New_other.png]]
  
−
'''Fig 5.''' Right-click on the existing project to add an item
+
From the "Select a Wizard" dialog, select ''Create Item Wizard'' and click ''Next''.
  
 
[[File:Create_item_wiz.png]]
 
[[File:Create_item_wiz.png]]
  
−
'''Fig 6.''' Choose 'Create Item Wizard'
+
Next, select ''VIBE Model'' and click ''Finish''.
  
−
[[File:Vibe_model_added.png]]
+
[[File:ICE_VIBE_item-selector_stc.png]]
  
−
'''Fig 7.'''The VIBE Model item is now added to your project
+
The VIBE Model is now visible in the "Project" view pane.
 +
 
 +
[[File:Vibe_model_added.png]]
  
−
Similarly,the other VIBE items can be added in order to run the simulation.
+
Other VIBE items can be added to a project by going through the steps outlined above. The user can also execute their simulations from within their project.

Latest revision as of 14:14, 28 November 2016

Introduction

ICE provides three items that can be used to configure and run Virtual Integrated Battery Environment (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.


Creating a VIBE Model

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 shown below.

Vibe model.png

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

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

Select Export to VIBE INI format from the combo box, 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.

ICE create item stc 2.png

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.


Running the Simulation

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

ICE VIBE launcher GO stc.png


Adding VIBE to an Existing Project

VIBE items can also be created within an existing project.

In the "Project Explorer" view pane, right click on the project and choose New > Other. This action will prompt the "Select a Wizard" dialog.

New other.png

From the "Select a Wizard" dialog, select Create Item Wizard and click Next.

Create item wiz.png

Next, select VIBE Model and click Finish.

ICE VIBE item-selector stc.png

The VIBE Model is now visible in the "Project" view pane.

Vibe model added.png

Other VIBE items can be added to a project by going through the steps outlined above. The user can also execute their simulations from within their project.

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

This page was last modified 14:14, 28 November 2016 by Sam Crawford. Based on work by Ksenia Burova.

Back to the top