Structure - Documentation

Structure

On this screen, the user will define the model structure. The structure is comprised of node type, node names, and the flow for the sequence of nodes.

Left hand pane -> Markdown editor

To build a model, the user will document the types of nodes and node names on the Markdown Editor pane.

Each node type needs a [Section Header] defined by brackets [ ].

The following node types are available in ChiAha Express:

Buffer
Constraint
Split
Merge
Conveyor
Conversions

Nodes can be defined in any of the following ways:

Option 1: Name	Option 2: Description	Option 3: Name and Description
`b1`	`buffer1`	`b1: Buffer 1`

Node Name and Description are alphanumeric and can contain most symbols. The only place where spaces or a leading capital letter are allowed is in a Description as shown in Example 3, where both a name and description are defined.

[Links] define the flow or sequence of material/processing step using -> to separate nodes. We prefer approach shown in example 3 due to it's simplicity in the links.

As an example, let's consider a model with a simple buffer-constraint-buffer setup. This can be represented with the link structure shown here:

Option 1: Name Option 2: Description Option 3: Name and Description

Option 1: Name	Option 2: Description	Option 3: Name and Description
`[Links]` `b1 -> c1` `c1 -> b2`	`[Links]` `buffer1 -> constraint1` `constraint1 -> buffer`	`[Links]` `b1 -> c1` `c1 -> b2`

[Links]

b1 -> c1

c1 -> b2

[Links]

buffer1 -> constraint1

constraint1 -> buffer

[Links]

b1 -> c1

c1 -> b2

Right hand pane -> Node View

The model structure will appear on the right hand pane when a valid model is defined in the editor pane.