<div align="center">
<img src="resources/nodedge_logo.png" alt="drawing" width="150"/>
Nodedge
=======
A Python3 graphic environment for next-generation engineering.
<a href="www.nodedge.io">Nodedge.io</a>
</div>
[](https://badge.fury.io/py/nodedge)
[](https://badge.fury.io/py/nodedge)
[](https://choosealicense.com/licenses/gpl-3.0/)
[](https://github.com/nodedge/nodedge/actions/workflows/python-test.yml)
[](https://codecov.io/gh/nodedge/nodedge)
[](https://nodedge.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/psf/black)
[](https:github.com/nodedge/nodedge/actions/workflows/code-scanning.yml)
# What is Nodedge?
<div>
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.
</div>
<br>
<center><img src="docs/media/concept/nodedge_apps.png" alt="nodedge" width="800" /></center>
<br>
# Installation
You can install Nodedge in different ways.
**Download the installer**
* Windows: [download latest release](https://github.com/nodedge/nodedge/releases/download/v0.4/NodedgeSetup.exe)
* 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](https://github.com/nodedge/nodedge) 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](https://github.com/nodedge/nodedge/tree/main/examples)
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.
<br>
<center><img src="docs/media/nodedge/gravitational_force_example.png" alt="gravitational_force_example" width="800" /></center>
## 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!
<br>
<center><img src="docs/media/nodedge/csv_analyzer_example.png" alt="csv_analyzer_example" width="800" /></center>
# 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:
* Donate to keep Nodedge core free and open-source, provide support for current features and implement new ones
* [Submit your feedback](mailto:admin@nodedge.io). Share your goals and tell us how Nodedge can help
* [Share example files](mailto:admin@nodedge.io)
* Report bugs on [Nodedge issue tracker](https://github.com/nodedge/nodedge/issues)
* Fix bugs and write documentation. To start contributing to Nodedge, you can check out the [guidelines for contributors](https://github.com/nodedge/nodedge/wiki)
For developing Nodedge, we recommend using PyCharm IDE.
You can find helpful information on how to install and set it up on [Nodedge Wiki](https://github.com/nodedge/nodedge/wiki/Pycharm-setup) and [PyCharm website](https://www.jetbrains.com/pycharm/).
History
=======
0.1.0 (2019-12-12)
------------------
- First release as a library
0.2.0 (2020-01-06)
------------------
- First implementation of calculator functions
0.2.1 (2020-03-22)
------------------
- Cleaning and add documentation
0.2.2 (2020-08-02)
------------------
- Improve style.
- Add history dock widget.
- Add scene items dock widget.
- Fix crash after edge deletion.
0.2.3 (2020-11-29)
------------------
- Add embedded python console.
- Add scene code generation.
- Add more mathematical blocks.
- Refine style and node displacement.
- Add item details widget.
0.3.0 (2022-11-09)
------------------
- Add support for numpy operations.
- Add comment element.
- Add dats, a log analyser.
Raw data
{
"_id": null,
"home_page": "https://www.nodedge.io",
"name": "nodedge",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "nodedge,editor,graphical-programming,simulation,physical-modeling,control-systems,dynamic-systems,python3,qt5,pyside6,platform-indenpendent,windows,linux,macos",
"author": "Anthony De Bortoli",
"author_email": "anthony.debortoli@nodedge.io",
"download_url": "https://files.pythonhosted.org/packages/6d/7f/84c30e951c6d9af99a1212d26ccf7672e2e20412e8d9d83fa4900b83a93f/nodedge-0.5.0.tar.gz",
"platform": "Windows",
"description": "<div align=\"center\">\n<img src=\"resources/nodedge_logo.png\" alt=\"drawing\" width=\"150\"/>\n\nNodedge\n=======\nA Python3 graphic environment for next-generation engineering.\n\n<a href=\"www.nodedge.io\">Nodedge.io</a>\n</div>\n\n\n[](https://badge.fury.io/py/nodedge)\n[](https://badge.fury.io/py/nodedge)\n[](https://choosealicense.com/licenses/gpl-3.0/)\n[](https://github.com/nodedge/nodedge/actions/workflows/python-test.yml)\n[](https://codecov.io/gh/nodedge/nodedge)\n[](https://nodedge.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/psf/black)\n[](https:github.com/nodedge/nodedge/actions/workflows/code-scanning.yml)\n\n\n# What is Nodedge?\n\n<div>\n\nNodedge is the first open-source Python editor for scientific and engineering applications. \nIt provides a comprehensive graphic environment for \naccelerating the design, simulation, analysis, and deployment of complex scientific and engineering systems.\nWith Nodedge, you can:\n* design and **simulate dynamical systems** such as robotic, physical, and chemical systems\n* **generate Python code** from your graphic models with a simple click\n* interactively plot and edit the data generated by your simulation\n* **plot and analyze log files** with common extensions like csv, mf4, mat, and others.\n\n</div>\n<br>\n\n<center><img src=\"docs/media/concept/nodedge_apps.png\" alt=\"nodedge\" width=\"800\" /></center>\n<br>\n\n# Installation\n\nYou can install Nodedge in different ways.\n\n**Download the installer**\n\n* Windows: [download latest release](https://github.com/nodedge/nodedge/releases/download/v0.4/NodedgeSetup.exe)\n* macOS: please bear with us, we are currently in the process of developing it!\n* Linux: please bear with us, we are currently in the process of developing it!\n\n\n**Install from pip**\n\nAlternatively, you can install Nodedge form pip with:\n```\npip install nodedge\n```\n\n**Clone from GitHub**\n\nAlternatively, you can clone our project from [Github](https://github.com/nodedge/nodedge) and install the requirements with:\n```\ngit clone https://github.com/nodedge/nodedge nodedge\ncd nodedge\npip install -r .\\requirements\\freeze\\requirements_dev.txt\n```\n\n# Quick start examples\n\nThe list of examples is constantly expanding. You can find an up-to-date list in the [*examples* folder](https://github.com/nodedge/nodedge/tree/main/examples) \non GitHub.\nThe examples provided below will allow you to get started with Nodedge.\n\n## Create a model in Nodedge\n\nIn this example, we demonstrate how to create a model in Nodedge to calculate the gravitational force between two objects:\n1. In Nodedge, create a new file by clicking on `File` > `New`\n2. Add input nodes to your model to represent the constant variables of the gravitational force. \nFrom the *Node libraries* widget on the right, drag-and-drop `Input` nodes to the scene and insert the constant values in their labels\n3. Rename the input nodes by editing their title in the *Node details* widget on the right\n4. From the `Operator` library, drag-and-drop `Multiplication`, `Division`, and `Power` nodes to the scene and connect them to the input nodes\n5. Connect an output node to display the result of the computation.\n\nCongratulations! You have just created your first Nodedge model!\nIf you want to compute the gravitational force for different objects, simply edit the mass values in the input nodes.\nNodedge will instantly re-evaluate the model and display the updated result.\n\n<br>\n \n<center><img src=\"docs/media/nodedge/gravitational_force_example.png\" alt=\"gravitational_force_example\" width=\"800\" /></center>\n\n## Open a dataset in Dats\n\nIn this example, we show you how to import a dataset into Dats, plot the signals contained within it, and add new ones:\n1. Open Dats by clicking on its icon in the home page\n2. Click on `File` > `Open` then navigate to the example file `examples/csv_analyzer/reinforcement_learning_data.csv`\n3. Click on `Open`\n4. From the *Variables* widget on the left, select `init_x` and `target_x` by clicking on their labels\n5. Plot the curves by: \n * clicking on the `Plot` button, or\n * drag-and-dropping the signals to the worksheet\n6. Right-click on the worksheet window, then click on `Add subplot`\n7. Plot the `init_y` and `target_y` signals as done at step 5\n8. To save the current Dats configuration, click on `File` > `Save configuration`, then navigate to the folder where you want to save the configuration file\nand enter a file name like `csv_analyzer_config.json`. Click on `Save`\n\nCongratulations! You have successfully analyzed your first dataset in Dats!\n\n<br>\n\n<center><img src=\"docs/media/nodedge/csv_analyzer_example.png\" alt=\"csv_analyzer_example\" width=\"800\" /></center>\n\n# Roadmap\n\nNodedge development team has a lot of exciting features planned for the future! \nThe project is actively being developed and there are plans to add support for a wide range of features.\nIf you wish to join our efforts, do not hesitate to contact us. Any help is welcome!\n\nOur roadmap includes, and is not limited to:\n* In Dats, extend support to other file formats, including **hdf**, **rosag**, etc.\n* 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 \nthat runs within the current Nodedge model. The custom node can be saved to the nodes library and reused it in the future\n* In Nodedge, add support for the **simulation** of dynamic systems. In particular, add a widget for the selection of a solver \nand its configuration, as well as start/pause/stop buttons and others\n* In Nodedge and Dats, add support for robotics-specific features, such as **embedded code generation** for common hardware platform, \nreal-time data acquisition and inspection\n\n# Contributing\n\nYou can contribute to Nodedge in several ways: \n* Donate to keep Nodedge core free and open-source, provide support for current features and implement new ones\n* [Submit your feedback](mailto:admin@nodedge.io). Share your goals and tell us how Nodedge can help\n* [Share example files](mailto:admin@nodedge.io)\n* Report bugs on [Nodedge issue tracker](https://github.com/nodedge/nodedge/issues)\n* Fix bugs and write documentation. To start contributing to Nodedge, you can check out the [guidelines for contributors](https://github.com/nodedge/nodedge/wiki)\n\nFor developing Nodedge, we recommend using PyCharm IDE. \nYou can find helpful information on how to install and set it up on [Nodedge Wiki](https://github.com/nodedge/nodedge/wiki/Pycharm-setup) and [PyCharm website](https://www.jetbrains.com/pycharm/).\n\n\nHistory\n=======\n\n0.1.0 (2019-12-12)\n------------------\n\n- First release as a library\n\n0.2.0 (2020-01-06)\n------------------\n\n- First implementation of calculator functions\n\n0.2.1 (2020-03-22)\n------------------\n\n- Cleaning and add documentation\n\n0.2.2 (2020-08-02)\n------------------\n\n- Improve style.\n- Add history dock widget.\n- Add scene items dock widget.\n- Fix crash after edge deletion.\n\n0.2.3 (2020-11-29)\n------------------\n\n- Add embedded python console.\n- Add scene code generation.\n- Add more mathematical blocks.\n- Refine style and node displacement.\n- Add item details widget.\n\n0.3.0 (2022-11-09)\n------------------\n\n- Add support for numpy operations.\n- Add comment element.\n- Add dats, a log analyser.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Graphical editor for physical modeling and simulation.",
"version": "0.5.0",
"split_keywords": [
"nodedge",
"editor",
"graphical-programming",
"simulation",
"physical-modeling",
"control-systems",
"dynamic-systems",
"python3",
"qt5",
"pyside6",
"platform-indenpendent",
"windows",
"linux",
"macos"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7c9d73bf8b7b9e094fa2d51428efd113bb288fa0d65e5a89c83faa26fcccdf57",
"md5": "bc9b3ecdc96b4d5cdb4fc151ffed0121",
"sha256": "3efcb674b6996c746e6cf4756a27610e5f20683cdf55916bb5b230808a74d80c"
},
"downloads": -1,
"filename": "nodedge-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bc9b3ecdc96b4d5cdb4fc151ffed0121",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 224146,
"upload_time": "2023-01-26T22:29:27",
"upload_time_iso_8601": "2023-01-26T22:29:27.525266Z",
"url": "https://files.pythonhosted.org/packages/7c/9d/73bf8b7b9e094fa2d51428efd113bb288fa0d65e5a89c83faa26fcccdf57/nodedge-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6d7f84c30e951c6d9af99a1212d26ccf7672e2e20412e8d9d83fa4900b83a93f",
"md5": "bbf37c6ccfa3bf7eef22294c77560509",
"sha256": "9993f3eda84853a54b758a35f58af087d51ab0b63954e1d3839732720f061378"
},
"downloads": -1,
"filename": "nodedge-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "bbf37c6ccfa3bf7eef22294c77560509",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 48103993,
"upload_time": "2023-01-26T22:29:31",
"upload_time_iso_8601": "2023-01-26T22:29:31.149748Z",
"url": "https://files.pythonhosted.org/packages/6d/7f/84c30e951c6d9af99a1212d26ccf7672e2e20412e8d9d83fa4900b83a93f/nodedge-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-26 22:29:31",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "nodedge"
}
JSON