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 "Triquetrum/Getting Started"

(Create a project named ``MyProject``)
(Change instructions that referred to "Discard" to be "Display" to match the screenshot)
 
(10 intermediate revisions by one other user not shown)
Line 28: Line 28:
 
# Click on Next
 
# Click on Next
 
# Enter the name of your project.  We chose ``MyProject``.
 
# Enter the name of your project.  We chose ``MyProject``.
[[File:TriquetrumGettingStartedCreateNewProjectResource.png|400px|Create a project named ``My Project``
+
[[File:TriquetrumGettingStartedCreateNewProjectResource.png|400px|Create a project named ``My Project``]]
 
# Click on Finish
 
# Click on Finish
 
# Your project will appear in the Package Explorer tab
 
# Your project will appear in the Package Explorer tab
Line 35: Line 35:
 
The next step is to create a workflow:
 
The next step is to create a workflow:
  
# In the Package Explorer, right click on the newly created workspace
+
# In the Package Explorer, right click on MyProject, the newly created project
# Select New -> Other
+
# Select New -> Other and the Select a wizard dialog appears:<br/>[[File:TriquetrumGettingStartedCreateNewWorkflow.png|400px|Creating a new workflow]]
[https://raw.githubusercontent.com/wiki/eclipse/triquetrum/images/GettingStartedNewOther.png]
+
# In the Select a wizard dialog, in the Diagram Type drop down, select Triquetrum workflow model:<br/>[[File:TriquetrumGettingStartedDiagramDialog.png|400px|Selecting which type of diagram to create]]
# In the Select a wizard dialog, open Workflows and select Triquetrum workflow model
+
[https://raw.githubusercontent.com/wiki/eclipse/triquetrum/images/GettingStartedNewWorkflow.png]
+
 
# Click on Next
 
# Click on Next
# In the Diagram window, select the Diagram type of Triquetrum workflow (you may need to double click on Triquetrum workflow)
+
# Enter the name of the workflow, the default of newDiagram is fine.
# In Triquetrum, a tab called newDiagram should appear:
+
# In Triquetrum, a tab called newDiagram should appear:<br/>[[File:TriquetrumGettingStartedNewDiagramPanel.png|500px]]
[https://raw.githubusercontent.com/wiki/eclipse/triquetrum/images/GettingStartedTriqNewDiagram.png]
+
  
 
== Build and Run A Model ==
 
== Build and Run A Model ==
# Drag a Const, Discard and SDF director from the right side into the newDiagram pane.
+
# Drag a Const, Display and SDF director from the right side into the newDiagram pane.
# Then drag from the Const output port to the Discard input port.
+
# Then drag from the Const output port to the Display input port.
 
# Then click on the background of the diagram so that the relation changes from an orange dashed line to a blue solid line:
 
# Then click on the background of the diagram so that the relation changes from an orange dashed line to a blue solid line:
[https://raw.githubusercontent.com/wiki/eclipse/triquetrum/images/GettingStartedSimpleModel.png]
+
[[File:TriquetrumGettingStartedSimpleModel.png|862px]]
 
# Save the model.
 
# Save the model.
 
# Click the green run arrow in the upper left tool bar.
 
# Click the green run arrow in the upper left tool bar.
# Look in the Console tab of the Eclipse that was used to launch Triquetrum.  You should see lines that have the state of the ptolemy.actor.Manager, starting with <code>STARTING</code>:
+
# Look in the Console tab of the Eclipse that was used to launch Triquetrum.  A line showing the run time and memory should appear:
 
+
  398 ms. Memory: 440320K Free: 359309K (82%)
 
+
2015-12-15 15:20:22,890 INFO [pool-1-thread-1]  executor.WorkflowExecutionTask (call:124) - Context 1d97dbcf-28e6-4fb6-abb0-3827c6408870 - Starting execution of model newDiagram
+
2015-12-15 15:20:22,890 INFO [pool-1-thread-1]  executor.WorkflowExecutionTask (managerStateChanged:275) - Context 1d97dbcf-28e6-4fb6-abb0-3827c6408870 - Execution state change of model newDiagram : STARTING
+
2015-12-15 15:20:22,912 INFO [pool-1-thread-1]  executor.WorkflowExecutionTask (managerStateChanged:275) - Context 1d97dbcf-28e6-4fb6-abb0-3827c6408870 - Execution state change of model newDiagram : ACTIVE
+
2015-12-15 15:20:22,912 INFO [pool-1-thread-1]  executor.WorkflowExecutionTask (managerStateChanged:275) - Context 1d97dbcf-28e6-4fb6-abb0-3827c6408870 - Execution state change of model newDiagram : STOPPING
+
2015-12-15 15:20:22,913 INFO [pool-1-thread-1]  executor.WorkflowExecutionTask (managerStateChanged:275) - Context 1d97dbcf-28e6-4fb6-abb0-3827c6408870 - Execution state change of model newDiagram : IDLE
+
23 ms. Memory: 530944K Free: 403671K (76%)
+
2015-12-15 15:20:22,913 INFO [pool-1-thread-1]  executor.WorkflowExecutionTask (executionFinished:248) - Context 1d97dbcf-28e6-4fb6-abb0-3827c6408870 - Execution finished of model newDiagram
+
 
+
  
 
== Editing ==
 
== Editing ==
 
* To change the name of an actor, highlight the actor name in the model and type in a new name
 
* To change the name of an actor, highlight the actor name in the model and type in a new name
 
* To change a parameter, double click on the actor and select the parameter:
 
* To change a parameter, double click on the actor and select the parameter:
[https://raw.githubusercontent.com/wiki/eclipse/triquetrum/images/GettingStartedTriqEditParameters.png]
+
[[File:TriquetrumGettingStartedEditParameters.png|436px]]
 +
 
 +
=== Double-click does not always work ===
 +
If double clicking on an actor or attribute fails to bring up the Edit Attributes dialog, then hover over the actor or attribute and select the Configure icon marked in red:
 +
[[File:TriquetrumConfiguringWhenDoubleClickFails.png|345px]]
 +
 
 +
Next step: See [[Triquetrum/Opening A Model | Opening A Model]].
 +
----
 +
* Back to [[Triquetrum]]
  
FIXME: There is a problem under Mac OS X where the updated values are ignored, see [https://github.com/eclipse/triquetrum/issues/7 Triquetrum Issue #7].
+
[[Category:Triquetrum]]

Latest revision as of 14:30, 26 October 2016

This page covers how to get started with Triquetrum.

There are at least two ways to get started with Triquetrum:

  1. Building From Sources, which is for people who will collaborate on Triquetrum
  2. Downloads, which is for people who want to use Triquetrum

Running

Select a workspace

When Triquetrum starts up, you will be prompted to Select a workspace:

The "Select a workspace" window.  Either click on OK or Browse to a different location

The Welcome Pane

The Eclipse Application may show a welcome window, which you can close.

The Welcome pane.  Close the pane by clicking on the X in the pane tab

The first Triquetrum window

You will then see a fresh Triquetrum window:

The first Triquetrum window

Create a Triquetrum Project

Triquetrum is based on a project model, so first we create a project:

  1. Right click on the Project Explorer tab
  2. Select New -> Project -> General -> Project

The window that appears after right clicking in the Project Explorer pane and selecting New -> Project -> General -> Project.

  1. Click on Next
  2. Enter the name of your project. We chose ``MyProject``.

Create a project named ``My Project``

  1. Click on Finish
  2. Your project will appear in the Package Explorer tab

Create a Workflow

The next step is to create a workflow:

  1. In the Package Explorer, right click on MyProject, the newly created project
  2. Select New -> Other and the Select a wizard dialog appears:
    Creating a new workflow
  3. In the Select a wizard dialog, in the Diagram Type drop down, select Triquetrum workflow model:
    Selecting which type of diagram to create
  4. Click on Next
  5. Enter the name of the workflow, the default of newDiagram is fine.
  6. In Triquetrum, a tab called newDiagram should appear:
    TriquetrumGettingStartedNewDiagramPanel.png

Build and Run A Model

  1. Drag a Const, Display and SDF director from the right side into the newDiagram pane.
  2. Then drag from the Const output port to the Display input port.
  3. Then click on the background of the diagram so that the relation changes from an orange dashed line to a blue solid line:

TriquetrumGettingStartedSimpleModel.png

  1. Save the model.
  2. Click the green run arrow in the upper left tool bar.
  3. Look in the Console tab of the Eclipse that was used to launch Triquetrum. A line showing the run time and memory should appear:
 398 ms. Memory: 440320K Free: 359309K (82%)

Editing

  • To change the name of an actor, highlight the actor name in the model and type in a new name
  • To change a parameter, double click on the actor and select the parameter:

TriquetrumGettingStartedEditParameters.png

Double-click does not always work

If double clicking on an actor or attribute fails to bring up the Edit Attributes dialog, then hover over the actor or attribute and select the Configure icon marked in red: TriquetrumConfiguringWhenDoubleClickFails.png

Next step: See Opening A Model.


Back to the top