nodedge

Graphical editor for physical modeling and simulation.


Keywords
nodedge, editor, graphical-programming, simulation, physical-modeling, control-systems, dynamic-systems, python3, qt5, pyside6, platform-indenpendent, windows, linux, macos, automated-research, block-diagram, engineering, graphical-editor, physical-systems, qt6, robotics, visual-scripting
License
MIT
Install
pip install nodedge==0.2.3

Documentation

drawing

Nodedge

A Python3 graphic environment for next-generation engineering.

Nodedge.io

PyPI - Nodedge Version PyPI - Python Version License Test Status Test Coverage Documentation Status Code Style Code Scanning

What is Nodedge?

Nodedge is the first open-source Python editor for scientific and engineering applications. It provides a comprehensive graphic environment for accelerating the design, simulation, analysis, and deployment of complex scientific and engineering systems. With Nodedge, you can:

  • design and simulate dynamical systems such as robotic, physical, and chemical systems
  • generate Python code from your graphic models with a simple click
  • interactively plot and edit the data generated by your simulation
  • plot and analyze log files with common extensions like csv, mf4, mat, and others.

nodedge


Installation

You can install Nodedge in different ways.

Download the installer

  • Windows: download latest release
  • macOS: please bear with us, we are currently in the process of developing it!
  • Linux: please bear with us, we are currently in the process of developing it!

Install from pip

Alternatively, you can install Nodedge form pip with:

pip install nodedge

Clone from GitHub

Alternatively, you can clone our project from Github and install the requirements with:

git clone https://github.com/nodedge/nodedge nodedge
cd nodedge
pip install -r .\requirements\freeze\requirements_dev.txt

Quick start examples

The list of examples is constantly expanding. You can find an up-to-date list in the examples folder on GitHub. The examples provided below will allow you to get started with Nodedge.

Create a model in Nodedge

In this example, we demonstrate how to create a model in Nodedge to calculate the gravitational force between two objects:

  1. In Nodedge, create a new file by clicking on File > New
  2. Add input nodes to your model to represent the constant variables of the gravitational force. From the Node libraries widget on the right, drag-and-drop Input nodes to the scene and insert the constant values in their labels
  3. Rename the input nodes by editing their title in the Node details widget on the right
  4. From the Operator library, drag-and-drop Multiplication, Division, and Power nodes to the scene and connect them to the input nodes
  5. Connect an output node to display the result of the computation.

Congratulations! You have just created your first Nodedge model! If you want to compute the gravitational force for different objects, simply edit the mass values in the input nodes. Nodedge will instantly re-evaluate the model and display the updated result.


gravitational_force_example

Open a dataset in Dats

In this example, we show you how to import a dataset into Dats, plot the signals contained within it, and add new ones:

  1. Open Dats by clicking on its icon in the home page
  2. Click on File > Open then navigate to the example file examples/csv_analyzer/reinforcement_learning_data.csv
  3. Click on Open
  4. From the Variables widget on the left, select init_x and target_x by clicking on their labels
  5. Plot the curves by:
    • clicking on the Plot button, or
    • drag-and-dropping the signals to the worksheet
  6. Right-click on the worksheet window, then click on Add subplot
  7. Plot the init_y and target_y signals as done at step 5
  8. To save the current Dats configuration, click on File > Save configuration, then navigate to the folder where you want to save the configuration file and enter a file name like csv_analyzer_config.json. Click on Save

Congratulations! You have successfully analyzed your first dataset in Dats!


csv_analyzer_example

Roadmap

Nodedge development team has a lot of exciting features planned for the future! The project is actively being developed and there are plans to add support for a wide range of features. If you wish to join our efforts, do not hesitate to contact us. Any help is welcome!

Our roadmap includes, and is not limited to:

  • In Dats, extend support to other file formats, including hdf, rosag, etc.
  • In Nodedge, add support for saving and sharing Python custom nodes in a node library. In a custom node, the user can enter a custom piece of Python code that runs within the current Nodedge model. The custom node can be saved to the nodes library and reused it in the future
  • In Nodedge, add support for the simulation of dynamic systems. In particular, add a widget for the selection of a solver and its configuration, as well as start/pause/stop buttons and others
  • In Nodedge and Dats, add support for robotics-specific features, such as embedded code generation for common hardware platform, real-time data acquisition and inspection

Contributing

You can contribute to Nodedge in several ways:

For developing Nodedge, we recommend using PyCharm IDE. You can find helpful information on how to install and set it up on Nodedge Wiki and PyCharm website.