openseespy-viewer 0.1.0__tar.gz

openseespy_viewer-0.1.0/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: openseespy-viewer
+Version: 0.1.0
+Summary: Live visual previewer for OpenSeesPy models
+Author: Igor Barcelos
+License: MIT
+Project-URL: Homepage, https://github.com/igor-barcelos/openseespy-viewer
+Keywords: opensees,openseespy,structural,visualization,pyvista
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: numpy
+Requires-Dist: pyvista
+Requires-Dist: watchdog
+
+# openseespy-viewer
+
+Viewer for openseespy models. Monitors your model file(s) and produces a live 3D drawing that updates each time you save. Works with 2D/3dof and 3D/6dof models.
+
+### Installation
+
+```
+pip install openseespy-viewer
+```
+
+Or install from source:
+
+```
+pip install .
+```
+
+### Usage
+
+**Python API:**
+
+```python
+from viewer import view
+
+# Single file
+view('my_model.py')
+
+# Multiple files
+view('nodes.py', 'elements.py', 'boundary.py')
+
+# With custom style options
+view('my_model.py', bg_colour='white', node_size=16, ele_width=3)
+```
+
+**Command line:**
+
+```bash
+# Basic usage
+openseespy-viewer my_model.py
+
+# Multiple files with custom refresh rate
+openseespy-viewer nodes.py elements.py --refresh 1.0
+
+# Or via python -m
+python -m viewer my_model.py
+```
+
+### Screenshots
+
+Press **S** in the viewer window to save a screenshot. Screenshots are saved to the `images/` folder with incrementing names (`model_screenshot_001.png`, `model_screenshot_002.png`, etc.). The counter resets each time you restart the viewer. This is useful for sharing your model with AI tools like Claude Code — just ask it to look at the screenshot.
+
+### Examples
+
+![Example usage gif](assets/demo_2.gif)
+
+
+See the `examples/` directory for sample model files.
+
+### Dependencies
+
+```
+pip install pyvista numpy watchdog
+```
+
+### Feature wish-list
+
+- [x] Plot nodes as they are saved in a watched script
+- [x] Add node labels
+- [x] Add support for elements
+- [x] Add support for fixity conditions
+- [x] Add support for variables and expressions in scripts
+- [x] Add support for watching multiple files (for models made up of many files)
+- [ ] Add support for loads
+- [ ] Add support for nodes created within loop
+- [x] Add support for 3D models
+- [ ] Add support for rotational dofs
+- [x] Screenshot capture (press S in viewer)

openseespy_viewer-0.1.0/README.md

@@ -0,0 +1,76 @@
+# openseespy-viewer
+
+Viewer for openseespy models. Monitors your model file(s) and produces a live 3D drawing that updates each time you save. Works with 2D/3dof and 3D/6dof models.
+
+### Installation
+
+```
+pip install openseespy-viewer
+```
+
+Or install from source:
+
+```
+pip install .
+```
+
+### Usage
+
+**Python API:**
+
+```python
+from viewer import view
+
+# Single file
+view('my_model.py')
+
+# Multiple files
+view('nodes.py', 'elements.py', 'boundary.py')
+
+# With custom style options
+view('my_model.py', bg_colour='white', node_size=16, ele_width=3)
+```
+
+**Command line:**
+
+```bash
+# Basic usage
+openseespy-viewer my_model.py
+
+# Multiple files with custom refresh rate
+openseespy-viewer nodes.py elements.py --refresh 1.0
+
+# Or via python -m
+python -m viewer my_model.py
+```
+
+### Screenshots
+
+Press **S** in the viewer window to save a screenshot. Screenshots are saved to the `images/` folder with incrementing names (`model_screenshot_001.png`, `model_screenshot_002.png`, etc.). The counter resets each time you restart the viewer. This is useful for sharing your model with AI tools like Claude Code — just ask it to look at the screenshot.
+
+### Examples
+
+![Example usage gif](assets/demo_2.gif)
+
+
+See the `examples/` directory for sample model files.
+
+### Dependencies
+
+```
+pip install pyvista numpy watchdog
+```
+
+### Feature wish-list
+
+- [x] Plot nodes as they are saved in a watched script
+- [x] Add node labels
+- [x] Add support for elements
+- [x] Add support for fixity conditions
+- [x] Add support for variables and expressions in scripts
+- [x] Add support for watching multiple files (for models made up of many files)
+- [ ] Add support for loads
+- [ ] Add support for nodes created within loop
+- [x] Add support for 3D models
+- [ ] Add support for rotational dofs
+- [x] Screenshot capture (press S in viewer)

openseespy_viewer-0.1.0/openseespy_viewer.egg-info/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: openseespy-viewer
+Version: 0.1.0
+Summary: Live visual previewer for OpenSeesPy models
+Author: Igor Barcelos
+License: MIT
+Project-URL: Homepage, https://github.com/igor-barcelos/openseespy-viewer
+Keywords: opensees,openseespy,structural,visualization,pyvista
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: numpy
+Requires-Dist: pyvista
+Requires-Dist: watchdog
+
+# openseespy-viewer
+
+Viewer for openseespy models. Monitors your model file(s) and produces a live 3D drawing that updates each time you save. Works with 2D/3dof and 3D/6dof models.
+
+### Installation
+
+```
+pip install openseespy-viewer
+```
+
+Or install from source:
+
+```
+pip install .
+```
+
+### Usage
+
+**Python API:**
+
+```python
+from viewer import view
+
+# Single file
+view('my_model.py')
+
+# Multiple files
+view('nodes.py', 'elements.py', 'boundary.py')
+
+# With custom style options
+view('my_model.py', bg_colour='white', node_size=16, ele_width=3)
+```
+
+**Command line:**
+
+```bash
+# Basic usage
+openseespy-viewer my_model.py
+
+# Multiple files with custom refresh rate
+openseespy-viewer nodes.py elements.py --refresh 1.0
+
+# Or via python -m
+python -m viewer my_model.py
+```
+
+### Screenshots
+
+Press **S** in the viewer window to save a screenshot. Screenshots are saved to the `images/` folder with incrementing names (`model_screenshot_001.png`, `model_screenshot_002.png`, etc.). The counter resets each time you restart the viewer. This is useful for sharing your model with AI tools like Claude Code — just ask it to look at the screenshot.
+
+### Examples
+
+![Example usage gif](assets/demo_2.gif)
+
+
+See the `examples/` directory for sample model files.
+
+### Dependencies
+
+```
+pip install pyvista numpy watchdog
+```
+
+### Feature wish-list
+
+- [x] Plot nodes as they are saved in a watched script
+- [x] Add node labels
+- [x] Add support for elements
+- [x] Add support for fixity conditions
+- [x] Add support for variables and expressions in scripts
+- [x] Add support for watching multiple files (for models made up of many files)
+- [ ] Add support for loads
+- [ ] Add support for nodes created within loop
+- [x] Add support for 3D models
+- [ ] Add support for rotational dofs
+- [x] Screenshot capture (press S in viewer)

openseespy_viewer-0.1.0/openseespy_viewer.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+README.md
+pyproject.toml
+openseespy_viewer.egg-info/PKG-INFO
+openseespy_viewer.egg-info/SOURCES.txt
+openseespy_viewer.egg-info/dependency_links.txt
+openseespy_viewer.egg-info/entry_points.txt
+openseespy_viewer.egg-info/requires.txt
+openseespy_viewer.egg-info/top_level.txt
+viewer/__init__.py
+viewer/__main__.py
+viewer/model.py
+viewer/viewer.py
+viewer/watcher.py

openseespy_viewer-0.1.0/openseespy_viewer.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

openseespy_viewer-0.1.0/openseespy_viewer.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+openseespy-viewer = viewer.__main__:main

openseespy_viewer-0.1.0/openseespy_viewer.egg-info/requires.txt

@@ -0,0 +1,3 @@
+numpy
+pyvista
+watchdog

openseespy_viewer-0.1.0/openseespy_viewer.egg-info/top_level.txt

@@ -0,0 +1 @@
+viewer

openseespy_viewer-0.1.0/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools>=64", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "openseespy-viewer"
+version = "0.1.0"
+description = "Live visual previewer for OpenSeesPy models"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.8"
+authors = [
+    { name = "Igor Barcelos" },
+]
+keywords = ["opensees", "openseespy", "structural", "visualization", "pyvista"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Education",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering",
+]
+dependencies = [
+    "numpy",
+    "pyvista",
+    "watchdog",
+]
+
+[project.urls]
+Homepage = "https://github.com/igor-barcelos/openseespy-viewer"
+
+[tool.setuptools.packages.find]
+include = ["viewer*"]
+
+[project.scripts]
+openseespy-viewer = "viewer.__main__:main"

openseespy_viewer-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

openseespy_viewer-0.1.0/viewer/__init__.py

@@ -0,0 +1,6 @@
+"""viewer: Live visual previewer for OpenSeesPy models."""
+
+from .viewer import view
+
+__version__ = "0.1.0"
+__all__ = ["view"]

openseespy_viewer-0.1.0/viewer/__main__.py

@@ -0,0 +1,25 @@
+"""CLI entry point: python -m openseespy_viewer model1.py [model2.py ...]"""
+
+import argparse
+from .viewer import view
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        prog="openseespy-viewer",
+        description="Live visual previewer for OpenSeesPy models.",
+    )
+    parser.add_argument(
+        "modelfiles", nargs="+",
+        help="One or more OpenSeesPy model files (.py) to visualise.",
+    )
+    parser.add_argument(
+        "--refresh", type=float, default=0.5,
+        help="Minimum refresh interval in seconds (default: 0.5).",
+    )
+    args = parser.parse_args()
+    view(*args.modelfiles, min_refresh_interval=args.refresh)
+
+
+if __name__ == "__main__":
+    main()

openseespy_viewer-0.1.0/viewer/model.py

@@ -0,0 +1,73 @@
+"""Mock OpenSeesPy module for intercepting ops.node(), ops.element(), etc."""
+
+import os
+import sys
+import types
+
+
+class Model:
+    """A mock replacement for openseespy.opensees that records model data
+    instead of building a real OpenSees model.
+    """
+    def __init__(self):
+        self.nodes = []
+        self.elements = []
+        self.fixities = []
+        self.ndm = 2
+
+    def model(self, *args):
+        args = [str(a) for a in args]
+        if '-ndm' in args:
+            idx = args.index('-ndm')
+            self.ndm = int(args[idx + 1])
+
+    def node(self, tag, *coords):
+        self.nodes.append((int(tag),) + tuple(float(c) for c in coords))
+
+    def element(self, etype, tag, iNode, jNode, *rest):
+        self.elements.append((str(etype), int(tag), int(iNode), int(jNode)))
+
+    def fix(self, tag, *dofs):
+        self.fixities.append((int(tag),) + tuple(int(d) for d in dofs))
+
+    def __getattr__(self, name):
+        # Catch-all: silently ignore any other ops.xxx() call
+        return lambda *args, **kwargs: None
+
+
+def parse_py(pyfiles):
+    """Parse OpenSeesPy (.py) files by mocking the openseespy module and
+    executing the user's script. All ops.node/element/fix calls are recorded.
+    Returns (nodes, elements, fixities, ndm).
+    """
+    mock = Model()
+
+    mock_package = types.ModuleType('openseespy')
+    mock_package.opensees = mock
+    mock_package.__path__ = []
+
+    saved = {}
+    for key in ('openseespy', 'openseespy.opensees'):
+        if key in sys.modules:
+            saved[key] = sys.modules[key]
+
+    sys.modules['openseespy'] = mock_package
+    sys.modules['openseespy.opensees'] = mock
+
+    try:
+        for pyfile in pyfiles:
+            filepath = os.path.abspath(pyfile)
+            with open(filepath, 'r') as f:
+                code = f.read()
+            exec(compile(code, filepath, 'exec'),
+                 {'__name__': '__main__', '__file__': filepath})
+    except Exception as e:
+        print(f'Error parsing {pyfile}: {e}')
+    finally:
+        for key in ('openseespy', 'openseespy.opensees'):
+            if key in saved:
+                sys.modules[key] = saved[key]
+            elif key in sys.modules:
+                del sys.modules[key]
+
+    return mock.nodes, mock.elements, mock.fixities, mock.ndm

openseespy_viewer-0.1.0/viewer/viewer.py

@@ -0,0 +1,224 @@
+"""Main viewer logic: builds the 3D scene and runs the live preview loop."""
+
+import os
+import sys
+import numpy as np
+import pyvista as pv
+
+SCREENSHOT_DIR = os.path.join(os.getcwd(), 'images')
+_screenshot_counter = 0
+
+from .model import parse_py
+from .watcher import start_watcher
+
+# Default visual style
+DEFAULTS = dict(
+    bg_colour='lightgrey',
+    node_colour='black',
+    node_size=12,
+    ele_colour='black',
+    ele_width=2,
+    axis_colour='grey',
+    label_font_size=10,
+    offset_ratio=0.02,
+    bc_arrow_scale=0.3,
+    min_refresh_interval=0.5,
+)
+
+
+def _nodecoords(nodetag, nodes, ndm):
+    """Returns node coordinates as a 3D point (z=0 for 2D models)."""
+    for node in nodes:
+        if node[0] == nodetag:
+            if ndm == 2:
+                return np.array([node[1], node[2], 0.0])
+            else:
+                return np.array([node[1], node[2], node[3]])
+    return None
+
+
+def _build_scene(plotter, modelfiles, ndm, style):
+    """Parse model files and add all geometry to the plotter."""
+    nodes, elements, fixities, _ = parse_py(modelfiles)
+
+    if not nodes:
+        return
+
+    # Build node points array (always 3D; z=0 for 2D models)
+    if ndm == 2:
+        node_points = np.array([[n[1], n[2], 0.0] for n in nodes])
+    else:
+        node_points = np.array([[n[1], n[2], n[3]] for n in nodes])
+
+    node_tags = [n[0] for n in nodes]
+
+    # Compute model size for offsets
+    mins = node_points.min(axis=0)
+    maxs = node_points.max(axis=0)
+    spans = maxs - mins
+    model_size = max(spans.max(), 1.0)
+    offset = model_size * style['offset_ratio']
+
+    # --- Display nodes ---
+    node_cloud = pv.PolyData(node_points)
+    plotter.add_mesh(node_cloud, color=style['node_colour'],
+                     point_size=style['node_size'],
+                     render_points_as_spheres=True)
+
+    # Node labels
+    label_points = node_points + offset
+    node_labels = ['N' + str(t) for t in node_tags]
+    plotter.add_point_labels(label_points, node_labels,
+                             font_size=style['label_font_size'],
+                             text_color='black', font_family='courier',
+                             bold=True, shape=None, fill_shape=False)
+
+    # --- Display reference axes ---
+    if ndm == 2:
+        margin = model_size * 0.15
+        x_line = pv.Line([mins[0] - margin, 0, 0], [maxs[0] + margin, 0, 0])
+        y_line = pv.Line([0, mins[1] - margin, 0], [0, maxs[1] + margin, 0])
+        plotter.add_mesh(x_line, color=style['axis_colour'], line_width=1,
+                         style='wireframe')
+        plotter.add_mesh(y_line, color=style['axis_colour'], line_width=1,
+                         style='wireframe')
+    else:
+        view_centre = (mins + maxs) / 2
+        view_range = spans.max()
+        axis_len = 1.2 * (view_range / 2 + max(abs(view_centre)))
+        x_axis = pv.Line([0, 0, 0], [axis_len, 0, 0])
+        y_axis = pv.Line([0, 0, 0], [0, axis_len, 0])
+        z_axis = pv.Line([0, 0, 0], [0, 0, axis_len])
+        plotter.add_mesh(x_axis, color='red', line_width=1)
+        plotter.add_mesh(y_axis, color='green', line_width=1)
+        plotter.add_mesh(z_axis, color='blue', line_width=1)
+
+    # --- Display elements ---
+    if elements:
+        for element in elements:
+            iNode = _nodecoords(element[2], nodes, ndm)
+            jNode = _nodecoords(element[3], nodes, ndm)
+            if iNode is not None and jNode is not None:
+                line = pv.Line(iNode, jNode)
+                plotter.add_mesh(line, color=style['ele_colour'],
+                                 line_width=style['ele_width'])
+                mid = (iNode + jNode) / 2 + offset
+                plotter.add_point_labels(
+                    [mid], ['E' + str(element[1])],
+                    font_size=style['label_font_size'],
+                    text_color='black', font_family='courier',
+                    shape=None, fill_shape=False)
+
+    # --- Display boundary conditions ---
+    if fixities:
+        bc_size = model_size * 0.04
+        for fixity in fixities:
+            coords = _nodecoords(fixity[0], nodes, ndm)
+            if coords is None:
+                continue
+
+            if ndm == 2:
+                if fixity[1] == 1:
+                    tip = coords - np.array([bc_size * 0.5, 0, 0])
+                    tri = pv.Triangle([
+                        [tip[0] - bc_size, tip[1] - bc_size * 0.5, 0],
+                        [tip[0], tip[1], 0],
+                        [tip[0] - bc_size, tip[1] + bc_size * 0.5, 0],
+                    ])
+                    plotter.add_mesh(tri, color='black', style='wireframe',
+                                     line_width=2)
+                if fixity[2] == 1:
+                    tip = coords - np.array([0, bc_size * 0.5, 0])
+                    tri = pv.Triangle([
+                        [tip[0] - bc_size * 0.5, tip[1] - bc_size, 0],
+                        [tip[0], tip[1], 0],
+                        [tip[0] + bc_size * 0.5, tip[1] - bc_size, 0],
+                    ])
+                    plotter.add_mesh(tri, color='black', style='wireframe',
+                                     line_width=2)
+                if len(fixity) > 3 and fixity[3] == 1:
+                    circle = pv.Circle(radius=bc_size * 0.6, resolution=32)
+                    circle.translate(coords, inplace=True)
+                    plotter.add_mesh(circle, color='black', style='wireframe',
+                                     line_width=2)
+            else:
+                directions = [
+                    np.array([1, 0, 0]),
+                    np.array([0, 1, 0]),
+                    np.array([0, 0, 1]),
+                ]
+                for i, d in enumerate(directions):
+                    if fixity[i + 1] == 1:
+                        start = coords - d * bc_size * 1.5
+                        arrow = pv.Arrow(start=start, direction=d,
+                                         scale=bc_size * 1.5, tip_length=0.4,
+                                         tip_radius=0.15, shaft_radius=0.05)
+                        plotter.add_mesh(arrow, color='black')
+
+
+def view(*modelfiles, **kwargs):
+    """Open a live viewer for the given OpenSeesPy model file(s).
+
+    Parameters
+    ----------
+    *modelfiles : str
+        One or more paths to OpenSeesPy model files (.py).
+    **kwargs :
+        Optional style overrides (bg_colour, node_colour, node_size,
+        ele_colour, ele_width, axis_colour, label_font_size, offset_ratio,
+        min_refresh_interval).
+    """
+    if not modelfiles:
+        raise ValueError("At least one model file path is required.")
+
+    style = {**DEFAULTS, **kwargs}
+
+    # Determine 2D or 3D
+    _, _, _, ndm = parse_py(modelfiles)
+
+    # Start file watcher
+    observer, file_handler = start_watcher(modelfiles)
+
+    # Create plotter
+    plotter = pv.Plotter(title='OpenSeesPy Viewer - ' + ', '.join(modelfiles))
+    plotter.set_background(style['bg_colour'])
+
+    # Initial scene build
+    _build_scene(plotter, modelfiles, ndm, style)
+
+    if ndm == 2:
+        plotter.view_xy()
+        plotter.enable_parallel_projection()
+
+    def _update(step):
+        if not file_handler.changed.is_set():
+            return
+        file_handler.changed.clear()
+        plotter.clear()
+        _build_scene(plotter, modelfiles, ndm, style)
+        if ndm == 2:
+            plotter.view_xy()
+        plotter.render()
+
+    def _screenshot():
+        global _screenshot_counter
+        os.makedirs(SCREENSHOT_DIR, exist_ok=True)
+        _screenshot_counter += 1
+        path = os.path.join(SCREENSHOT_DIR, f'model_screenshot_{_screenshot_counter:03d}.png')
+        plotter.screenshot(path)
+        print(f'Screenshot saved to {path}')
+
+    plotter.add_key_event('s', _screenshot)
+
+    plotter.show(interactive_update=True)
+    plotter.add_timer_event(
+        max_steps=sys.maxsize,
+        duration=int(style['min_refresh_interval'] * 1000),
+        callback=_update,
+    )
+
+    try:
+        plotter.iren.start()
+    finally:
+        observer.stop()
+        observer.join()

openseespy_viewer-0.1.0/viewer/watcher.py

@@ -0,0 +1,41 @@
+"""File watcher that detects changes in model files."""
+
+import os
+import threading
+from watchdog.observers import Observer
+from watchdog.events import FileSystemEventHandler
+
+
+class ModelFileHandler(FileSystemEventHandler):
+    """Watches model files for changes and sets a flag when they are modified."""
+    def __init__(self, filenames):
+        self.filenames = {os.path.abspath(f) for f in filenames}
+        self.changed = threading.Event()
+        self.changed.set()  # trigger initial draw
+
+    def _check(self, event):
+        if os.path.abspath(event.src_path) in self.filenames:
+            self.changed.set()
+
+    def on_modified(self, event):
+        self._check(event)
+
+    def on_created(self, event):
+        self._check(event)
+
+    def on_moved(self, event):
+        if os.path.abspath(event.dest_path) in self.filenames:
+            self.changed.set()
+
+
+def start_watcher(modelfiles):
+    """Start a file watcher on the given model files.
+    Returns (observer, file_handler).
+    """
+    file_handler = ModelFileHandler(modelfiles)
+    observer = Observer()
+    watched_dirs = {os.path.abspath(os.path.dirname(f) or '.') for f in modelfiles}
+    for d in watched_dirs:
+        observer.schedule(file_handler, d, recursive=False)
+    observer.start()
+    return observer, file_handler