Skip to main content
Jump to: navigation, search

Difference between revisions of "Apogy/FAQ"

(Where do I start to model my system in Apogy ?)
 
(9 intermediate revisions by one other user not shown)
Line 18: Line 18:
  
 
= User Interface =
 
= User Interface =
== How can I changed the appearance (or make invisible) the flags that appear in the 3D Viewer when ''Operation Call'' are invoked ? ==  
+
 
These flags are represented by ''Result Node'' in Apogy. Their appearance can be modified through the preferences:
+
== How can I open Perspective in Apogy ? ==  
#In the top menu bar, select '''''Window→Preferences'''''. This will open the ''Preferences'' pop-up.
+
#In the top menu bar, select [[Image:Apogy_Perspective_Icon.png|Open New Perspective]]. This will open the ''Add Perspective'' pop-up.
#In the pop-up, select the '''''Apogy→3D Viewer→Results'''''. Change the visibility and appearance.
+
#In the pop-up, select the Perspective you want to open, then press ''OK''
#Press ''Apply'' or ''OK''.
+
#The perspective you selected has been opened and is now the active Perspective.
 +
 
 +
== How can I switch between Perspective in Apogy ? ==
 +
#In the top menu bar, select the ison of the Perspective you whish to activate.
 +
#The perspective you selected is now the active Perspective.
  
 
== How can I create a custom Perspective in Apogy ? ==  
 
== How can I create a custom Perspective in Apogy ? ==  
Line 37: Line 41:
 
#Press ''OK''
 
#Press ''OK''
  
== How can I shared a Perspective I created live? ==  
+
== How can I share a Perspective I created live? ==  
 
You do so by exporting the perspective to a file:
 
You do so by exporting the perspective to a file:
 
#In the top menu bar, select the perspective you want to modify;
 
#In the top menu bar, select the perspective you want to modify;
Line 55: Line 59:
 
#In the pop-up, select the '''''Apogy→3D Viewer→Sky'''''. Change the ''Star Magnitude Cutoff''. Note that the largest the magnitude, the faintest the star. Thus to reduce the number of stars shown, reduce the cutoff magnitude.
 
#In the pop-up, select the '''''Apogy→3D Viewer→Sky'''''. Change the ''Star Magnitude Cutoff''. Note that the largest the magnitude, the faintest the star. Thus to reduce the number of stars shown, reduce the cutoff magnitude.
 
#Press ''Apply'' or ''OK''.
 
#Press ''Apply'' or ''OK''.
 +
 +
== How can I create a Operation Call List? ==
 +
To create an [[Apogy/Concepts#Operation Call List | ''Operation Call List'']], use the Programs perspective:
 +
#First, bring up the '''''Programs''''' perspective:
 +
##In the top menu bar, select [[Image:Apogy_Perspective_Icon.png|Open New Perspective]]. This will open the ''Add Perspective'' pop-up.
 +
##In the pop-up, select '''''Programs''''', then press ''OK'', this will cause Apogy to switch to the ''Programs'' perspective.
 +
#If you want to create a new Program Group that will contain your Operation Call List, do the following:
 +
## In the ''Programs'' view, press ''New Group'', this will bring-up a ''New Program Group Wizard'':
 +
### Provide a Name and a description for the Program Group;
 +
### Press ''Finish''
 +
#In the ''Programs'' view, select the ''Program Group'' under which you want to create your ''Operation Call List''
 +
#Then press ''New Program'', this will bring up the new Program Wizard:
 +
##In the wizard, select '''''OperationCallList''''', then press ''Next''
 +
## Provide a Name and a description for the Program;
 +
## Press ''Finish'';
 +
 +
== How can I create a Operation Call ? ==
 +
The Programs perspective provides the views required to do so:
 +
#First, bring up the '''''Programs''''' perspective:
 +
##In the top menu bar, select [[Image:Apogy_Perspective_Icon.png|Open New Perspective]]. This will open the ''Add Perspective'' pop-up.
 +
##In the pop-up, select '''''Programs''''', then press ''OK'', this will cause Apogy to switch to the ''Programs'' perspective.
 +
#If you want to create a new [[Apogy/Concepts#Operation Call List | ''Operation Call List'']] :
 +
## Follow the steps
 +
#In the ''Programs'' list, select the Operation Call List in which you want to create the Operation Call;
 +
#In the ''Program'' View, press ''New'', this will bring-up the new Operation Call Wizard:
 +
## Give a name and provide a description for the Operation Call, then press ''Next'';
 +
## Under the ''Variable'' list, select the variable that will execute the call or the Variable that contains the sub-system that will execute the call;
 +
## Under the ''Sub-Type'' section, select the sub-system that will execute the call (if applicable);
 +
## Under the ''Feature'' section, select the sub-system's attribute (feature) that will execute the call (if applicable);
 +
#In the ''Operation'' section, select the Operation to call;
 +
#Press ''Next'' (or ''Finish'' if the Operation does not require parameters);
 +
#If the Operation does require parameters, do the following for each parameter:
 +
##Select the parameter in the list;
 +
##Edit the ''Value'' field
 +
# When done with the parameters, press 'Finish''.
  
 
== How can I capture the current state of my Systems? ==
 
== How can I capture the current state of my Systems? ==
Line 76: Line 115:
 
#Use the ''Initial Conditions Overview'' and ''Initial Conditions Details'' to review / edit the state data.
 
#Use the ''Initial Conditions Overview'' and ''Initial Conditions Details'' to review / edit the state data.
 
#Press ''Apply'', this will have Apogy apply the InitialConditions state to the System instances.
 
#Press ''Apply'', this will have Apogy apply the InitialConditions state to the System instances.
 +
 +
== How can I changed the appearance (or make invisible) the flags that appear in the 3D Viewer when ''Operation Call'' are invoked ? ==
 +
These flags are represented by ''Result Node'' in the Apogy topology. Their appearance can be modified through the preferences:
 +
#In the top menu bar, select '''''Window→Preferences'''''. This will open the ''Preferences'' pop-up.
 +
#In the pop-up, select the '''''Apogy→3D Viewer→Results'''''. Change the visibility and appearance.
 +
#Press ''Apply'' or ''OK''.
  
 
= Modeling Systems in Apogy =
 
= Modeling Systems in Apogy =
Line 89: Line 134:
  
 
TODO
 
TODO
 +
 +
= Common Bugs =
 +
== java.lang.NoClassDefFoundError: jdk/nashorn/internal/runtime/ECMAException ==
 +
# Ensure Eclipse/RCP uses a Java JDK with lib/ext directory. 
 +
# Add -Dosgi.framework.extensions=org.eclipse.wst.jsdt.nashorn.extension to the VM arguments.
 +
See [https://wiki.eclipse.org/JSDT/Equinox_hook_for_Nashorn https://wiki.eclipse.org/JSDT/Equinox_hook_for_Nashorn] for further explanations.

Latest revision as of 16:14, 5 December 2018

Table Of Contents

Getting Started

What is Apogy?

TODO

Where can I get Apogy?

TODO

How do I get started with Apogy?

Use one of the Session that is provided with the Apogy Examples:

  1. Install Apogy;
  2. Launch Apogy;
  3. Go through the Quick Start steps.

User Interface

How can I open Perspective in Apogy ?

  1. In the top menu bar, select Open New Perspective. This will open the Add Perspective pop-up.
  2. In the pop-up, select the Perspective you want to open, then press OK
  3. The perspective you selected has been opened and is now the active Perspective.

How can I switch between Perspective in Apogy ?

  1. In the top menu bar, select the ison of the Perspective you whish to activate.
  2. The perspective you selected is now the active Perspective.

How can I create a custom Perspective in Apogy ?

You need to open a new Empty perspective:

  1. In the top menu bar, select Open New Perspective. This will open the Add Perspective pop-up.
  2. In the pop-up, select Empty, then press OK
  3. You can now add views to the perspective;

How can I change the name and icon of a custom Perspective Apogy ?

  1. In the top menu bar, select the perspective you want to modify;
  2. Right-click on the icon, this will show a pull-down menu;
  3. Select Modify shortcut, this will bring-up a Wizard.
  4. Use the wizard to change the label text and icon file URL.
  5. Press OK

How can I share a Perspective I created live?

You do so by exporting the perspective to a file:

  1. In the top menu bar, select the perspective you want to modify;
  2. Right-click on the icon, this will show a pull-down menu;
  3. Select Save as, this will bring-up a File selection Wizard.
  4. Select the name and destination folder for the perspective.
  5. Press OK

How can I import a Perspective I exported earlier?

  1. In the top menu bar, select Window→Import Perspective, this will bring-up a File selection Wizard.
  2. Select the file you want to import, then press OK
  3. A perspective with the _import suffix is created and selected as the active perspective.

How can I change the number of stars shown in the sky?

You do so by changing the cut-off magnitude preference of the 3D Viewer:

  1. In the top menu bar, select Window→Preferences. This will open the Preferences pop-up.
  2. In the pop-up, select the Apogy→3D Viewer→Sky. Change the Star Magnitude Cutoff. Note that the largest the magnitude, the faintest the star. Thus to reduce the number of stars shown, reduce the cutoff magnitude.
  3. Press Apply or OK.

How can I create a Operation Call List?

To create an Operation Call List, use the Programs perspective:

  1. First, bring up the Programs perspective:
    1. In the top menu bar, select Open New Perspective. This will open the Add Perspective pop-up.
    2. In the pop-up, select Programs, then press OK, this will cause Apogy to switch to the Programs perspective.
  2. If you want to create a new Program Group that will contain your Operation Call List, do the following:
    1. In the Programs view, press New Group, this will bring-up a New Program Group Wizard:
      1. Provide a Name and a description for the Program Group;
      2. Press Finish
  3. In the Programs view, select the Program Group under which you want to create your Operation Call List
  4. Then press New Program, this will bring up the new Program Wizard:
    1. In the wizard, select OperationCallList, then press Next
    2. Provide a Name and a description for the Program;
    3. Press Finish;

How can I create a Operation Call ?

The Programs perspective provides the views required to do so:

  1. First, bring up the Programs perspective:
    1. In the top menu bar, select Open New Perspective. This will open the Add Perspective pop-up.
    2. In the pop-up, select Programs, then press OK, this will cause Apogy to switch to the Programs perspective.
  2. If you want to create a new Operation Call List :
    1. Follow the steps
  3. In the Programs list, select the Operation Call List in which you want to create the Operation Call;
  4. In the Program View, press New, this will bring-up the new Operation Call Wizard:
    1. Give a name and provide a description for the Operation Call, then press Next;
    2. Under the Variable list, select the variable that will execute the call or the Variable that contains the sub-system that will execute the call;
    3. Under the Sub-Type section, select the sub-system that will execute the call (if applicable);
    4. Under the Feature section, select the sub-system's attribute (feature) that will execute the call (if applicable);
  5. In the Operation section, select the Operation to call;
  6. Press Next (or Finish if the Operation does not require parameters);
  7. If the Operation does require parameters, do the following for each parameter:
    1. Select the parameter in the list;
    2. Edit the Value field
  8. When done with the parameters, press 'Finish.

How can I capture the current state of my Systems?

You do so by creating an InitialConditions and collecting the current state of your systems to it. The required view is part of the System Perspective.:

  1. In the top menu bar, select Open New Perspective. This will open the Add Perspective pop-up.
  2. In the pop-up, select Systems, then press OK, this will cause Apogy to switch to the Systems perspective.
  3. Bring up the Initial Conditions view;
  4. In the Available Initial Conditions section, press New, this will bring-up a creation Wizard.
    1. In the wizard, specify a name;
    2. Provide a description, then press Finish
  5. In the Available Initial Conditions section, select the InitialConditions you just created;
  6. Press Collect, this will have Apogy collect the current state of all System instances and save them to you InitialConditions.
  7. Use the Initial Conditions Overview and Initial Conditions Details to review / edit the state data.

How can I apply current state that I saved previously to my Systems?

You do so by applying an InitialConditions to your systems. The required view is part of the System Perspective.:

  1. In the top menu bar, select Open New Perspective. This will open the Add Perspective pop-up.
  2. In the pop-up, select Systems, then press OK, this will cause Apogy to switch to the Systems perspective.
  3. Bring up the Initial Conditions view;
  4. In the Available Initial Conditions section, select the InitialConditions you want to apply;
  5. Use the Initial Conditions Overview and Initial Conditions Details to review / edit the state data.
  6. Press Apply, this will have Apogy apply the InitialConditions state to the System instances.

How can I changed the appearance (or make invisible) the flags that appear in the 3D Viewer when Operation Call are invoked ?

These flags are represented by Result Node in the Apogy topology. Their appearance can be modified through the preferences:

  1. In the top menu bar, select Window→Preferences. This will open the Preferences pop-up.
  2. In the pop-up, select the Apogy→3D Viewer→Results. Change the visibility and appearance.
  3. Press Apply or OK.

Modeling Systems in Apogy

TODO

What is a System?

TODO

Where do I start to model my system in Apogy ?

TODO

Common Bugs

java.lang.NoClassDefFoundError: jdk/nashorn/internal/runtime/ECMAException

  1. Ensure Eclipse/RCP uses a Java JDK with lib/ext directory.
  2. Add -Dosgi.framework.extensions=org.eclipse.wst.jsdt.nashorn.extension to the VM arguments.

See https://wiki.eclipse.org/JSDT/Equinox_hook_for_Nashorn for further explanations.

Back to the top