Skip to main content

Generate Python wheel package from Simulink model!

Project description

Simbind CLI

Generate Python Wheel package from Simulink model! Please refer to Wiki and Examples to explore the project's capabilities and limitations.

Single Loop Feedback

Requirements

To use the tool you need:

  • Linux x86-64 machine with installed Matlab R2023b or older.
  • 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 Simulink 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

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 contact@swag-engineering.io. We're always ready to assist!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simbind-0.1.8.tar.gz (52.3 kB view hashes)

Uploaded Source

Built Distribution

simbind-0.1.8-py3-none-manylinux2010_x86_64.whl (49.9 kB view hashes)

Uploaded Python 3 manylinux: glibc 2.12+ x86-64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page