A tool for parsing Modelica models to CDEs for simulation, analysis and documentation of building controls
The tool is heavily inspired by the modelica-json tool, but has been created in Python to increase usability to myself and other amateur coders.
The ANTLR4 Modelica grammar file was used to create the visitors, lexers and parsers in antlr_scripts.
The python package can be installed in the python environment with pip: pip install setup.py
The main function is the create_modelica_JSON() function from the modelica2cde package. An example, which uses command line arguments to translate a Modelica model can be found in the examples folder. To translate a model with the path FILEPATH, run the following command from the root folder:
python examples\from_command_line.py -f FILEPATH [-gp]
By using the optional -gp flag, point lists will be generated for all components in the model with a generatePointlist=true annotation, as specified in the Control Description Language (CDL) documentation. Only point lists from classes in the Modelica Buildings Library can be generated, unless other libraries are loaded in the scripts. Point lists may not include all points if a class is an extension of another class and only the relative URI of the extended class is present.
To support generation of point list for components in the model, OpenModelica must be installed, and the Modelica Buildings Library must be located in the path used by OpenModelica (usually, the Buildings library is installed along with OpenModelica).
Currently, only files with single models are supported, and many other limitations exist, since this is supposed to be a simpler and more modifiable version of the modelica-json tool. Hopefully, the experienced user can mitigate these limitations on their own.
This version has only accomplished to generate a JSON file - in the future, it is expected that the program can output RDF-based data, aligned with BRICK and CDL.