Installation
Optional dependencies
Graphviz
Trano employs Graphviz to arrange various Modelica components within the model. While installation is not mandatory, it is advisable for enhanced model visualization. You can install Graphviz by following the instructions on the official website. For Windows installations, ensure the Graphviz bin folder is added to the system PATH.
To install Graphviz on Linux, use the following command:
Docker
Trano utilizes the official OpenModelica Docker image to execute simulations. It is recommended to install Docker on your system so that Trano can pull the required images and run simulations. You can install Docker by following the instructions on the official website.
Modelica libraries
The simulation container installs the Modelica libraries Trano generates models for: Buildings 13.0.0 (built against Modelica 4.1.0), IDEAS 3.0.0 and AixLib 3.0.1 (both built against Modelica 4.0.0), on the openmodelica/openmodelica:v1.26.9-ompython image. Both Modelica Standard Library versions are installed side by side; the versions are defined in one place, trano.simulate.simulate.ModelicaEnvironment. IDEAS 4.0.0 is not used yet: no OpenModelica release handles it (1.25 cannot parse it, 1.26 and 1.27 fail with internal errors on its weather bus, also in IDEAS' own examples).
Each simulation container first runs an OpenModelica script that installs these libraries with the package manager. A library already present on the container's MODELICAPATH (for example baked into an image derived from the official one under /root/.openmodelica/libraries) is not installed again, so simulations also work where the package index cannot be reached.
Python package
Warning
Trano requires python 3.9 or higher and docker to be installed on the system.
Trano is a Python package that you can install via pip.
Trano can also be utilized with Poetry.
The Python package enables the generation of a Modelica model from the YAML configuration input. However, to simulate the model, Docker must be installed on the system.
On Windows systems, you may need to enable long path support. Refer to the Microsoft documentation for guidance.
Check installation
To verify the installation, execute the following command in the terminal.
This command checks your system's compatibility for model generation and simulation. Compatibility is optional if you only intend to generate the Modelica model.