BondGraphTools¶
Overview¶
BondGraphTools is a python library for systems modelling based on the bond graph methodology [Gaw1996], [Gaw2007].
- BondGraphTools is intended to be used by
software developers; as a framework to build modelling interfaces on top of
engineers; to quickly build and simulate physical systems
mathematicians; to perform model reduction and analysis
BondGraphTools is built upon the scientific python stack; numpy, scipy, sympy, scikit.odes and matplotlib
How to read the docs¶
- The documentation for this library is organised into the following sections.
This page show how to install BondGraphTools
Tutorials contains a list of step-by-step tutorials demonstrating how to use BondGraphTools.
Discussion contains high level discussion about to library.
API Reference is the library reference documentation.
Getting Started¶
Requirements¶
Python 3.7 or above.
Installation¶
Install Python 3.7 or greater.
Install Sundials and
scikits.odes[dependencies](https://scikits-odes.readthedocs.io/en/stable/installation.html)Install BondGraphTools via pip:
pip install BondGraphTools
Usage¶
BondGraphTools can be loaded inside a jupyter-notebook, python interpreter, or script by using:
import BondGraphTools
Api reference for the package and it’s contents can be accessed using the help command:
help(BondGraphTools)
Contributing¶
The best way to contribute right now is to use it! If you wish to help out, please visit the project github.