Metadata-Version: 2.1
Name: fonsim
Version: 0.3.0
Summary: Fluidic Object-Oriented Network Simulator
Home-page: https://fonsim.org
Author: Arne Baeyens, Bert Van Raemdonck
Author-email: info@fonsim.org
License: AGPLv3
Keywords: simulator,simulation,flow,fluids,fluidic,soft robot,soro,soft robotics,soft robots
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: stringunitconverter
Requires-Dist: importlib-resources

# FONSim
#### _Fluidic Object-oriented Network SIMulator_

An object-oriented Python 3 library designed for simulating pneumatic and hydraulic systems in soft robots.
Find the full documentation on [fonsim.org](https://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 alpha stage.
Not all features work yet, 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.org](https://fonsim.readthedocs.io/en/feature-doc/introduction.html).
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.org](https://fonsim.readthedocs.io/en/feature-doc/introduction.html).
