Package: pythonfmu3
PythonFMU3A lightweight framework that enables the packaging of Python 3 code as co-simulation FMUs (following FMI version 3.0).This project is a fork of the original PythonFMU repository available athttps://github.com/NTNU-IHB/PythonFMU, which was used as the basis for adding support for FMI 3.0. While we have made efforts to expand the functionality of this project, it currently has some limitations and does not support all the features of FMI 3.0. We would like to acknowledge and give credit to the original PythonFMU project for their contributions to this work.Support:Please take a look at the examples to see the supported features.FutureIn no particular order, we plan to add support for:Support more variable types from FMI3Improve array supportAdd event modeHow do I build an FMU from python code?Installpythonfmu3package:pipinstallpythonfmu3Create a new class extending theFmi3Slaveclass declared in thepythonfmu3.fmi3slavemodule (see below for an example).Runpythonfmu3 buildto create the fmu.usage: pythonfmu3 build [-h] -f SCRIPT_FILE [-d DEST] [--doc DOCUMENTATION_FOLDER] [--no-external-tool]
                       [--no-variable-step] [--interpolate-inputs] [--only-one-per-process] [--handle-state]
                       [--serialize-state] [--use-memory-management]
                       [Project files [Project files ...]]

Build an FMU from a Python script.

positional arguments:
  Project files         Additional project files required by the Python script.

optional arguments:
  -h, --help            show this help message and exit
  -f SCRIPT_FILE, --file SCRIPT_FILE
                        Path to the Python script.
  -d DEST, --dest DEST  Where to save the FMU.
  --doc DOCUMENTATION_FOLDER
                        Documentation folder to include in the FMU.
  --no-external-tool    If given, needsExecutionTool=false
  --no-variable-step    If given, canHandleVariableCommunicationStepSize=false
  --interpolate-inputs  If given, canInterpolateInputs=true
  --only-one-per-process
                        If given, canBeInstantiatedOnlyOncePerProcess=true
  --handle-state        If given, canGetAndSetFMUstate=true
  --serialize-state     If given, canSerializeFMUstate=trueHow do I build an FMU from python code with third-party dependencies?Often, Python scripts depends on non-builtin libraries likenumpy,scipy, etc.PythonFMUdoes not package a full environment within the FMU.
However, you can package arequirements.txtorenvironment.ymlfile within your FMU following these steps:Installpythonfmupackage:pip install pythonfmu3Create a new class extending theFmi3Slaveclass declared in thepythonfmu3.fmi3slavemodule (see below for an example).Create arequirements.txtfile (to usepipmanager) and/or aenvironment.ymlfile (to usecondamanager) that defines your dependencies.Runpythonfmu3 build -f myscript.py requirements.txtto create the fmu including the dependencies file.And usingpythonfmu3 deploy, end users will be able to update their local Python environment. The steps to achieve that:Installpythonfmupackage:pip install pythonfmu3Be sure to be in the Python environment to be updated. Then executepythonfmu3 deploy -f my.fmuusage: pythonfmu3 deploy [-h] -f FMU [-e ENVIRONMENT] [{pip,conda}]

Deploy a Python FMU. The command will look in the `resources` folder for one of the following files:
`requirements.txt` or `environment.yml`. If you specify a environment file but no package manager, `conda` will be selected for `.yaml` and `.yml` otherwise `pip` will be used. The tool assume the Python environment in which the FMU should be executed is the current one.

positional arguments:
  {pip,conda}           Python packages manager

optional arguments:
  -h, --help            show this help message and exit
  -f FMU, --file FMU    Path to the Python FMU.
  -e ENVIRONMENT, --env ENVIRONMENT
                        Requirements or environment file.Example:Write the scriptfrompythonfmu3importFmi3Causality,Fmi3Slave,Boolean,Int32,Float64,StringclassPythonSlave(Fmi3Slave):author="John Doe"description="A simple description"def__init__(self,**kwargs):super().__init__(**kwargs)self.intOut=1self.realOut=3.0self.booleanVariable=Trueself.stringVariable="Hello World!"self.register_variable(Int32("intOut",causality=Fmi3Causality.output))self.register_variable(Float64("realOut",causality=Fmi3Causality.output))self.register_variable(Boolean("booleanVariable",causality=Fmi3Causality.local))self.register_variable(String("stringVariable",causality=Fmi3Causality.local))# Note:# it is also possible to explicitly define getters and setters as lambdas in case the variable is not backed by a Python field.# self.register_variable(Float64("myReal", causality=Fmi3Causality.output, getter=lambda: self.realOut, setter=lambda v: set_real_out(v))defdo_step(self,current_time,step_size):returnTrueCreate the FMUpythonfmu3 build -f pythonslave.py myprojectIn this example a python class namedPythonSlavethat extendsFmi3Slaveis declared in a file namedpythonslave.py,
wheremyprojectis an optional folder containing additional project files required by the python script.
Project folders such as this will be recursively copied into the FMU. Multiple project files/folders may be added.