pyBondGraph 0.1.0__tar.gz

pybondgraph-0.1.0/LICENSE

@@ -0,0 +1 @@
+This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.  To view a copy of this license, visit https://creativecommons.org/licenses/by-nc-sa/4.0/

pybondgraph-0.1.0/PKG-INFO

@@ -0,0 +1,170 @@
+Metadata-Version: 2.4
+Name: pyBondGraph
+Version: 0.1.0
+Summary: Modelling tool for linear bond graph systems in Python
+Author-email: Matthias Panny <matthias.panny@mci.edu>
+License-Expression: CC-BY-NC-SA-4.0
+Project-URL: Homepage, https://github.com/MrP123/pyBondGraph
+Project-URL: Issues, https://github.com/MrP123/pyBondGraph/issues
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering
+Classifier: Development Status :: 3 - Alpha
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sympy>=1.14.0
+Requires-Dist: networkx>=3.5
+Requires-Dist: numpy>=2.3.0
+Requires-Dist: matplotlib>=3.10.3
+Requires-Dist: control>=0.10.2
+Provides-Extra: streamlit
+Requires-Dist: streamlit>=1.47.0; extra == "streamlit"
+Requires-Dist: streamlit-flow-component>=1.6.1; extra == "streamlit"
+Dynamic: license-file
+
+# pyBondGraph
+**pyBondGraph** is a Python library for **modeling and analyzing linear bond graph systems** using symbolic computation.
+
+The library allows users to construct bond graph models programmatically, automatically derive the governing equations, and analyze the resulting dynamic systems using tools from control theory.
+
+Bond graphs provide a **domain-independent modeling framework** for physical systems. Using a unified representation of power exchange, the same modeling approach can be used for electrical, mechanical, hydraulic, and multi-domain systems.
+
+---
+
+# Features
+
+* Programmatic construction of **bond graph models**
+* Automatic **symbolic equation derivation** using SymPy
+* Conversion of models to **state-space systems**
+* Example models for electrical and mechanical systems
+
+---
+
+# Installation
+
+## Install directly from GitHub
+The easiest way to install the library is directly via pip:
+```bash
+pip install git+https://github.com/MrP123/pyBondGraph.git
+```
+This installs the latest version of the package from the repository.
+
+---
+
+## Development installation
+To work with the source code:
+```bash
+git clone https://github.com/MrP123/pyBondGraph.git
+cd pyBondGraph
+pip install -e .
+```
+
+---
+
+# Dependencies
+
+The main dependencies are:
+
+* `sympy`
+* `numpy`
+* `networkx`
+* `matplotlib`
+* `control` only needed for the examples
+
+Optional dependencies are used for experimental visualization tools.
+
+---
+
+# Basic Usage
+A bond graph model is constructed by creating elements and connecting them via bonds.
+
+Simple RC-Filter circuit:
+
+```python
+from pyBondGraph import BondGraph, SourceEffort, Resistor, Capacitor, OneJunction, Bond, Causality
+
+bg = BondGraph()
+
+# create elements
+voltage_source = SourceEffort("U", "u_in")
+resistor = Resistor("R", "R")
+capacitor = Capacitor("C", "C")
+series_junction = OneJunction("J1")
+
+# connect elements
+# causalities need to be assigned manually 
+bg.add_bond(Bond(voltage_source, series_junction, Causality.EFFORT_OUT))
+bg.add_bond(Bond(series_junction, resistor, Causality.EFFORT_OUT))
+bg.add_bond(Bond(series_junction, capacitor, Causality.FLOW_OUT))
+
+# plot the resulting BondGraph
+bg.plot()
+
+# derive system equations in linear state space form
+A, B, C, D, x, n_states, n_inputs, n_outputs = bond_graph.get_state_space()
+```
+
+The library automatically derives the **symbolic system equations** describing the dynamics of the model.
+
+---
+
+
+# Core Concepts
+Bond graphs represent **power exchange between system components**, where power is the product of **effort** and **flow** associated with the following components:
+
+## Elements
+| Element | Meaning                                  |
+|---------|------------------------------------------|
+| R       | Dissipation                              |
+| C       | Energy storage (compliance, capacitance) |
+| I       | Energy storage (inertia, inductance)     |
+| Se      | Effort source                            |
+| Sf      | Flow source                              |
+
+## Junctions
+| Junction | Meaning       |
+|----------|---------------|
+|     0    | Common effort |
+|     1    | Common flow   |
+
+## Sensors
+| Sensor                 | Meaning                                     |
+|------------------------|---------------------------------------------|
+| IntegratedEffortSensor | Measures integral of the effort at its bond |
+| IntegratedFlowSensor   | Measures integral of the flow at its bond   |
+
+In mechanical bond graph models:
+* **flow** corresponds to **velocity**
+* **effort** corresponds to **force**
+
+An **integrated flow sensor** can therefore be used to compute **position**:
+
+---
+
+# Example Systems
+The repository contains example models illustrating typical applications of bond graphs.
+
+### RLC Circuit
+Demonstrates modeling of an electrical circuit using bond graph elements.
+
+### DC Motor
+A multi-domain electromechanical system coupling electrical and mechanical dynamics.
+
+### Transformer
+Example of energy transformation between two ports.
+
+### Two DOF Mass–Spring–Damper System
+Classical mass-spring-damper system with two degrees of freedom.
+
+---
+
+# Typical Applications
+Bond graph modeling is particularly useful for:
+
+* electromechanical systems
+* robotics and mechatronics
+* multi-domain energy systems
+* control system modeling
+* teaching system dynamics

pybondgraph-0.1.0/README.md

@@ -0,0 +1,144 @@
+# pyBondGraph
+**pyBondGraph** is a Python library for **modeling and analyzing linear bond graph systems** using symbolic computation.
+
+The library allows users to construct bond graph models programmatically, automatically derive the governing equations, and analyze the resulting dynamic systems using tools from control theory.
+
+Bond graphs provide a **domain-independent modeling framework** for physical systems. Using a unified representation of power exchange, the same modeling approach can be used for electrical, mechanical, hydraulic, and multi-domain systems.
+
+---
+
+# Features
+
+* Programmatic construction of **bond graph models**
+* Automatic **symbolic equation derivation** using SymPy
+* Conversion of models to **state-space systems**
+* Example models for electrical and mechanical systems
+
+---
+
+# Installation
+
+## Install directly from GitHub
+The easiest way to install the library is directly via pip:
+```bash
+pip install git+https://github.com/MrP123/pyBondGraph.git
+```
+This installs the latest version of the package from the repository.
+
+---
+
+## Development installation
+To work with the source code:
+```bash
+git clone https://github.com/MrP123/pyBondGraph.git
+cd pyBondGraph
+pip install -e .
+```
+
+---
+
+# Dependencies
+
+The main dependencies are:
+
+* `sympy`
+* `numpy`
+* `networkx`
+* `matplotlib`
+* `control` only needed for the examples
+
+Optional dependencies are used for experimental visualization tools.
+
+---
+
+# Basic Usage
+A bond graph model is constructed by creating elements and connecting them via bonds.
+
+Simple RC-Filter circuit:
+
+```python
+from pyBondGraph import BondGraph, SourceEffort, Resistor, Capacitor, OneJunction, Bond, Causality
+
+bg = BondGraph()
+
+# create elements
+voltage_source = SourceEffort("U", "u_in")
+resistor = Resistor("R", "R")
+capacitor = Capacitor("C", "C")
+series_junction = OneJunction("J1")
+
+# connect elements
+# causalities need to be assigned manually 
+bg.add_bond(Bond(voltage_source, series_junction, Causality.EFFORT_OUT))
+bg.add_bond(Bond(series_junction, resistor, Causality.EFFORT_OUT))
+bg.add_bond(Bond(series_junction, capacitor, Causality.FLOW_OUT))
+
+# plot the resulting BondGraph
+bg.plot()
+
+# derive system equations in linear state space form
+A, B, C, D, x, n_states, n_inputs, n_outputs = bond_graph.get_state_space()
+```
+
+The library automatically derives the **symbolic system equations** describing the dynamics of the model.
+
+---
+
+
+# Core Concepts
+Bond graphs represent **power exchange between system components**, where power is the product of **effort** and **flow** associated with the following components:
+
+## Elements
+| Element | Meaning                                  |
+|---------|------------------------------------------|
+| R       | Dissipation                              |
+| C       | Energy storage (compliance, capacitance) |
+| I       | Energy storage (inertia, inductance)     |
+| Se      | Effort source                            |
+| Sf      | Flow source                              |
+
+## Junctions
+| Junction | Meaning       |
+|----------|---------------|
+|     0    | Common effort |
+|     1    | Common flow   |
+
+## Sensors
+| Sensor                 | Meaning                                     |
+|------------------------|---------------------------------------------|
+| IntegratedEffortSensor | Measures integral of the effort at its bond |
+| IntegratedFlowSensor   | Measures integral of the flow at its bond   |
+
+In mechanical bond graph models:
+* **flow** corresponds to **velocity**
+* **effort** corresponds to **force**
+
+An **integrated flow sensor** can therefore be used to compute **position**:
+
+---
+
+# Example Systems
+The repository contains example models illustrating typical applications of bond graphs.
+
+### RLC Circuit
+Demonstrates modeling of an electrical circuit using bond graph elements.
+
+### DC Motor
+A multi-domain electromechanical system coupling electrical and mechanical dynamics.
+
+### Transformer
+Example of energy transformation between two ports.
+
+### Two DOF Mass–Spring–Damper System
+Classical mass-spring-damper system with two degrees of freedom.
+
+---
+
+# Typical Applications
+Bond graph modeling is particularly useful for:
+
+* electromechanical systems
+* robotics and mechatronics
+* multi-domain energy systems
+* control system modeling
+* teaching system dynamics

pybondgraph-0.1.0/pyBondGraph/__init__.py

@@ -0,0 +1,38 @@
+from .core import Bond, Causality
+from .elements import (
+    SourceEffort,
+    SourceFlow,
+    OneJunction,
+    ZeroJunction,
+    Capacitor,
+    Compliance,
+    Inductor,
+    Inertance,
+    Resistor,
+    Resistance,
+    Transformer,
+    Gyrator,
+)
+from .sensors import IntegratedEffortSensor, IntegratedFlowSensor
+
+from .bondgraph import BondGraph
+
+__all__ = [
+    "Bond",
+    "Causality",
+    "SourceEffort",
+    "SourceFlow",
+    "OneJunction",
+    "ZeroJunction",
+    "Capacitor",
+    "Compliance",
+    "Inductor",
+    "Inertance",
+    "Resistor",
+    "Resistance",
+    "Transformer",
+    "Gyrator",
+    "BondGraph",
+    "IntegratedEffortSensor",
+    "IntegratedFlowSensor",
+]