openmodelica / omfrontend.js Goto Github PK

The Modelica compliance of the frontend needs to be tested to document the existing and missing functionality.

Sketch of needed high level API commands for integrating the frontend in a usual Modelica workflow.

Loading and parsing - model management

• load a model or library from a directory
• load a model or library from a zip file
• load a model or library from a git repository
• load a model or library from an URL

Diagramming support

• toIcon(Path.To.Model) -> G6 JSON
• toDiagram(Path.To.Model) -> G6 JSON
• toDialog(Path.To.Model) -> JSON Forms
• modificationListener(diagram, forms) -> OMFrontend.js AST changes

Simulation support

• simulate(Path.To.Model, LibraryDependencyList (from uses annotation)) -> JSON

The flattening tests from OpenModelica testsuite should be ported to the repository for testing (or supported directly).

Add support for connecting the components dragged to the canvas.

Explore how to use the https://github.com/antvis/g6 library to achieve this.

Add support for dragging and drooping components from a library to a canvas.

One idea would be to use https://github.com/antvis/g6 for the diagram support by providing a translation from the Modelica graphical annotations to the JSON forma of G6.

Add support for displaying and editing component parameters.

Possible approach:

• generate JSON Forms https://jsonforms.io/ from the Modelica instantiated model
• gather all the modifications into one top-level modification to the component

For already simulated models one can retrieve the simulation results from the backend.

Devise tests to ensure that the diagramming functionality is supported properly.

The frontend should send the top level model and all the needed dependencies to the backend for simulation.