rasaeco 0.0.15

单文件发布

请从GitHub 发布页面下载并解压最新版本。

从 PyPI

该工具也可在PyPI上获取。

创建虚拟环境

python -m venv venv-rasaeco

激活它（在 Windows 上）

venv-rasaeco\Scripts\activate

或者在 Linux 上

source venv-rasaeco/bin/activate

在虚拟环境中安装工具

pip3 install rasaeco

渲染一次

一次性渲染场景

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

（将 c:\some\path\to\scenarios 更改为适合您的系统。）

从以下路径使用浏览器打开场景本体：c:\some\path\to\scenarios\ontology.html。

（别忘了再次将 c:\some\path\to\scenarios 更改为适合您的系统。）

持续渲染

监视场景文件，并在更改时重新渲染

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

（将 c:\some\path\to\scenarios 更改为适合您的系统。）

从以下路径使用浏览器打开场景本体：c:\some\path\to\scenarios\ontology.html。

（别忘了再次将 c:\some\path\to\scenarios 更改为适合您的系统。）

持续渲染 + 自动刷新

pyrasaeco-render 还可以为您启动演示服务器，这样您就无需手动在浏览器中重新加载。您必须指定端口号，服务器将自动启动

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

（将 c:\some\path\to\scenarios 更改为适合您的系统。）

本体将在： http://localhost:8000 上可用。

帮助

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

目录结构

按照以下目录结构编写文档

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

场景的标识符由本体目录相对于场景目录的 POSIX 路径给出。

例如，some-scenario 和 some-group/another-scenario。

头部

在场景的开始处编写一个 <rasaeco-meta> 头部。

以下是一个示例

<rasaeco-meta>
{
    "title": "Some Scenario",
    "contact": "Marko Ristin <rist@zhaw.ch>, Somebody Else <somebody@else.ch>",
    "relations": [
        { "target": "some-group/another_scenario", "nature": "is instance of" }
        { "target": "some-group/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>

场景中的标签

使用 XML 标签以 markdown 格式编写标签文本。

模型。模型定义为 <model name="...">...</model>。

模型引用 使用 <modelref> 标签编写

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

还可以通过编写场景标识符，后跟 # 和模型名称来从另一个场景引用模型

This is a dummy reference to the model <modelref name="scaffolding#plan/main" />.

定义。定义定义为 <def name="...">...</def>。

如果您想在定义中编写（伪）代码，请使用 ```（三个反引号）

<def name="reception_platform">

```bim
reception_platform
    is IfcBuildingElementType modeled in observed/main
    with .ElementType == "ReceptionPlatform"
```

</def>

通常，使用单数形式、snake_case 和小写字母命名。例如，reception_platform。

定义引用 使用 <ref> 标签书写

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

也可以通过编写场景标识符，然后是 # 和定义名称，来引用另一个场景中的模型

This is a dummy reference to the definition <ref name="scaffolding#scaffold" />.

我们在渲染过程中应用了一些文本转换来提高可读性。引用中的下划线将被替换为空格。如果引用后面跟有“s”，它将被自动变为复数。

例如，

The <ref name="misplaced_scaffold" />s are ...

将渲染为

The misplaced scaffolds are ...

标记阶段和级别。分别使用 <phase> 和 <level> 标记建筑生命周期中的阶段和细节级别。

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

测试用例。使用 <test name="...">...</test> 标记测试用例。您可以使用 <testref name="..." /> 引用单个测试。

类似于 <ref> 和 <modelref>，测试用例的引用可以跨场景扩展。

验收标准。使用 <acceptance name="...">...</test> 标记验收标准。您可以使用 <acceptanceref name="..." /> 引用单个验收标准。

类似于 <ref> 和 <modelref>，验收标准的引用可以跨场景扩展。

对整个场景的引用。您可以使用 <scenarioref name="..." /> 从另一个场景引用场景。

进一步示例

请参阅 示例场景 以获取更多示例。