pySimBlocks 0.1.0__tar.gz → 0.1.1__tar.gz

{pysimblocks-0.1.0/pySimBlocks.egg-info → pysimblocks-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pySimBlocks
-Version: 0.1.0
+Version: 0.1.1
 Summary: A block-diagram simulation environment with PySide6 editor
 Author-email: Antoine Alessandrini <antoine.alessandrini@univ-lille.fr>
 License-Expression: LGPL-3.0-or-later
@@ -11,10 +11,6 @@ Keywords: simulation,block-diagram,control,discrete-time,pyside6
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Science/Research
 Classifier: Intended Audience :: Education
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Scientific/Engineering :: Visualization
 Requires-Python: >=3.10
@@ -28,6 +24,10 @@ Requires-Dist: typing_extensions; python_version < "3.11"
 Provides-Extra: examples
 Requires-Dist: control; extra == "examples"
 Requires-Dist: qpsolvers[clarabel,osqp]; extra == "examples"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
+Requires-Dist: furo; extra == "docs"
 Provides-Extra: tests
 Requires-Dist: pytest; extra == "tests"
 Requires-Dist: pytest-qt; extra == "tests"
@@ -35,45 +35,34 @@ Dynamic: license-file
 
 # pySimBlocks
 
+[![PyPI version](https://img.shields.io/pypi/v/pySimBlocks.svg)](https://pypi.org/project/pySimBlocks/)
+[![Python](https://img.shields.io/pypi/pyversions/pySimBlocks.svg)](https://pypi.org/project/pySimBlocks/)
+[![License](https://img.shields.io/github/license/AlessandriniAntoine/pySimBlocks)](./LICENSE.md)
+[![Documentation](https://readthedocs.org/projects/pysimblocks/badge/?version=latest)](https://pysimblocks.readthedocs.io)
+
+---
+
 A deterministic block-diagram simulation framework for discrete-time modeling, 
 co-simulation and research prototyping in Python.
 
-pySimBlocks allows you to build, configure, and execute discrete-time systems 
+pySimBlocks allows you to build, configure, and execute discrete-time systems
 using either:
 
 - A pure Python API
 - A graphical editor (PySide6)
-- YAML project configuration
+- YAML project configuration with exportable Python runner (`run.py`)
 - Optional SOFA and hardware integration
 
-![pySimBlocks graphical editor](https://raw.githubusercontent.com/AlessandriniAntoine/pySimBlocks/main/docs/User_Guide/images/gui_example.png)
-
-## Features
-
-- Block-based modeling (Simulink-like)
-- Deterministic discrete-time simulation engine
-- PySide6 graphical editor
-- YAML-based project serialization
-- Exportable Python runner (`run.py`)
-- Extensible block architecture
+![pySimBlocks graphical editor](https://raw.githubusercontent.com/AlessandriniAntoine/pySimBlocks/main/docs/source/images/user_guide/gui_example.png)
 
 ## Installation
 
-### From GitHub
-
-Install directly from GitHub using pip:
-```
-pip install git+https://github.com/AlessandriniAntoine/pySimBlocks
+```bash
+pip install pySimBlocks
 ```
 
-### Locally
-
-Clone the repository and install locally:
-```
-git clone https://github.com/AlessandriniAntoine/pySimBlocks.git
-cd pySimBlocks
-pip install .
-```
+Full documentation — user guide, tutorials, and API reference — is available on
+[**Read the Docs**](https://pysimblocks.readthedocs.io).
 
 ## Getting Started
 
@@ -125,7 +114,7 @@ plot_from_config(logs, plot_cfg)
 
 The resulting plot should look like this:
 
-![Noise filtered](https://raw.githubusercontent.com/AlessandriniAntoine/pySimBlocks/main/docs/User_Guide/images/quick_example.png)
+![Noise filtered](https://raw.githubusercontent.com/AlessandriniAntoine/pySimBlocks/main/docs/source/images/user_guide/quick_example.png)
 
 See [examples/quick_start/filter.py](./examples/quick_start/filter.py)
 to run the example yourself.
@@ -148,14 +137,14 @@ The quick-start GUI project is stored in a single
 
 #### Tutorials
 
-Three step-by-step tutorials are available detailed in the
-[guide](./docs/User_Guide/getting_started.md):
+Three step-by-step tutorials are available in the
+[documentation](https://pysimblocks.readthedocs.io/en/latest/user_guide/tutorials/index.html):
 
   | | Tutorial | Description |
   |---|---|---|
-  | 1 | [Python API](./docs/User_Guide/tutorial_1_python.md) | Build a closed-loop PI control system in pure Python |
-  | 2 | [GUI](./docs/User_Guide/tutorial_2_gui.md) | Build the same system visually with the graphical editor |
-  | 3 | [SOFA](./docs/User_Guide/tutorial_3_sofa.md) | Replace the plant with a SOFA physics simulation |
+  | 1 | [Python API](https://pysimblocks.readthedocs.io/en/latest/user_guide/tutorials/tutorial_1_python.html) | Build a closed-loop PI control system in pure Python |
+  | 2 | [GUI](https://pysimblocks.readthedocs.io/en/latest/user_guide/tutorials/tutorial_2_gui.html) | Build the same system visually with the graphical editor |
+  | 3 | [SOFA](https://pysimblocks.readthedocs.io/en/latest/user_guide/tutorials/tutorial_3_sofa.html) | Replace the plant with a SOFA physics simulation |
 
 
 #### Other Examples

{pysimblocks-0.1.0 → pysimblocks-0.1.1}/README.md

@@ -1,44 +1,33 @@
 # pySimBlocks
 
+[![PyPI version](https://img.shields.io/pypi/v/pySimBlocks.svg)](https://pypi.org/project/pySimBlocks/)
+[![Python](https://img.shields.io/pypi/pyversions/pySimBlocks.svg)](https://pypi.org/project/pySimBlocks/)
+[![License](https://img.shields.io/github/license/AlessandriniAntoine/pySimBlocks)](./LICENSE.md)
+[![Documentation](https://readthedocs.org/projects/pysimblocks/badge/?version=latest)](https://pysimblocks.readthedocs.io)
+
+---
+
 A deterministic block-diagram simulation framework for discrete-time modeling, 
 co-simulation and research prototyping in Python.
 
-pySimBlocks allows you to build, configure, and execute discrete-time systems 
+pySimBlocks allows you to build, configure, and execute discrete-time systems
 using either:
 
 - A pure Python API
 - A graphical editor (PySide6)
-- YAML project configuration
+- YAML project configuration with exportable Python runner (`run.py`)
 - Optional SOFA and hardware integration
 
-![pySimBlocks graphical editor](https://raw.githubusercontent.com/AlessandriniAntoine/pySimBlocks/main/docs/User_Guide/images/gui_example.png)
-
-## Features
-
-- Block-based modeling (Simulink-like)
-- Deterministic discrete-time simulation engine
-- PySide6 graphical editor
-- YAML-based project serialization
-- Exportable Python runner (`run.py`)
-- Extensible block architecture
+![pySimBlocks graphical editor](https://raw.githubusercontent.com/AlessandriniAntoine/pySimBlocks/main/docs/source/images/user_guide/gui_example.png)
 
 ## Installation
 
-### From GitHub
-
-Install directly from GitHub using pip:
-```
-pip install git+https://github.com/AlessandriniAntoine/pySimBlocks
+```bash
+pip install pySimBlocks
 ```
 
-### Locally
-
-Clone the repository and install locally:
-```
-git clone https://github.com/AlessandriniAntoine/pySimBlocks.git
-cd pySimBlocks
-pip install .
-```
+Full documentation — user guide, tutorials, and API reference — is available on
+[**Read the Docs**](https://pysimblocks.readthedocs.io).
 
 ## Getting Started
 
@@ -90,7 +79,7 @@ plot_from_config(logs, plot_cfg)
 
 The resulting plot should look like this:
 
-![Noise filtered](https://raw.githubusercontent.com/AlessandriniAntoine/pySimBlocks/main/docs/User_Guide/images/quick_example.png)
+![Noise filtered](https://raw.githubusercontent.com/AlessandriniAntoine/pySimBlocks/main/docs/source/images/user_guide/quick_example.png)
 
 See [examples/quick_start/filter.py](./examples/quick_start/filter.py)
 to run the example yourself.
@@ -113,14 +102,14 @@ The quick-start GUI project is stored in a single
 
 #### Tutorials
 
-Three step-by-step tutorials are available detailed in the
-[guide](./docs/User_Guide/getting_started.md):
+Three step-by-step tutorials are available in the
+[documentation](https://pysimblocks.readthedocs.io/en/latest/user_guide/tutorials/index.html):
 
   | | Tutorial | Description |
   |---|---|---|
-  | 1 | [Python API](./docs/User_Guide/tutorial_1_python.md) | Build a closed-loop PI control system in pure Python |
-  | 2 | [GUI](./docs/User_Guide/tutorial_2_gui.md) | Build the same system visually with the graphical editor |
-  | 3 | [SOFA](./docs/User_Guide/tutorial_3_sofa.md) | Replace the plant with a SOFA physics simulation |
+  | 1 | [Python API](https://pysimblocks.readthedocs.io/en/latest/user_guide/tutorials/tutorial_1_python.html) | Build a closed-loop PI control system in pure Python |
+  | 2 | [GUI](https://pysimblocks.readthedocs.io/en/latest/user_guide/tutorials/tutorial_2_gui.html) | Build the same system visually with the graphical editor |
+  | 3 | [SOFA](https://pysimblocks.readthedocs.io/en/latest/user_guide/tutorials/tutorial_3_sofa.html) | Replace the plant with a SOFA physics simulation |
 
 
 #### Other Examples

pysimblocks-0.1.1/docs/source/_ext/api_generator.py

@@ -0,0 +1,295 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+
+ROOT = Path(__file__).resolve().parents[3]
+SOURCE_DIR = ROOT / "docs" / "source"
+API_DIR = SOURCE_DIR / "api"
+PACKAGE_DIR = ROOT / "pySimBlocks"
+
+
+SECTIONS = {
+    "core": {
+        "title": "Core",
+        "intro": (
+            "The ``core`` package contains the simulation primitives and runtime "
+            "orchestration objects."
+        ),
+        "type": "modules",
+        "path": PACKAGE_DIR / "core",
+        "generated": "generated/core",
+    },
+    "project": {
+        "title": "Project",
+        "intro": (
+            "The ``project`` package groups utilities used to load project files, "
+            "build simulators, and generate runnable artifacts from project data."
+        ),
+        "type": "modules",
+        "path": PACKAGE_DIR / "project",
+        "generated": "generated/project",
+    },
+    "tools": {
+        "title": "Tools",
+        "intro": (
+            "The ``tools`` package contains support utilities used by the library "
+            "and project tooling."
+        ),
+        "type": "modules",
+        "path": PACKAGE_DIR / "tools",
+        "generated": "generated/tools",
+    },
+    "real_time": {
+        "title": "Real Time",
+        "intro": "The ``real_time`` package provides utilities for live execution workflows.",
+        "type": "modules",
+        "path": PACKAGE_DIR / "real_time",
+        "generated": "generated/real_time",
+    },
+}
+
+
+BLOCK_TITLES = {
+    "controllers": "Controllers",
+    "interfaces": "Interfaces",
+    "observers": "Observers",
+    "operators": "Operators",
+    "optimizers": "Optimizers",
+    "sources": "Sources",
+    "systems": "Systems",
+}
+
+
+GUI_SECTIONS = {
+    "application": {
+        "title": "GUI Application",
+        "path": PACKAGE_DIR / "gui",
+        "modules": [
+            "pySimBlocks.gui.editor",
+            "pySimBlocks.gui.main_window",
+            "pySimBlocks.gui.project_controller",
+        ],
+        "generated": "generated/gui/application",
+    },
+    "dialogs": {
+        "title": "GUI Dialogs",
+        "path": PACKAGE_DIR / "gui" / "dialogs",
+        "generated": "generated/gui/dialogs",
+    },
+    "graphics": {
+        "title": "GUI Graphics",
+        "path": PACKAGE_DIR / "gui" / "graphics",
+        "generated": "generated/gui/graphics",
+    },
+    "models": {
+        "title": "GUI Models",
+        "path": PACKAGE_DIR / "gui" / "models",
+        "generated": "generated/gui/models",
+    },
+    "services": {
+        "title": "GUI Services",
+        "path": PACKAGE_DIR / "gui" / "services",
+        "generated": "generated/gui/services",
+    },
+    "widgets": {
+        "title": "GUI Widgets",
+        "path": PACKAGE_DIR / "gui" / "widgets",
+        "generated": "generated/gui/widgets",
+    },
+    "addons": {
+        "title": "GUI Add-ons",
+        "path": PACKAGE_DIR / "gui" / "addons",
+        "generated": "generated/gui/addons",
+    },
+    "block_support": {
+        "title": "GUI Block Support",
+        "path": PACKAGE_DIR / "gui" / "blocks",
+        "modules": [
+            "pySimBlocks.gui.blocks.block_dialog_session",
+            "pySimBlocks.gui.blocks.block_meta",
+            "pySimBlocks.gui.blocks.parameter_meta",
+            "pySimBlocks.gui.blocks.port_meta",
+        ],
+        "generated": "generated/gui/blocks/support",
+    },
+}
+
+
+def _title(text: str, underline: str = "=") -> str:
+    return f"{text}\n{underline * len(text)}\n\n"
+
+
+def _discover_modules(path: Path, package: str) -> list[str]:
+    modules: list[str] = []
+    for py_file in sorted(path.rglob("*.py")):
+        if py_file.name == "__init__.py":
+            continue
+        relative = py_file.relative_to(PACKAGE_DIR).with_suffix("")
+        parts = relative.parts
+        modules.append("pySimBlocks." + ".".join(parts))
+    if package.endswith(".dialogs") or package.endswith(".addons"):
+        return modules
+    return [m for m in modules if ".__pycache__" not in m]
+
+
+def _write(path: Path, content: str) -> None:
+    path.parent.mkdir(parents=True, exist_ok=True)
+    path.write_text(content, encoding="utf-8")
+
+
+def _generated_doc_path(toctree: str, module: str) -> str:
+    return f"{toctree}/{module}.rst"
+
+
+def _module_page(module: str) -> str:
+    title = module
+    content = _title(title)
+    content += f".. automodule:: {module}\n"
+    content += "   :members:\n"
+    content += "   :show-inheritance:\n"
+    content += "   :member-order: bysource\n"
+    content += "\n"
+    return content
+
+
+def _list_page(title: str, intro: str | None, modules: list[str], toctree: str) -> str:
+    content = _title(title)
+    if intro:
+        content += intro + "\n\n"
+    content += ".. toctree::\n"
+    content += "   :maxdepth: 1\n\n"
+    for module in modules:
+        generated = f"{toctree}/{module}"
+        content += f"   {module} <{generated}>\n"
+    content += "\n"
+    return content
+
+
+def _modules_in_dir(path: Path, package: str) -> list[str]:
+    return _discover_modules(path, package)
+
+
+def generate_api(_: object | None = None) -> None:
+    _generate_api_index()
+    _generate_section_pages()
+    _generate_blocks_pages()
+    _generate_gui_pages()
+
+
+def _generate_api_index() -> None:
+    content = _title("API Reference")
+    content += (
+        "The API reference is organized by the package structure of ``pySimBlocks``. "
+        "Re-exported symbols from package ``__init__`` files are intentionally not "
+        "duplicated here; the canonical documentation lives in the subsection where "
+        "each object is implemented.\n\n"
+    )
+    content += ".. toctree::\n"
+    content += "   :maxdepth: 2\n\n"
+    for entry in ["blocks/index", "core", "gui/index", "project", "tools", "real_time"]:
+        content += f"   {entry}\n"
+    content += "\n"
+    _write(API_DIR / "index.rst", content)
+
+
+def _generate_section_pages() -> None:
+    for slug, config in SECTIONS.items():
+        modules = _modules_in_dir(config["path"], f"pySimBlocks.{slug}")
+        content = _list_page(
+            config["title"],
+            config["intro"],
+            modules,
+            config["generated"],
+        )
+        _write(API_DIR / f"{slug}.rst", content)
+        for module in modules:
+            _write(API_DIR / _generated_doc_path(config["generated"], module), _module_page(module))
+
+
+def _generate_blocks_pages() -> None:
+    blocks_dir = API_DIR / "blocks"
+    content = _title("Blocks")
+    content += (
+        "The ``blocks`` package contains the reusable simulation blocks used to build "
+        "models. The reference is split by block family so the runtime implementations "
+        "remain easy to browse.\n\n"
+    )
+    content += ".. toctree::\n   :maxdepth: 1\n\n"
+    for category in BLOCK_TITLES:
+        content += f"   {category}\n"
+    content += "\n"
+    _write(blocks_dir / "index.rst", content)
+
+    for category, label in BLOCK_TITLES.items():
+        modules = _discover_modules(PACKAGE_DIR / "blocks" / category, f"pySimBlocks.blocks.{category}")
+        content = _list_page(
+            f"Block {label}",
+            None,
+            modules,
+            f"../generated/blocks/{category}",
+        )
+        _write(blocks_dir / f"{category}.rst", content)
+        for module in modules:
+            _write(API_DIR / _generated_doc_path(f"generated/blocks/{category}", module), _module_page(module))
+
+
+def _generate_gui_pages() -> None:
+    gui_dir = API_DIR / "gui"
+    content = _title("GUI")
+    content += (
+        "The ``gui`` package contains the editor application, its support services, "
+        "and the GUI-side descriptions used to expose blocks in the interface.\n\n"
+    )
+    content += ".. toctree::\n   :maxdepth: 1\n\n"
+    for entry in ["application", "blocks/index", "dialogs", "graphics", "models", "services", "widgets", "addons"]:
+        content += f"   {entry}\n"
+    content += "\n"
+    _write(gui_dir / "index.rst", content)
+
+    for slug, config in GUI_SECTIONS.items():
+        if slug == "block_support":
+            continue
+        modules = config.get("modules") or _discover_modules(
+            config["path"], f"pySimBlocks.gui.{config['path'].relative_to(PACKAGE_DIR / 'gui').as_posix().replace('/', '.')}"
+        )
+        content = _list_page(config["title"], None, modules, f"../{config['generated']}")
+        _write(gui_dir / f"{slug}.rst", content)
+        for module in modules:
+            _write(API_DIR / _generated_doc_path(config["generated"], module), _module_page(module))
+
+    blocks_dir = gui_dir / "blocks"
+    content = _title("GUI Blocks")
+    content += (
+        "The GUI block metadata is split with the same category structure as the runtime "
+        "``blocks`` package, so navigation stays consistent between implementation and "
+        "editor-facing code.\n\n"
+    )
+    content += ".. toctree::\n   :maxdepth: 1\n\n"
+    for entry in [*BLOCK_TITLES.keys(), "support"]:
+        content += f"   {entry}\n"
+    content += "\n"
+    _write(blocks_dir / "index.rst", content)
+
+    for category, label in BLOCK_TITLES.items():
+        modules = _discover_modules(PACKAGE_DIR / "gui" / "blocks" / category, f"pySimBlocks.gui.blocks.{category}")
+        content = _list_page(
+            f"GUI Block {label}",
+            None,
+            modules,
+            f"../../generated/gui/blocks/{category}",
+        )
+        _write(blocks_dir / f"{category}.rst", content)
+        for module in modules:
+            _write(API_DIR / _generated_doc_path(f"generated/gui/blocks/{category}", module), _module_page(module))
+
+    support_modules = GUI_SECTIONS["block_support"]["modules"]
+    content = _list_page(
+        "GUI Block Support",
+        None,
+        support_modules,
+        "../../generated/gui/blocks/support",
+    )
+    _write(blocks_dir / "support.rst", content)
+    for module in support_modules:
+        _write(API_DIR / _generated_doc_path("generated/gui/blocks/support", module), _module_page(module))

pysimblocks-0.1.1/docs/source/conf.py

@@ -0,0 +1,116 @@
+from __future__ import annotations
+
+import os
+import sys
+import types
+import zipfile
+from pathlib import Path
+from unittest.mock import MagicMock
+
+sys.modules["qpsolvers"] = MagicMock()
+
+ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), "..", ".."))
+sys.path.insert(0, ROOT)
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext")))
+
+if "Sofa" not in sys.modules:
+    sofa = types.ModuleType("Sofa")
+    sofa_core = types.ModuleType("Sofa.Core")
+    sofa_simulation = types.ModuleType("Sofa.Simulation")
+    sofa_imgui = types.ModuleType("Sofa.ImGui")
+
+    class _SofaController:
+        def __init__(self, *args, **kwargs):
+            pass
+
+    class _SofaNode:
+        def __init__(self, *args, **kwargs):
+            pass
+
+    def _noop(*args, **kwargs):
+        return None
+
+    sofa_core.Controller = _SofaController
+    sofa_core.Node = _SofaNode
+    sofa_simulation.initRoot = _noop
+    sofa_simulation.animate = _noop
+
+    sofa.Core = sofa_core
+    sofa.Simulation = sofa_simulation
+    sofa.ImGui = sofa_imgui
+
+    sys.modules["Sofa"] = sofa
+    sys.modules["Sofa.Core"] = sofa_core
+    sys.modules["Sofa.Simulation"] = sofa_simulation
+    sys.modules["Sofa.ImGui"] = sofa_imgui
+
+project = "pySimBlocks"
+author = "Antoine Alessandrini"
+copyright = "2026, Universite de Lille & INRIA"
+release = "0.1.1"
+
+extensions = [
+    "myst_parser",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".md": "markdown",
+}
+myst_enable_extensions = [
+    "dollarmath",
+    "colon_fence",
+]
+
+autosummary_generate = True
+autosummary_imported_members = False
+autosummary_ignore_module_all = False
+
+autodoc_default_options = {
+    "members": True,
+    "undoc-members": False,
+    "show-inheritance": True,
+}
+
+autodoc_member_order = "bysource"
+autodoc_mock_imports = ["qpsolvers"]
+autodoc_type_aliases = {
+    "ArrayLike": "ArrayLike",
+}
+
+html_theme = "furo"
+html_title = "pySimBlocks Documentation"
+html_static_path = ["_static"]
+html_css_files = ["custom.css"]
+
+
+def generate_tutorial_archives(app):
+    source_dir = Path(__file__).resolve().parent
+    tutorials_root = Path(ROOT) / "examples" / "tutorials"
+    archive_dir = source_dir / "_static" / "downloads"
+    archive_dir.mkdir(parents=True, exist_ok=True)
+
+    tutorial_dir = tutorials_root / "tutorial_3_sofa"
+    archive_path = archive_dir / "tutorial_3_sofa.zip"
+
+    with zipfile.ZipFile(archive_path, "w", compression=zipfile.ZIP_DEFLATED) as archive:
+        for file_path in sorted(tutorial_dir.rglob("*")):
+            if not file_path.is_file():
+                continue
+            if "__pycache__" in file_path.parts or file_path.suffix == ".pyc":
+                continue
+            archive_name = Path("tutorial_3_sofa") / file_path.relative_to(tutorial_dir)
+            archive.write(file_path, archive_name.as_posix())
+
+
+def setup(app):
+    from api_generator import generate_api
+
+    app.connect("builder-inited", generate_api)
+    app.connect("builder-inited", generate_tutorial_archives)

pysimblocks-0.1.1/examples/quick_start/filter.py

@@ -0,0 +1,35 @@
+from pySimBlocks import Model, Simulator, SimulationConfig, PlotConfig
+from pySimBlocks.blocks.operators import Gain, Sum, Delay
+from pySimBlocks.blocks.sources import WhiteNoise
+from pySimBlocks.project.plot_from_config import plot_from_config
+
+# 1. Create the blocks
+noise = WhiteNoise(name="noise", std=1.0)
+delay = Delay(name="delay")
+filtered = Sum("filtered", signs="++")
+alpha_gain = Gain(name="alpha", gain=0.1)
+complement = Gain(name="complement", gain=0.9)
+
+# 2. Build the model
+model = Model("Example")
+for block in [noise, delay, filtered, alpha_gain, complement]:
+    model.add_block(block)
+
+model.connect("noise", "out", "alpha", "in")
+model.connect("delay", "out", "complement", "in")
+model.connect("alpha", "out", "filtered", "in1")
+model.connect("complement", "out", "filtered", "in2")
+model.connect("filtered", "out", "delay", "in")
+
+# 3. Simulate the model
+sim_cfg = SimulationConfig(dt=0.05, T=30.)
+sim = Simulator(model, sim_cfg)
+logs = sim.run(logging=["noise.outputs.out", "filtered.outputs.out"])
+
+# 4. Plot the results
+plot_cfg = PlotConfig([
+    {"title": "Noisy signal vs Filtered",
+     "signals": ["noise.outputs.out", "filtered.outputs.out"],},
+    ])
+plot_from_config(logs, plot_cfg)
+

pysimblocks-0.1.1/examples/quick_start/gui/run.py

@@ -0,0 +1,14 @@
+from pathlib import Path
+from pySimBlocks.project import load_simulator_from_project
+from pySimBlocks.project.plot_from_config import plot_from_config
+
+try:
+    BASE_DIR = Path(__file__).parent.resolve()
+except Exception:
+    BASE_DIR = Path("")
+
+sim, plot_cfg = load_simulator_from_project(BASE_DIR / 'project.yaml')
+
+logs = sim.run()
+if True and plot_cfg is not None:
+    plot_from_config(logs, plot_cfg)