Difference between revisions of "Triquetrum/Getting Started"

Revision as of 18:51, 29 January 2016

This page covers how to get started with Triquetrum.

Check Out the Repo

Use Eclipse to check out the repo.

1. Install Eclipse for RCP and RAP Developers. Other versions may work. These instructions were tested using Mars June 2015 under Mac OS X.
2. Start Eclipse. Create a new workspace. You may need to close the Welcome tab by clicking on the X.
3. Window -> Show View -> Other -> Git -> Git Repositories
4. Click on "Clone a Git repository"
5. Click on "Clone URI", then Next
6. Enter the URI https://github.com/eclipse/triquetrum/
7. In the Branch Selection window, keep the default of the Master branch and click Next.
8. In the Local Destination window, select Finish.

Importing Projects

In the Git Repositories tab, expand the triquetrum tab, right click on Working Directory and select Import Projects.

Keep "Import existing Eclipse projects" selected, click Next then Finish.

Building

The build will show lots of errors. Don't panic.

1. Expand org.eclipse.triquetrum.target.platform and click on "triq.target"

2. The target will build. See the bottom right for the status. It may take a minute or two to build.

3. In trig.target tab, Target Definition pane, click on Set as Target Platform.

4. Under org.eclipse.triquetrum.workflow.editor, click on Triquetrum.product

5. In the Triquetrum.product tab, click on the validate icon in the upper right. The icon looks like a lined piece of paper with an check mark.

A dialog indicating that no problems were detected should come up.

6. In the Triquetrum.product pane, Overview tab, under Testing, click on Launch an Eclipse Application. The application should start up. [1]

Running

The Eclipse Application may show a welcome window, which you can close. You will then see a fresh Triquetrum window: [2]

Create a Workspace

Triquetrum is based on a workspace model for projects, so first we create a workspace:

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

[3]

1. Click on Next
2. Enter the name of your workspace. We chose ``myWorkspace``.
3. Click on Finish
4. Your workspace 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 the newly created workspace
2. Select New -> Other

[4]

1. In the Select a wizard dialog, open Workflows and select Triquetrum workflow model

[5]

1. Click on Next
2. In the Diagram window, select the Diagram type of Triquetrum workflow (you may need to double click on Triquetrum workflow)
3. In Triquetrum, a tab called newDiagram should appear:

[6]

Build and Run A Model

1. Drag a Const, Discard and SDF director from the right side into the newDiagram pane.
2. Then drag from the Const output port to the Discard 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:

[7]

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. You should see lines that have the state of the ptolemy.actor.Manager, starting with STARTING:

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

• 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:

[8]

FIXME: There is a problem under Mac OS X where the updated values are ignored, see Triquetrum Issue #7.