# FONSim
[](https://badge.fury.io/py/fonsim)
[](https://fonsim.readthedocs.io/en/latest/?badge=latest)
[](https://doi.org/10.1109/RoboSoft55895.2023.10122049)
#### _Fluidic Object-oriented Network SIMulator_
An object-oriented Python 3 package
designed for simulating pneumatic and hydraulic systems in soft robots.
It is being developed at the [KU Leuven soft robotics group](
https://softroboticsgroup.com).
Full documentation: [fonsim.org](http://fonsim.org/).
This project is available under the GNU Affero General Public License v3.0 (**agpl-3.0**) license.
### Installation
The pre-packaged release version can be installed using `pip install fonsim`.
See the [PyPI page](https://pypi.org/project/fonsim/) for more information.
Currently, FONSim resides in the beta stage.
Some features do not work well yet, or are unintuitive to use correctly,
and you may encounter bugs.
We look forward to your feedback.
### How to get started
The [examples directory](
https://gitlab.com/abaeyens/fonsim/-/tree/master/examples)
contains a set of examples showcasing various features of the simulator.
We suggest to start with running the examples.
Furthermore you may want to consult the documentation on
[readthedocs.io](https://fonsim.readthedocs.io/).
The code documentation is also available by the
[Python help function](https://www.programiz.com/python-programming/docstrings#help).
If something is not fully clear, please let us know.
### Key dependencies
* matplotlib
* numpy
* scipy
## Project development, contribution
### Contributing
Are you interested in contributing to this project?
Please get in touch so we can coordinate the development!
### Contributors
Core developers:
Arne Baeyens
Bert Van Raemdonck
As well as many thanks to:
Edoardo Milana
Benjamin Gorissen
## Problems, questions, suggestions
If you have a question the FAQ section does not answer sufficiently,
or you think you have encountered a bug,
you can reach out by creating an issue on the
[GitLab Issues](https://gitlab.com/abaeyens/fonsim/-/issues) page.
The issues page is also the proper place to post suggestions and feedback.
## FAQ
Please refer to the documentation on
[readthedocs.io](https://fonsim.readthedocs.io/).
Raw data
{
"_id": null,
"home_page": "http://fonsim.org",
"name": "fonsim",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "simulator,simulation,flow,fluids,fluidic,soft robot,soro,soft robotics,soft robots",
"author": "Arne Baeyens, Bert Van Raemdonck",
"author_email": "info@fonsim.org",
"download_url": "https://files.pythonhosted.org/packages/0c/e2/2bf824a4dcc7e3ec5d61701cdaa729226af2e3ef11385785352a9349c654/fonsim-0.4.2.tar.gz",
"platform": null,
"description": "# FONSim\n[](https://badge.fury.io/py/fonsim)\n[](https://fonsim.readthedocs.io/en/latest/?badge=latest)\n\n[](https://doi.org/10.1109/RoboSoft55895.2023.10122049)\n#### _Fluidic Object-oriented Network SIMulator_\n\nAn object-oriented Python 3 package\ndesigned for simulating pneumatic and hydraulic systems in soft robots.\nIt is being developed at the [KU Leuven soft robotics group](\n https://softroboticsgroup.com).\nFull documentation: [fonsim.org](http://fonsim.org/).\n\nThis project is available under the GNU Affero General Public License v3.0 (**agpl-3.0**) license.\n\n### Installation\nThe pre-packaged release version can be installed using `pip install fonsim`.\nSee the [PyPI page](https://pypi.org/project/fonsim/) for more information.\n\nCurrently, FONSim resides in the beta stage.\nSome features do not work well yet, or are unintuitive to use correctly,\nand you may encounter bugs.\nWe look forward to your feedback.\n\n\n### How to get started\nThe [examples directory](\n https://gitlab.com/abaeyens/fonsim/-/tree/master/examples)\ncontains a set of examples showcasing various features of the simulator.\nWe suggest to start with running the examples.\nFurthermore you may want to consult the documentation on\n[readthedocs.io](https://fonsim.readthedocs.io/).\nThe code documentation is also available by the\n[Python help function](https://www.programiz.com/python-programming/docstrings#help).\nIf something is not fully clear, please let us know.\n\n### Key dependencies\n* matplotlib\n* numpy\n* scipy\n\n\n## Project development, contribution\n\n### Contributing\nAre you interested in contributing to this project?\nPlease get in touch so we can coordinate the development!\n\n### Contributors\nCore developers: \nArne Baeyens \nBert Van Raemdonck \n\nAs well as many thanks to: \nEdoardo Milana \nBenjamin Gorissen \n\n\n## Problems, questions, suggestions\nIf you have a question the FAQ section does not answer sufficiently,\nor you think you have encountered a bug,\nyou can reach out by creating an issue on the\n[GitLab Issues](https://gitlab.com/abaeyens/fonsim/-/issues) page.\nThe issues page is also the proper place to post suggestions and feedback.\n\n\n## FAQ\nPlease refer to the documentation on \n[readthedocs.io](https://fonsim.readthedocs.io/).\n",
"bugtrack_url": null,
"license": "AGPLv3",
"summary": "Fluidic Object-Oriented Network Simulator",
"version": "0.4.2",
"project_urls": {
"Homepage": "http://fonsim.org"
},
"split_keywords": [
"simulator",
"simulation",
"flow",
"fluids",
"fluidic",
"soft robot",
"soro",
"soft robotics",
"soft robots"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f6034ad9f73dcfe6bab47ad08b8508c6c829670c721875af72bd6d7771a7c52a",
"md5": "5990641903ffabfc96aae77164322778",
"sha256": "a21453fe5b2aae5ca5ca4883dd1de794b466ce166ee8dda579868672e995e81d"
},
"downloads": -1,
"filename": "fonsim-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5990641903ffabfc96aae77164322778",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 76961,
"upload_time": "2023-12-12T20:21:46",
"upload_time_iso_8601": "2023-12-12T20:21:46.359011Z",
"url": "https://files.pythonhosted.org/packages/f6/03/4ad9f73dcfe6bab47ad08b8508c6c829670c721875af72bd6d7771a7c52a/fonsim-0.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0ce22bf824a4dcc7e3ec5d61701cdaa729226af2e3ef11385785352a9349c654",
"md5": "af9ad9754352a8c4d5463cba49512cd0",
"sha256": "7cc0e2a103e1983b1527d2391a1d1c87e937ba7a7d4bb71ad9201fccef411c61"
},
"downloads": -1,
"filename": "fonsim-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "af9ad9754352a8c4d5463cba49512cd0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 72087,
"upload_time": "2023-12-12T20:21:48",
"upload_time_iso_8601": "2023-12-12T20:21:48.412021Z",
"url": "https://files.pythonhosted.org/packages/0c/e2/2bf824a4dcc7e3ec5d61701cdaa729226af2e3ef11385785352a9349c654/fonsim-0.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-12 20:21:48",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "fonsim"
}
JSON