morphopt 3.1.4__tar.gz → 3.1.6__tar.gz

morphopt-3.1.6/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: morphopt
+Version: 3.1.6
+Summary: A morphing optimization framework using PyTorch and Abaqus.
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: torch>=2.9.1
+Requires-Dist: torchvision>=0.15.1
+Requires-Dist: numpy>=2.0.0
+Requires-Dist: pypardiso>=0.4.7
+Requires-Dist: pyside6>=6.8.0
+Requires-Dist: pyvista>=0.47.1
+Requires-Dist: pyvistaqt>=0.11.3
+Requires-Dist: vtk>=9.6.1
+Requires-Dist: gmsh>=4.15.0
+Requires-Dist: tabulate>=0.9.0
+Requires-Dist: imageio>=2.37.3
+Requires-Dist: bspmap>=1.0.3
+Requires-Dist: torchfea>=1.0.17
+Requires-Dist: trimesh>=4.11.5
+Requires-Dist: networkx>=3.6.1
+Requires-Dist: scipy>=1.17.1
+Requires-Dist: cpgeo>=1.0.12
+
+# MorphOpt — A Differentiable Optimization Framework for Soft Structure & Morphology Design
+
+**Developed by Zenan Song**
+
+A differentiable structural optimization framework that eliminates manual sensitivity derivation by fusing the adjoint method with automatic differentiation (AD). The sensitivity corresponds to the virtual work of residual force derivatives on the adjoint displacement field, computed via a single backpropagation through the residual graph. MorphOpt provides a unified interface for geometry, load, and material definition, calls torchfea for GPU-accelerated differentiable nonlinear FEA and adjoint-AD sensitivity, and employs a trust-region optimizer with L-BFGS for design updates. Validated on SIMP topology optimization with B-spline density fields and pneumatic soft robot shape optimization with deformation-dependent follower loads.
+
+## Features
+
+- Custom model definition covering geometry, material, and load parameters
+- Differentiable FEA via torchfea with automatic solving and sensitivity propagation
+- L-BFGS and trust-region methods for parameter updates within a subproblem framework
+- Fully extensible via inheritance — users customize every component in their definition scripts
+
+## Quick Start
+
+```bash
+pip install morphopt
+```
+
+1. Install dependencies. Python ≥ 3.12, PyTorch (float64) recommended.
+2. Run a minimal example:
+
+```bash
+# Shape optimization (pneumatic bending actuator)
+python examples/bendingactuator.py
+
+# SIMP topology optimization (compliant gripper)
+python examples/gripper.py
+```
+
+3. **Launch the GUI (recommended)** — define, run and observe an optimization all inside one window:
+
+```bash
+morphopt-ui            # console command, available after `pip install morphopt`
+# python -m morphopt.ui works too (handy when running from a source code directory)
+```
+
+The complete UI workflow (definition part + observer part) is described in [`docs/UI_usage.md`](docs/UI_usage.md).
+
+Further references:
+
+- Task definition guide: `docs/module_definition_guide.md`
+- Module API reference: `docs/module_reference.md`
+- Theory & papers: `docs/theory/`
+
+## Directory Overview
+
+- `src/morphopt/`
+  - `optcore` — Core package (controller, params, solver, objective, updaters)
+  - `shapeopt/` — B-spline shape optimization
+  - `simp/` — SIMP topology optimization
+  - `codesign/` — Shell co-design (shape + material)
+  - `ui/` — PySide6 graphical UI (definition + observer in one window)
+- `examples/` — Example tasks (bending actuator, gripper, etc.)
+- `docs/` — Usage guides, API reference, theory papers
+  - [`UI_usage.md`](docs/UI_usage.md) — graphical UI user guide
+- `tests/` — Gradient checks, geometry tests, UI tests
+- `ui_runs/` — runs launched from the UI and their results (`<label>_T<timestamp>/`)
+
+## License
+
+Research use preferred. For production or commercial use, please evaluate and ensure numerical and engineering robustness first.
+
+## Citation
+
+If you use MorphOpt in your research, please cite:
+
+- TRO 2023 — Morphology Design
+- TRO 2026 — Jacobian-based Optimization
+- TMECH 2026 — Contact-aware Design
+

morphopt-3.1.6/README.md

@@ -0,0 +1,71 @@
+# MorphOpt — A Differentiable Optimization Framework for Soft Structure & Morphology Design
+
+**Developed by Zenan Song**
+
+A differentiable structural optimization framework that eliminates manual sensitivity derivation by fusing the adjoint method with automatic differentiation (AD). The sensitivity corresponds to the virtual work of residual force derivatives on the adjoint displacement field, computed via a single backpropagation through the residual graph. MorphOpt provides a unified interface for geometry, load, and material definition, calls torchfea for GPU-accelerated differentiable nonlinear FEA and adjoint-AD sensitivity, and employs a trust-region optimizer with L-BFGS for design updates. Validated on SIMP topology optimization with B-spline density fields and pneumatic soft robot shape optimization with deformation-dependent follower loads.
+
+## Features
+
+- Custom model definition covering geometry, material, and load parameters
+- Differentiable FEA via torchfea with automatic solving and sensitivity propagation
+- L-BFGS and trust-region methods for parameter updates within a subproblem framework
+- Fully extensible via inheritance — users customize every component in their definition scripts
+
+## Quick Start
+
+```bash
+pip install morphopt
+```
+
+1. Install dependencies. Python ≥ 3.12, PyTorch (float64) recommended.
+2. Run a minimal example:
+
+```bash
+# Shape optimization (pneumatic bending actuator)
+python examples/bendingactuator.py
+
+# SIMP topology optimization (compliant gripper)
+python examples/gripper.py
+```
+
+3. **Launch the GUI (recommended)** — define, run and observe an optimization all inside one window:
+
+```bash
+morphopt-ui            # console command, available after `pip install morphopt`
+# python -m morphopt.ui works too (handy when running from a source code directory)
+```
+
+The complete UI workflow (definition part + observer part) is described in [`docs/UI_usage.md`](docs/UI_usage.md).
+
+Further references:
+
+- Task definition guide: `docs/module_definition_guide.md`
+- Module API reference: `docs/module_reference.md`
+- Theory & papers: `docs/theory/`
+
+## Directory Overview
+
+- `src/morphopt/`
+  - `optcore` — Core package (controller, params, solver, objective, updaters)
+  - `shapeopt/` — B-spline shape optimization
+  - `simp/` — SIMP topology optimization
+  - `codesign/` — Shell co-design (shape + material)
+  - `ui/` — PySide6 graphical UI (definition + observer in one window)
+- `examples/` — Example tasks (bending actuator, gripper, etc.)
+- `docs/` — Usage guides, API reference, theory papers
+  - [`UI_usage.md`](docs/UI_usage.md) — graphical UI user guide
+- `tests/` — Gradient checks, geometry tests, UI tests
+- `ui_runs/` — runs launched from the UI and their results (`<label>_T<timestamp>/`)
+
+## License
+
+Research use preferred. For production or commercial use, please evaluate and ensure numerical and engineering robustness first.
+
+## Citation
+
+If you use MorphOpt in your research, please cite:
+
+- TRO 2023 — Morphology Design
+- TRO 2026 — Jacobian-based Optimization
+- TMECH 2026 — Contact-aware Design
+

{morphopt-3.1.4 → morphopt-3.1.6}/pyproject.toml

@@ -1,25 +1,29 @@
 [project]
 name = "morphopt"
-version = "3.1.4"
+version = "3.1.6"
 description = "A morphing optimization framework using PyTorch and Abaqus."
 readme = "README.md"
 requires-python = ">=3.12"
 dependencies = [
-    "torch>=2.0.0",
+    "torch>=2.9.1",
     "torchvision>=0.15.1",
     "numpy>=2.0.0",
     "pypardiso>=0.4.7",
-    "pyqt6>=6.11.0",
+    "pyside6>=6.8.0",
     "pyvista>=0.47.1",
     "pyvistaqt>=0.11.3",
     "vtk>=9.6.1",
     "gmsh>=4.15.0",
     "tabulate>=0.9.0",
     "imageio>=2.37.3",
-    "bspmap>=1.0.0",
-    "torchfea>=1.0.11",
+    "bspmap>=1.0.3",
+    "torchfea>=1.0.17",
     "trimesh>=4.11.5",
     "networkx>=3.6.1",
     "scipy>=1.17.1",
-    "cpgeo>=1.0.8",
+    "cpgeo>=1.0.12",
 ]
+
+[project.scripts]
+# console entry for the graphical UI (after `pip install morphopt`)
+morphopt-ui = "morphopt.ui:run_app"

{morphopt-3.1.4 → morphopt-3.1.6}/setup.cfg

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

morphopt-3.1.6/src/morphopt/__init__.py

@@ -0,0 +1,82 @@
+"""
+A differentiable structural optimization framework that eliminates manual sensitivity derivation by fusing the adjoint method with automatic differentiation (AD). The sensitivity corresponds to the virtual work of residual force derivatives on the adjoint displacement field, computed via a single backpropagation through the residual graph. MorphOpt provides a unified interface for geometry, load, and material definition, calls torchfea for GPU-accelerated differentiable nonlinear FEA and adjoint-AD sensitivity, and employs a trust-region optimizer with L-BFGS for design updates. Validated on SIMP topology optimization with B-spline density fields and pneumatic soft robot shape optimization with deformation-dependent follower loads.
+"""
+
+
+# region: Logging Configuration
+import logging as __logging
+
+def enable_logging(level=__logging.INFO, log_file=None, file_log_level=__logging.DEBUG):
+    """
+    Enable logging for the FEA package.
+
+    Parameters
+    ----------
+    level : int
+        the logging level (e.g., logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR, logging.CRITICAL)
+    log_file : str, optional
+        the path to a log file where logs will be written. If None, logs will only be printed to the console.
+    file_log_level : int
+        the logging level for the log file. Default is logging.INFO.
+    
+    Examples
+    --------
+    >>> import torchfea
+    >>> torchfea.enable_logging(level=logging.DEBUG, log_file='fem.log')
+    """
+    logger = __logging.getLogger(__name__)
+    logger.setLevel(min(level, file_log_level))
+    
+    # clear existing handlers to avoid duplicate logs
+    logger.handlers.clear()
+    
+    # logging to console
+    console = __logging.StreamHandler()
+    console.setLevel(level)
+    console.setFormatter(__logging.Formatter(
+        '%(asctime)s | %(levelname)-7s | %(message)s',
+        datefmt='%Y-%m-%d %H:%M:%S'
+    ))
+    logger.addHandler(console)
+    
+    # logging to file if log_file is provided
+    if log_file:
+        file_handler = __logging.FileHandler(log_file, encoding='utf-8')
+        file_handler.setLevel(file_log_level)
+        file_handler.setFormatter(__logging.Formatter(
+            '%(asctime)s | %(levelname)-7s | %(name)s | %(message)s'
+        ))
+        logger.addHandler(file_handler)
+
+    return logger
+# endregion
+
+
+
+
+
+# region optcore imports
+from .optcore.controller import Controller
+from .optcore.modelparams import FEAParams, FixedGeometryINP, FixedGeometry, HomogeneousMaterial, Params
+from .optcore.solver import Solver
+from .optcore.modelparams import Params
+from .optcore.updaters import Updaters
+from .optcore.objfunc import ObjectiveFunction
+from .optcore.history import History
+from .optcore.baseobject import BaseObject
+# endregion
+
+from .opt_runner import start_optimization, debug_optimization
+
+# region modules
+from . import shapeopt
+from . import codesign
+from . import simp
+# endregion
+
+# region scripts
+from .utils import check_gradients, get_controller
+# endregion
+
+controller: Controller = None
+

morphopt-3.1.6/src/morphopt/codesign/__init__.py

@@ -0,0 +1,18 @@
+from .material import CodesignMaterials
+from .geometry import CodesignGeometry
+from .constraints import InwardCurvatureRadius, OffsetSurfaceMinThickness
+from .feaparams import CodesignFEAParams
+from .params import Params
+from ..optcore import Solver, Updaters
+from ..shapeopt import GeometryParams, UpdaterGeometries, ObjectiveFunction
+from ..simp import UpdaterMaterials
+
+def plot_geometry_and_materials(geometry: CodesignGeometry, materials: CodesignMaterials):
+    import pyvista as pv
+    plotter = pv.Plotter(window_size=(1400, 900))
+    plotter.set_background('white')
+
+    plotter = materials.plot(plotter=plotter)
+    geometry.plot(plotter=plotter, opacity=[0.0, 1.0])
+
+    plotter.show()