rasaeco 0.0.5

Render once

Render the scenarios in-place once:

pyrasaeco-render.exe once --scenarios_dir c:\some\path\to\scenarios

(Change c:\some\path\to\scenarios to fit your system.)

Open the scenario ontology with your browser from: c:\some\path\to\scenarios\ontology.html.

(Don’t forget to change c:\some\path\to\scenarios again to fit your system.)

Render continuously

Monitor the scenario files and re-render on changes:

pyrasaeco-render.exe continuously --scenarios_dir c:\some\path\to\scenarios

(Change c:\some\path\to\scenarios to fit your system.)

Open the scenario ontology with your browser from: c:\some\path\to\scenarios\ontology.html.

(Don’t forget to change c:\some\path\to\scenarios again to fit your system.)

Render continuously + automatic refresh

pyrasaeco-render can also start a demo server for you so that you do not have to manually re-load in the browser. You have to specify the port and the server will be automatically started:

pyrasaeco-render.exe continuously
    --scenarios_dir c:\some\path\to\scenarios
    --port 8000

(Change c:\some\path\to\scenarios to fit your system.)

The ontology will be available on: http://localhost:8000.

Help

pyrasaeco-render.exe -h
pyrasaeco-render.exe once -h
pyrasaeco-render.exe continuously -h

Directory Structure

Write documents in the following directory structure:

ontology/
    some-scenario/
        scenario.md
    another-scenario/
        scenario.md
    yet-another-scenario/
        scenario.md
...

Header

Write a <rasaeco-meta> header at the beginning of a scenario.

Here is an example:

<rasaeco-meta>
{
    "identifier": "some_scenario",
    "title": "Some Scenario",
    "relations": [
        { "target": "another_scenario", "nature": "is instance of" }
        { "target": "yet_another_scenario", "nature": "refines" }
    ],
    "volumetric": [
        {
            "aspect_from": "as-planned", "aspect_to": "safety",
            "phase_from": "construction", "phase_to": "construction",
            "level_from": "site", "level_to": "site"
        }
    ]
}
</rasaeco-meta>

Models

Models are defined as headings 3 (### plan/some_model) beneath the heading 2 ## Models.

Definitions

Definitions are defined as headings 3 (### some_definition) beneath the heading 2 ## Definitions.

If you want to write (pseudo)code in the definition, use ``` (three backticks):

### reception_platforms

```bim
reception_platform_label = IfcLabel("ReceptionPlatform")

reception_platforms =
    SELECT e
    FROM
        e is IfcBuildingElementType modeled in observed/main
    WHERE
        e.ElementType == reception_platform_label
```
</def>

Tags in the Scenario

Tag text in markdown with XML tags.

Model references are written using <modelref> tag:

The possible placements for the reception platform should be computed based on
the <modelref name="observed/main" />.

Definition references are written using <ref> tag:

The <ref name="receptionPlatforms" /> can not be appropriately fixed.

Marking phase and level. Use <phase> and <level> to mark the phase in the building life cycle and hierarchy level of detail, respectively.

<phase name="planning">During the planning phase, the <ref name="scaffolds" />
are wrongly planed.</phase>

<phase name="construction">The <ref name="receptionPlatforms" /> can not be appropriately fixed
on <level name="site">the site</level>.</phase>

Further Examples

Please see Sample scenarios for further examples.