MuPhyN - Multi Physical Nexus

MatLab/Simulink is a very powerful tool that allows engineers to simulate complex multi-physical systems. Free and open-source tools exist such as Scilab + Xcos or Octave that tries to be compatible with MatLab/Simulink, but the approach of MuPhyN is to replicate the power and ease of use of the MatLab/Simulink combination by using (i)Python instead of MatLab combined with the MuPhyN graphical interface instead of Simulink.

Free libraries such as scipy and numpy offer numerical tools that can replicate most of MatLab toolboxes, and implementing them into new boxes in MuPhyN is trivial thanks to easily expandable libraries of boxes.

It is based on a PySide6 Qt interface and uses a simulator core, MuPhyN is fully written in Python and uses YAML as the descriptive language. The library feature allows users to easily add as many boxes and schedulers as they want.

Summary

• MuPhyN - Multi Physical Nexus
  • Summary
• Install
  • Stable version (PIP)
  • Running in standalone mode
• Usage
  • Create a new simulation
  • Build simulation model
  • Running the simulation
  • Select libraries
• Development
  • Current Features
  • Feature perspectives
  • TODO
  • Known bugs
• Publications
  • FOSDEM 2023
• Development repository

Install

Stable version (PIP)

The stable version of MuPhyN is available with pip.

Install using pip:

pip install muphyn

Running in standalone mode

Launch the software:

python3 -m muphyn

Usage

Create a new simulation

To create a new simulation, you can use the "File > New > Simulation" menu.

You can close the current simulation by using the "File > Close" menu or "Ctrl + W".

You can also use the "File > Open" menu or "Ctrl + O" to open an existing simulation and the "File > Save" menu or "Ctrl + S" to save the current simulation.

{width=814 height=600}

Build simulation model

You can easily drag / drop elements from the library. Once dropped, you can link the inputs and the outputs of the box. You can also edit the properties of the boxes in order to change their behaviors. Once everything is set up, you only need to press the F5 key or click on the "Simulation > Start simulation" menu.

{width=814 height=600}

Running the simulation

Use the simulation toolbar to start or stop the simulation. You can also use the "Simulation" menu or F5 and F6 keys to do the same actions.

Select libraries

Use the View > Libraries sub menus to add the libraries.

Development

Current Features

• Fixed-step simulation
• Basic boxes : Addition, Amplifier, Constant, Derivate, Graph, Integrator, Multiplier, Ramp, Sine, Square, Step
• Schedulers : Default
• Transfer Function box using scipy ODE solver
• Libraries management for both the boxes and the schedulers
• Draggable and droppable element from the library
• Properties panel for the dragged boxes
• Draggable links between the inputs and outputs of boxes

Feature perspectives

MuPhyn should be capable of running into an iPython interactive shell while having access to the namespace of the shell. This means that python code could be run in the shell to dynamically generate parameters that can be directly used into the MuPhyN model of the simulated system.

MuPhyN is also intended to be expandable to other simulation tools. A connection to OpenModelica is being developed to simulate different kinds of systems with lumped elements. Connection to open source finite element analysis softwares such as FEATools or field solver tools like openEMS or FEMM are also considered.

TODO

Known bugs

• Slowdown of the interface when using a lot of boxes
• Bug in the inputs panel in box parameters sideview (requires to increase side panel width to see the inputs)

Publications

FOSDEM 2023

FOSDEM is an European event centered on free and open-source software development.

The project has been introduced with a presentation on 4th March 2023. The presentation can be watched with the following link:

MuPhyN project at FOSDEM 2023

Development repository

See the MuPhyN Desktop Development repository to efficiently develop for MuPhyN Desktop.