compas-cem 0.7.0__py2.py3-none-any.whl → 0.8.2__py2.py3-none-any.whl

compas_cem/optimization/constraints/polyline.py

@@ -0,0 +1,149 @@
+from compas.geometry import closest_point_on_segment
+from compas.geometry._core.distance import closest_points_in_cloud_numpy
+
+from compas.utilities import pairwise
+
+from compas_cem.optimization.constraints import VectorConstraint
+
+
+__all__ = ["PolylineConstraint"]
+
+
+class PolylineConstraint(VectorConstraint):
+    """
+    Pulls the xyz position of a node to a target polyline.
+    """
+    def __init__(self, node=None, polyline=None, weight=1.0):
+        super(PolylineConstraint, self).__init__(node, polyline, weight)
+
+    def reference(self, data):
+        """
+        The current xyz coordinates of the node.
+        """
+        return data["node_xyz"][self.key()]
+
+    def target(self, reference):
+        """
+        The closest point on the target polyline.
+        """
+        polyline = self._target
+        return self._closest_point_on_polyline(reference, polyline)
+
+    @staticmethod
+    def _closest_point_on_polyline(point, polyline):
+        """
+        The closest point on a polyline.
+
+        Notes
+        -----
+        This is a reimplementation of a compas method.
+        The compas method did not support autograd transforms.
+        """
+        cloud = []
+
+        for segment in pairwise(polyline):
+            cloud.append(closest_point_on_segment(point, segment))
+
+        indices = closest_points_in_cloud_numpy([point], cloud, distances=False)
+
+        return cloud[indices[0]]
+
+
+if __name__ == "__main__":
+
+    from math import fabs
+    from math import pi
+    from math import sin
+    from math import cos
+
+    from random import choice
+    from random import random
+    from random import seed
+
+    from compas.geometry import add_vectors
+    from compas.geometry import Point
+    from compas.geometry import Polyline
+
+    from compas_cem.diagrams import TopologyDiagram
+
+    from compas_cem.elements import Node
+    from compas_cem.elements import TrailEdge
+
+    from compas_cem.loads import NodeLoad
+
+    from compas_cem.supports import NodeSupport
+
+    from compas_cem.optimization import Optimizer
+
+    from compas_cem.optimization import PointConstraint
+    from compas_cem.optimization import NodeLoadXParameter
+    from compas_cem.optimization import NodeLoadYParameter
+
+    from compas_cem.plotters import Plotter
+
+    # set random seed
+    seed(0)
+
+    # create a topology diagram
+    topology = TopologyDiagram()
+
+    # add nodes
+    num_nodes = 7
+    for i in range(num_nodes):
+        topology.add_node(Node(i, [float(i), 0.0, 0.0]))
+
+    # add edges with negative values for a compression-only structure
+    length = -1.0
+    for i, j in pairwise(range(num_nodes)):
+        topology.add_edge(TrailEdge(i, j, length))
+
+    # add supports
+    topology.add_support(NodeSupport(int(num_nodes - 1)))
+
+    # add initial load
+    for i in range(1, num_nodes - 1):
+        topology.add_load(NodeLoad(i, [-0.1, 0.0, 0.0]))
+
+    # calculate trails
+    topology.build_trails()
+
+    # optimization
+    optimizer = Optimizer()
+
+    # create point constraints at random
+    radius = fabs(length)
+    pt = [0., 0., 0.]
+    points = []
+    for i in range(1, num_nodes):
+        theta = 0.5 * pi * random()
+        x = radius * cos(theta)
+        y = radius * sin(theta * choice([-1., 1.]))
+        pt = Point(*add_vectors(pt, [x, y, 0.]))
+        points.append(pt)
+
+    polyline = Polyline(points)
+    for i in range(1, num_nodes - 1):
+        optimizer.add_constraint(PolylineConstraint(i, polyline))
+
+    optimizer.add_constraint(PointConstraint(num_nodes - 1, points[-1]))
+
+    for i in range(num_nodes - 1):
+        optimizer.add_parameter(NodeLoadXParameter(i, 0.5, 0.5))
+        optimizer.add_parameter(NodeLoadYParameter(i, 0.5, 0.5))
+
+    # optimize
+    cform = optimizer.solve(topology, "SLSQP", iters=500, verbose=True)
+
+    # plot
+    plotter = Plotter(figsize=(16.0, 9.0))
+
+    plotter.add(polyline, linewidth=0.5, show_points=False)
+
+    for point in points:
+        plotter.add(point, facecolor=(1, 0.5, 0.05))
+
+    plotter.add(topology)
+    plotter.add(cform)
+
+    plotter.zoom_extents()
+    plotter.show()

compas_cem/optimization/optimizer.py

@@ -37,8 +37,8 @@ class Optimizer(Data):
     def __init__(self, **kwargs):
         super(Optimizer, self).__init__(**kwargs)
 
-        self.parameters = dict()
-        self.constraints = dict()
+        self.parameters = {}
+        self.constraints = {}
 
         self.x_opt = None
         self.time_opt = None

compas_cem/optimization/parameters/load.py

@@ -77,7 +77,7 @@ if __name__ == "__main__":
     topology = TopologyDiagram()
 
     # add nodes
-    num_nodes = 3
+    num_nodes = 7
     for i in range(num_nodes):
         topology.add_node(Node(i, [float(i), 0.0, 0.0]))
 
@@ -99,6 +99,7 @@ if __name__ == "__main__":
     radius = fabs(length)
     pt = [0., 0., 0.]
     points = []
+
     for i in range(1, num_nodes):
         theta = 0.5 * pi * random()
         x = radius * cos(theta)
@@ -112,7 +113,7 @@ if __name__ == "__main__":
         optimizer.add_parameter(NodeLoadYParameter(i, 0.5, 0.5))
 
     # optimize
-    cform = optimizer.solve(topology, "LBFGS", iters=500, verbose=True)
+    cform = optimizer.solve(topology, "SLSQP", iters=500, verbose=True)
 
     # plot
     plotter = Plotter(figsize=(16.0, 9.0))
@@ -121,6 +122,7 @@ if __name__ == "__main__":
     for point in points:
         plotter.add(point, facecolor=(1, 0.5, 0.05))
 
+    plotter.add(topology)
     plotter.add(cform)
 
     plotter.zoom_extents()

compas_cem/viewers/diagramobject.py

@@ -417,6 +417,7 @@ class DiagramObject(NetworkObject):
                 continue
             edge_meshes = [meshes[edge] for edge in edges]
             color = self.edge_color[edges[0]]  # TODO: needs cleaner alternative
+
             self.viewer.add(Collection(edge_meshes),
                             facecolor=color,
                             linecolor=color,

compas_cem-0.8.2.dist-info/AUTHORS.rst

@@ -0,0 +1,41 @@
+********************************************************************************
+Citing
+********************************************************************************
+
+If you use **COMPAS CEM** for a project or research, please consider citing our journal paper:
+
+.. code-block:: latex
+
+    @article{pastrana_constrainedformfinding_2022,
+             title = {Constrained {Form}-{Finding} of {Tension}–{Compression} {Structures} using {Automatic} {Differentiation}},
+             author = {Pastrana, Rafael and Ohlbrock, Patrick Ole and Oberbichler, Thomas and D’Acunto, Pierluigi and Parascho, Stefana},
+             journal = {Computer-Aided Design},
+             doi = {10.1016/j.cad.2022.103435},
+             volume = {155},
+             issn = {0010-4485},
+             url = {https://www.sciencedirect.com/science/article/pii/S0010448522001683},
+             month = feb,
+             year = {2022}}
+
+And the code repository:
+
+.. code-block:: latex
+
+    @software{compas_cem,
+        title={{COMPAS~CEM}: The {Combinatorial Equilibrium Modeling} framework for {COMPAS}},
+        author={Pastrana, Rafael and
+                Ohlbrock, Patrick Ole and
+                D'Acunto, Pierluigi and
+                Parascho, Stefana},
+        year={2021},
+        doi={10.5281/zenodo.5705740},
+        url={https://arpastrana.github.io/compas\_cem}}
+
+
+Authors
+=======
+
+* Rafael Pastrana <arpastrana@princeton> `@arpastrana <https://github.com/arpastrana>`_
+* Ole Ohlbrock <ohlbrock@arch.ethz.ch> `@OleOhlbrock <https://github.com/OleOhlbrock>`_
+* Pierluigi D'Acunto <pierluigidacunto@tum.de> `@pierluigidacunto <https://github.com/pierluigidacunto>`_
+* Stefana Parascho <stefana.parascho@epfl.ch> `@stefanaparascho <https://github.com/stefanaparascho>`_

{compas_cem-0.7.0.dist-info → compas_cem-0.8.2.dist-info}/METADATA

@@ -1,189 +1,183 @@
-Metadata-Version: 2.1
-Name: compas-cem
-Version: 0.7.0
-Summary: The Combinatorial Equilibrium Modeling framework for COMPAS
-Home-page: https://github.com/arpastrana/compas_cem
-Author: Rafael Pastrana
-Author-email: arpj@princeton.edu
-License: MIT license
-Platform: UNKNOWN
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Scientific/Engineering
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: Unix
-Classifier: Operating System :: POSIX
-Classifier: Operating System :: Microsoft :: Windows
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-Requires-Dist: compas
-Requires-Dist: nlopt
-Requires-Dist: trimesh
-Requires-Dist: autograd
-Requires-Dist: compas-singular
-
-********************************************************************************
-COMPAS CEM
-********************************************************************************
-
-.. start-badges
-
-.. image:: https://github.com/arpastrana/compas_cem/workflows/build/badge.svg
-    :target: https://github.com/arpastrana/compas_cem/actions
-    :alt: Github Actions Build Status
-
-.. image:: https://img.shields.io/github/license/arpastrana/compas_cem.svg
-    :target: https://github.com/arpastrana/compas_cem/blob/main/LICENSE
-    :alt: License
-
-.. image:: https://img.shields.io/pypi/v/compas-cem.svg
-    :target: https://pypi.python.org/pypi/compas-cem
-    :alt: PyPI Package latest release
-
-.. image:: https://img.shields.io/pypi/pyversions/compas-cem
-   :target: https://pypi.org/project/compas-cem
-   :alt: Python versions
-
-.. image:: https://img.shields.io/badge/arXiv-2111.02607-b31b1b.svg
-   :target: https://arxiv.org/abs/2111.02607
-   :alt: ArXiv paper
-
-.. image:: https://zenodo.org/badge/278780552.svg
-   :target: https://zenodo.org/badge/latestdoi/278780552
-   :alt: Zenodo DOI
-
-.. image:: https://img.shields.io/twitter/follow/compas_dev?style=social
-   :target: https://twitter.com/compas_dev
-   :alt: Twitter follow
-
-.. end-badges
-
-.. _COMPAS: https://compas.dev/
-.. _COMPAS CEM Docs: https://arpastrana.github.io/compas_cem/latest/index.html
-.. _CEM Framework: https://arxiv.org/abs/2111.02607
-.. _Rafael Pastrana: https://pastrana.xyz/
-.. _Princeton: https://soa.princeton.edu/
-.. _Ole Ohlbrock: https://schwartz.arch.ethz.ch/Team/patrickoleohlbrock.php?lan=en
-.. _Pierluigi D'Acunto: https://www.professoren.tum.de/en/dacunto-pierluigi
-.. _Stefana Parascho: https://soa.princeton.edu/content/stefana-parascho
-.. _Anaconda: https://www.anaconda.com/
-.. _Rhino: https://www.rhino3d.com/
-.. _Blender: https://www.blender.org/
-.. _Grasshopper: https://grasshopper3d.com/
-.. _metaverse: https://apnews.com/article/meta-facebook-explaining-the-metaverse-f57e01cd5739840945e89fd668b0fa27
-
-
-
-.. figure:: ./docs/images/staircase_24_fps_128_colors.gif
-    :figclass: figure
-    :class: figure-img img-fluid
-
-
-The `Combinatorial Equilibrium Modeling (CEM) <https://arxiv.org/abs/2111.02607>`_ framework for `COMPAS`_.
-
-The `CEM framework`_ is a numerical form-finding approach to generate forms in static equilibrium for spatial bar structures subjected to combinations of tension-compression forces and design constraints.
-**COMPAS CEM** encapsulates the `CEM framework`_ into an open-source structural design tool that enables the formulation and the solution of constrained form-finding problems in plain and simple `Python <https://www.python.org/>`_ code.
-
-
-Main features
-=============
-
-* **Mix tension and compression forces:** Explore a wider spectrum of structural typologies by combining internal tension and compression forces in the same structure. Design space frames, bridges, tensegrities, and staircases and go beyond the conventional catalog of compression-only shells and cable-nets!
-
-* **Solve constrained form-finding problems efficiently via automatic differentiation:** Generate forms in static equilibrium that simultaneously meet a priori design constraints such as best-fitting a global target shape, restraining bar lengths, and controlling the reaction forces at the supports of a structure.
-
-* **Usable across different 3D modeling software and operating systems:** COMPAS CEM runs on Windows, MacOS and Linux (perhaps one day in the `metaverse`_) and it does not depend on any CAD software to work. However, it provides the necessary interfaces to be seamlessly used inside popular design environments like `Rhino`_, `Blender`_, and `Grasshopper`_. As a `COMPAS`_ extension, COMPAS CEM offers native integration and data exchange with other extensions and plugins in the COMPAS ecosystem.
-
-* **Move those sliders with the Grasshopper plugin:** Are you a `Grasshopper`_ person? Worry not. COMPAS CEM is also shipped as a precooked Grasshopper plugin to readily integrate our constrained form-finding engine into your next spaghetti pipeline 🍝.
-
-
-Installation
-============
-
-
-These are succint instructions to install **COMPAS CEM** and its `Grasshopper`_ plugin.
-For detailed guidance, please refer to the `COMPAS CEM Docs`_.
-
-Install **COMPAS CEM** in a dedicated `Anaconda`_ environment via ``pip``:
-
-::
-
-   pip install compas-cem
-
-To double-check that everything is up and running, type the following in the
-command line and hit enter:
-
-::
-
-    python -c "import compas_cem"
-
-If no errors show up, celebrate 🎉! You have a working installation of **COMPAS CEM**.
-
-
-Grasshopper plugin
-------------------
-
-Once **COMPAS CEM** was installed from the comment line, we can additionally link it to `Rhino`_ and use it as `Grasshopper`_ plugin:
-
-::
-
-    python -m compas_rhino.install -v 7.0
-
-The flag ``-v 7.0`` indicates that we will be installing **COMPAS CEM** and company in Rhino 7. If you are working with Rhino 6, replace that last bit with ``-v 6.0``.
-
-
-First steps
-===========
-
-* `COMPAS CEM Docs`_
-* `COMPAS CEM Examples <https://arpastrana.github.io/compas_cem/latest/examples.html>`_
-* `COMPAS CEM API Reference <https://arpastrana.github.io/compas_cem/latest/api.html>`_
-* `COMPAS Tutorials <https://compas.dev/compas/latest/tutorial.html>`_
-* `COMPAS API Reference <https://compas.dev/compas/latest/api.html>`_
-
-
-Are you a bug hunter?
-=====================
-
-If you find a bug or want to suggest a potential enhancement,
-please help us tackle it by filing a `report <https://github.com/arpastrana/compas_cem/issues>`_.
-
-
-Questions and feedback
-======================
-
-We encourage the use of the `COMPAS framework forum <https://forum.compas-framework.org/>`_ for questions and discussions.
-
-
-Contributing
-============
-
-Pull requests are warmly welcome! Check the `Contributor's Guide <https://github.com/arpastrana/compas_cem/blob/main/CONTRIBUTING.md>`_
-for more details.
-
-
-Citing
-======
-
-If you use **COMPAS CEM** for a project or research, please cite us using these `references <https://arpastrana.github.io/compas_cem/latest/citing.html>`_.
-
-
-Acknowledgements
-================
-
-This work has been supported in part by the U.S. National Science Foundation under grant OAC-2118201 and the `NSF Institute for Data Driven Dynamical Design <https://www.mines.edu/id4>`_.
-
-
-License
-=======
-
-MIT
-
-
+Metadata-Version: 2.1
+Name: compas-cem
+Version: 0.8.2
+Summary: The Combinatorial Equilibrium Modeling framework for COMPAS
+Home-page: https://github.com/arpastrana/compas_cem
+Author: Rafael Pastrana
+Author-email: arpj@princeton.edu
+License: MIT license
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Scientific/Engineering
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Unix
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: numpy==1.26.3
+Requires-Dist: compas==1.17.10
+Requires-Dist: trimesh==3.20.0
+Requires-Dist: autograd==1.5
+Requires-Dist: nlopt
+
+********************************************************************************
+COMPAS CEM
+********************************************************************************
+
+.. start-badges
+
+.. image:: https://github.com/arpastrana/compas_cem/workflows/build/badge.svg
+    :target: https://github.com/arpastrana/compas_cem/actions
+    :alt: Github Actions Build Status
+
+.. image:: https://img.shields.io/github/license/arpastrana/compas_cem.svg
+    :target: https://github.com/arpastrana/compas_cem/blob/main/LICENSE
+    :alt: License
+
+.. image:: https://img.shields.io/pypi/v/compas-cem.svg
+    :target: https://pypi.python.org/pypi/compas-cem
+    :alt: PyPI Package latest release
+
+.. image:: https://img.shields.io/pypi/pyversions/compas-cem
+   :target: https://pypi.org/project/compas-cem
+   :alt: Python versions
+
+.. image:: https://img.shields.io/badge/arXiv-2111.02607-b31b1b.svg
+   :target: https://arxiv.org/abs/2111.02607
+   :alt: ArXiv paper
+
+.. image:: https://zenodo.org/badge/278780552.svg
+   :target: https://zenodo.org/badge/latestdoi/278780552
+   :alt: Zenodo DOI
+
+.. end-badges
+
+.. _COMPAS: https://compas.dev/
+.. _COMPAS CEM Docs: https://arpastrana.github.io/compas_cem/latest/index.html
+.. _CEM Framework: https://doi.org/10.1016/j.cad.2022.103435
+.. _Rafael Pastrana: https://pastrana.xyz/
+.. _Princeton: https://soa.princeton.edu/
+.. _Ole Ohlbrock: https://schwartz.arch.ethz.ch/Team/patrickoleohlbrock.php?lan=en
+.. _Pierluigi D'Acunto: https://www.professoren.tum.de/en/dacunto-pierluigi
+.. _Stefana Parascho: https://people.epfl.ch/stefana.parascho?lang=en
+.. _Anaconda: https://www.anaconda.com/
+.. _Rhino: https://www.rhino3d.com/
+.. _Blender: https://www.blender.org/
+.. _Grasshopper: https://grasshopper3d.com/
+.. _metaverse: https://apnews.com/article/meta-facebook-explaining-the-metaverse-f57e01cd5739840945e89fd668b0fa27
+
+
+.. figure:: ./docs/images/staircase_24_fps_128_colors.gif
+    :figclass: figure
+    :class: figure-img img-fluid
+
+
+The `Combinatorial Equilibrium Modeling (CEM) <https://doi.org/10.1016/j.cad.2022.103435>`_ framework for `COMPAS`_.
+
+The `CEM framework`_ is a numerical form-finding approach to generate forms in static equilibrium for spatial bar structures subjected to combinations of tension-compression forces and design constraints.
+**COMPAS CEM** encapsulates the `CEM framework`_ into an open-source structural design tool that enables the formulation and the solution of constrained form-finding problems in plain and simple `Python <https://www.python.org/>`_ code.
+
+
+Main features
+=============
+
+* **Mix tension and compression forces:** Explore a wider spectrum of structural typologies by combining internal tension and compression forces in the same structure. Design space frames, bridges, tensegrities, and staircases and go beyond the conventional catalog of compression-only shells and cable-nets!
+
+* **Solve constrained form-finding problems efficiently via automatic differentiation:** Generate forms in static equilibrium that simultaneously meet a priori design constraints such as best-fitting a global target shape, restraining bar lengths, and controlling the reaction forces at the supports of a structure.
+
+* **Usable across different 3D modeling software and operating systems:** COMPAS CEM runs on Windows, MacOS and Linux (perhaps one day in the `metaverse`_) and it does not depend on any CAD software to work. However, it provides the necessary interfaces to be seamlessly used inside popular design environments like `Rhino`_, `Blender`_, and `Grasshopper`_. As a `COMPAS`_ extension, COMPAS CEM offers native integration and data exchange with other extensions and plugins in the COMPAS ecosystem.
+
+* **Move those sliders with the Grasshopper plugin:** Are you a `Grasshopper`_ person? Worry not. COMPAS CEM is also shipped as a precooked Grasshopper plugin to readily integrate our constrained form-finding engine into your next spaghetti pipeline 🍝.
+
+
+Installation
+============
+
+
+These are succint instructions to install **COMPAS CEM** and its `Grasshopper`_ plugin.
+For detailed guidance, please refer to the `COMPAS CEM Docs`_.
+
+Install **COMPAS CEM** in a dedicated `Anaconda`_ environment via ``pip``:
+
+::
+
+   pip install compas-cem
+
+To double-check that everything is up and running, type the following in the
+command line and hit enter:
+
+::
+
+    python -c "import compas_cem"
+
+If no errors show up, celebrate 🎉! You have a working installation of **COMPAS CEM**.
+
+
+Grasshopper plugin
+------------------
+
+**Warning**: Note that `Grasshopper`_ plugin of **COMPAS CEM** is only supported in **Rhino 6** and **Rhino 7**.
+
+Once **COMPAS CEM** was installed from the comment line, we can additionally link it to `Rhino`_ and use it as `Grasshopper`_ plugin:
+
+::
+
+    python -m compas_rhino.install -v 7.0
+
+The flag ``-v 7.0`` indicates that we will be installing **COMPAS CEM** and company in Rhino 7. If you are working with Rhino 6, replace that last bit with ``-v 6.0``.
+
+
+First steps
+===========
+
+* `COMPAS CEM Docs`_
+* `COMPAS CEM Examples <https://arpastrana.github.io/compas_cem/latest/examples.html>`_
+* `COMPAS CEM API Reference <https://arpastrana.github.io/compas_cem/latest/api.html>`_
+* `COMPAS Tutorials <https://compas.dev/compas/latest/tutorial.html>`_
+* `COMPAS API Reference <https://compas.dev/compas/latest/api.html>`_
+
+
+Are you a bug hunter?
+=====================
+
+If you find a bug or want to suggest a potential enhancement,
+please help us tackle it by filing a `report <https://github.com/arpastrana/compas_cem/issues>`_.
+
+
+Questions and feedback
+======================
+
+We encourage the use of the `COMPAS framework forum <https://forum.compas-framework.org/>`_ for questions and discussions.
+
+
+Contributing
+============
+
+Pull requests are warmly welcome! Check the `Contributor's Guide <https://github.com/arpastrana/compas_cem/blob/main/CONTRIBUTING.md>`_
+for more details.
+
+
+Citing
+======
+
+If you use **COMPAS CEM** for a project or research, please cite us using these `references <https://arpastrana.github.io/compas_cem/latest/citing.html>`_.
+
+
+Acknowledgements
+================
+
+This work has been supported in part by the U.S. National Science Foundation under grant OAC-2118201 and the `NSF Institute for Data Driven Dynamical Design <https://www.mines.edu/id4>`_.
+
+
+License
+=======
+
+MIT