simbind 0.1.9

Generate Python wheel package from Simulink model!

Simbind CLI

Generate Python Wheel package from Simulink model to enhance your Software-in-Loop (SiL) tests development workflow! Please refer to Wiki and Examples to explore the project's capabilities and limitations.

Requirements

We highly recommend to use Dockerized version of Simbind, since collecting the correct versions of the necessary requirements can be challenging. If you opt for local installation, the following is required:

• Linux x86-64 machine with installed Matlab R2023b.
• Python 3.10 or 3.11: Simbind Architect requires Python 3.10+ and Simulink Exporter needs Python 3.9, 3.10 or 3.11.
• From Matlab side you need Simulink suite with Embedded Coder.
• You also need pip, gcc, cmake, make and swig. Under Debian-based distros you can install it with

  sudo apt-get install python3-pip build-essential cmake swig
  

To run output model you need only Linux x86-64 machine and Python 3.8+. We're open to extending support to Linux ARM and Windows x86-64 if there's sufficient interest!

Installation

To install from PyPi run

$ pip install simbind 

To clone project you will also need to pull submodules with:

$ git clone --recurse-submodules https://github.com/swag-engineering/simbind-cli.git

Usage

Simbind CLI is a wrapper around Simulink Exporter and Simbind Architect projects and intended to be used as a standalone tool, not as an importable module. If you want to use its functionality programmatically, please refer to subprojects.

$ simbind --help
usage: simbind [-h] --slx-path SLX_PATH [--pkg-name PKG_NAME] [--wheel-out-dir WHEEL_OUT_DIR]
               [--solver {ode1,ode2,ode3,ode4,ode5,ode8,ode14x,ode1be}] [--step STEP_SIZE]
               [--license-text LICENSE_TEXT] [-v]

Tool to generate Python wheel package from Simulink model.

options:
  -h, --help            show this help message and exit
  --slx-path SLX_PATH   Path to Simulink .slx file.
  --pkg-name PKG_NAME   Name of the output Python package. (default: 'model')
  --wheel-out-dir WHEEL_OUT_DIR
                        Path to folder where wheel package will be stored. (default: '.')
  --solver {ode1,ode2,ode3,ode4,ode5,ode8,ode14x,ode1be}
                        Fixed-step solver. (default: 'ode5')
  --step STEP_SIZE      Fixed step size in seconds. (default: '0.001')
  --license-text LICENSE_TEXT
                        License text that will be included in output Python wheel package. (default: '')
  -v                    Specifies the level of verbosity. Example: -vvv

For detailed instructions on the structure of the output Python package, please refer to our Wiki.

Issues

If you run into any issues or believe additional functionality is needed, please don't hesitate to open an issue or email us at [e-mail]. We're always ready to assist!