ghorwin / FMICodeGenerator

A Code Generator that creates native C/C++ code to build Functional Mock-Up Units (FMU) with support for FMI version 2.0 (rollback)
BSD 3-Clause "New" or "Revised" License
51 stars 25 forks source link

The README and tutorial pages may need updating #45

Closed MathiasMalandain closed 1 year ago

MathiasMalandain commented 1 year ago

Description

I started using FMICodeGenerator by following the instructions on this page, on a Lubuntu 22.04 (based on Ubuntu 22.04.2 LTS "Jammy") virtual machine. Several steps from this tutorial, as well as the README file itself, could not be performed, or not "as is".

Wrong dependencies

Everything I needed to make FMICodeGenerator work was already installed. However, I noticed several errors/discrepancies when trying to run the setup command for Python 3.x:

Instructions on Ubuntu 21.04 or newer may be added: qt5-default is obsolete since at least 21.04.

No compliance checker

Command fmuCheck.linux64, used here, is not known to my VM, and I do not think that either the tutorial or the README file says anything about it. I will be exporting the FMU from another tool to make sure it works.

ghorwin commented 1 year ago

Hi Mathias,

thanks for the feedback. Indeed, some things need to be fixed/updated, and I'll try to get this done next weekend.

The dependency section should be made distro-version dependend, and of course it is either "apt install" or "apt-get install". I'll fix this also.

Regarding the FMU checker, it is provided in a zip archive (and also from the FMI tools webpage) and needs to be extract into a binary search path (either system wide or locally with updated PATH variable in your .bashrc).

Once I've incorporated the changes in the doc/python code, I'll close the issue.

MathiasMalandain commented 1 year ago

Hi Andreas,

Thanks a lot for the quick and detailed reply (and for the top-notch tool !)

The possibility to add numbers as allowed characters in variable names is indeed an important feature.

Cheers.