compas-masonry 0.2.1__tar.gz

compas_masonry-0.2.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+ETH Zurich - Block Research Group
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

compas_masonry-0.2.1/PKG-INFO

@@ -0,0 +1,135 @@
+Metadata-Version: 2.4
+Name: compas_masonry
+Version: 0.2.1
+Summary: COMPAS Masonry is a masonry assessment toolbox for Rhino based on the COMPAS framework.
+Author-email: tom van mele <tom.v.mele@gmail.com>
+License: MIT License
+        
+        ETH Zurich - Block Research Group
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://blockresearchgroup.github.io/compas_masonry
+Project-URL: Documentation, https://blockresearchgroup.github.io/compas_masonry
+Project-URL: Repository, https://github.com/blockresearchgroup/compas_masonry
+Project-URL: Changelog, https://github.com/blockresearchgroup/compas_masonry/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/blockresearchgroup/compas_masonry/issues
+Project-URL: Forum, https://forum.compas-framework.org/
+Classifier: Development Status :: 4 - Beta
+Classifier: Topic :: Scientific/Engineering
+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.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cvxpy
+Requires-Dist: compas>=2.14.1
+Requires-Dist: compas_cgal>=0.9.1
+Requires-Dist: compas_dem>=0.4
+Requires-Dist: compas_libigl>=0.7.6
+Requires-Dist: compas_rui>=0.6
+Requires-Dist: compas_session>=0.7
+Requires-Dist: compas_tna>=0.7
+Requires-Dist: compas_tno>=0.3
+Provides-Extra: dev
+Requires-Dist: bump-my-version; extra == "dev"
+Requires-Dist: compas_invocations2; extra == "dev"
+Requires-Dist: invoke>=0.14; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: sphinx_compas2_theme; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Dynamic: license-file
+
+# COMPAS Masonry
+
+> [!WARNING]
+> This plugin is under active development,
+> and its functionality will frequently change.
+
+![COMPAS Masonry](compas-Masonry.png)
+
+COMPAS Masonry is a plugin for Rhino for the assessment of masonry structures,
+and for the stability analsis of Discrete Element Models in general.
+
+The current version of this plugin is based on COMPAS 2 and is available for Rhino 8.
+
+## Installation
+
+To install COMPAS-Masonry, use Rhino's package manager Yak.
+To open Yak, type `PackageManager` on the Rhino command line.
+
+![COMPAS-Masonry installation with Yak](/gitbook/.gitbook/assets/COMPAS-Masonry_yak.png)
+
+## COMPAS Packages
+
+COMPAS-Masonry uses the following COMPAS packages:
+
+* [compas](https://github.com/compas-dev/compas)
+* [compas_assembly](https://github.com/blockresearchgroup/compas_assembly)
+* [compas_model](https://github.com/blockresearchgroup/compas_model)
+* [compas_rui](https://github.com/blockresearchgroup/compas_rui)
+* [compas_session](https://github.com/blockresearchgroup/compas_session)
+
+After installing RhinoVAULT with Yak, these requirements will be installed automatically if necessary.
+The tool might be unresponsive during this process, which might take up to 1 or 2 mins.
+The packages are installed in a separate virtual environment named `COMPAS-Masonry`.
+
+> [!NOTE]
+> Note that COMPAS-Masonry currently doesn't include any solvers
+> (such as [compas_cra](https://github.com/blockresearchgroup/compas_cra)) yet.
+> This is because they have dependencies that are still difficult to install in Rhino.
+
+## User Interface
+
+COMPAS-Masonry defines the following Rhino commands:
+
+* `Masonry`
+* `Masonry_session_undo`
+* `Masonry_session_redo`
+* `Masonry_session_open`
+* `Masonry_session_save`
+* `Masonry_scene_clear`
+* `Masonry_scene_redraw`
+* `Masonry_settings`
+
+These commands can be executed using the Rhino command line (simply start typing the command name),
+or with the corresponding buttons of the COMPAS-Masonry toolbar.
+
+![COMPAS-Masonry toolbar](/gitbook/.gitbook/assets/COMPAS-Masonry_toolbar.png)
+
+If the toolbar is not visible after installing COMPAS-Masonry,
+you can load it from the "Toolbars" page.
+To open the "Toolbars" page, type `Toolbar` on the Rhino command line...
+
+![Rhino Toolbars](/gitbook/.gitbook/assets/Rhino_toolbars.png)
+
+## Documentation
+
+For further "getting started" instructions, a tutorial, examples, and an detailed description of the individual commands and the user interface, please check out the online documentation here: [COMPAS-Masonry Gitbook](https://blockresearchgroup.gitbook.io/COMPAS-Masonry)
+
+## Issues
+
+Please report problems using the issue tracker of the github repo: <https://github.com/blockresearchgroup/compas-Masonry/issues>

compas_masonry-0.2.1/README.md

@@ -0,0 +1,70 @@
+# COMPAS Masonry
+
+> [!WARNING]
+> This plugin is under active development,
+> and its functionality will frequently change.
+
+![COMPAS Masonry](compas-Masonry.png)
+
+COMPAS Masonry is a plugin for Rhino for the assessment of masonry structures,
+and for the stability analsis of Discrete Element Models in general.
+
+The current version of this plugin is based on COMPAS 2 and is available for Rhino 8.
+
+## Installation
+
+To install COMPAS-Masonry, use Rhino's package manager Yak.
+To open Yak, type `PackageManager` on the Rhino command line.
+
+![COMPAS-Masonry installation with Yak](/gitbook/.gitbook/assets/COMPAS-Masonry_yak.png)
+
+## COMPAS Packages
+
+COMPAS-Masonry uses the following COMPAS packages:
+
+* [compas](https://github.com/compas-dev/compas)
+* [compas_assembly](https://github.com/blockresearchgroup/compas_assembly)
+* [compas_model](https://github.com/blockresearchgroup/compas_model)
+* [compas_rui](https://github.com/blockresearchgroup/compas_rui)
+* [compas_session](https://github.com/blockresearchgroup/compas_session)
+
+After installing RhinoVAULT with Yak, these requirements will be installed automatically if necessary.
+The tool might be unresponsive during this process, which might take up to 1 or 2 mins.
+The packages are installed in a separate virtual environment named `COMPAS-Masonry`.
+
+> [!NOTE]
+> Note that COMPAS-Masonry currently doesn't include any solvers
+> (such as [compas_cra](https://github.com/blockresearchgroup/compas_cra)) yet.
+> This is because they have dependencies that are still difficult to install in Rhino.
+
+## User Interface
+
+COMPAS-Masonry defines the following Rhino commands:
+
+* `Masonry`
+* `Masonry_session_undo`
+* `Masonry_session_redo`
+* `Masonry_session_open`
+* `Masonry_session_save`
+* `Masonry_scene_clear`
+* `Masonry_scene_redraw`
+* `Masonry_settings`
+
+These commands can be executed using the Rhino command line (simply start typing the command name),
+or with the corresponding buttons of the COMPAS-Masonry toolbar.
+
+![COMPAS-Masonry toolbar](/gitbook/.gitbook/assets/COMPAS-Masonry_toolbar.png)
+
+If the toolbar is not visible after installing COMPAS-Masonry,
+you can load it from the "Toolbars" page.
+To open the "Toolbars" page, type `Toolbar` on the Rhino command line...
+
+![Rhino Toolbars](/gitbook/.gitbook/assets/Rhino_toolbars.png)
+
+## Documentation
+
+For further "getting started" instructions, a tutorial, examples, and an detailed description of the individual commands and the user interface, please check out the online documentation here: [COMPAS-Masonry Gitbook](https://blockresearchgroup.gitbook.io/COMPAS-Masonry)
+
+## Issues
+
+Please report problems using the issue tracker of the github repo: <https://github.com/blockresearchgroup/compas-Masonry/issues>

compas_masonry-0.2.1/pyproject.toml

@@ -0,0 +1,144 @@
+[build-system]
+requires = ["setuptools>=66.0"]
+build-backend = "setuptools.build_meta"
+
+# ============================================================================
+# project info
+# ============================================================================
+
+[project]
+name = "compas_masonry"
+description = "COMPAS Masonry is a masonry assessment toolbox for Rhino based on the COMPAS framework."
+keywords = []
+authors = [{ name = "tom van mele", email = "tom.v.mele@gmail.com" }]
+license = { file = "LICENSE" }
+readme = "README.md"
+requires-python = ">=3.9"
+dynamic = ['dependencies', 'optional-dependencies', 'version']
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Topic :: Scientific/Engineering",
+  "Operating System :: Unix",
+  "Operating System :: POSIX",
+  "Operating System :: Microsoft :: Windows",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+]
+
+[project.urls]
+Homepage = "https://blockresearchgroup.github.io/compas_masonry"
+Documentation = "https://blockresearchgroup.github.io/compas_masonry"
+Repository = "https://github.com/blockresearchgroup/compas_masonry"
+Changelog = "https://github.com/blockresearchgroup/compas_masonry/blob/main/CHANGELOG.md"
+Issues = "https://github.com/blockresearchgroup/compas_masonry/issues"
+Forum = "https://forum.compas-framework.org/"
+
+# ============================================================================
+# scripts
+# ============================================================================
+
+# ============================================================================
+# setuptools config
+# ============================================================================
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+include-package-data = true
+zip-safe = false
+
+[tool.setuptools.dynamic]
+version = { attr = "compas_masonry.__version__" }
+dependencies = { file = "requirements.txt" }
+optional-dependencies = { dev = { file = "requirements-dev.txt" } }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+# ============================================================================
+# replace pytest.ini
+# ============================================================================
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+testpaths = ["tests", "src/compas_masonry"]
+python_files = ["test_*.py", "*_test.py", "test.py"]
+addopts = [
+  "-ra",
+  "--strict-markers",
+  "--doctest-glob=*.rst",
+  "--tb=short",
+  "--import-mode=importlib",
+]
+doctest_optionflags = [
+  "NORMALIZE_WHITESPACE",
+  "IGNORE_EXCEPTION_DETAIL",
+  "ALLOW_UNICODE",
+  "ALLOW_BYTES",
+  "NUMBER",
+]
+
+# ============================================================================
+# replace bumpversion.cfg
+# ============================================================================
+
+[tool.bumpversion]
+current_version = "0.2.1"
+message = "Bump version to {new_version}"
+commit = true
+tag = true
+
+[[tool.bumpversion.files]]
+filename = "src/compas_masonry/__init__.py"
+search = "{current_version}"
+replace = "{new_version}"
+
+[[tool.bumpversion.files]]
+filename = "CHANGELOG.md"
+search = "Unreleased"
+replace = "[{new_version}] {now:%Y-%m-%d}"
+
+# ============================================================================
+# replace setup.cfg
+# ============================================================================
+
+[tool.black]
+line-length = 179
+
+[tool.ruff]
+line-length = 179
+indent-width = 4
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["I001"]
+"tests/*" = ["I001"]
+"tasks.py" = ["I001"]
+
+[tool.ruff.lint.isort]
+force-single-line = true
+known-first-party = [
+  "compas",
+  "compas_session",
+  "compas_rui",
+  "compas_masonry",
+  "compas_tna",
+  "compas_tno",
+  "compas_dem",
+  "compas_rhino",
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.ruff.lint.pycodestyle]
+max-doc-length = 179
+
+[tool.ruff.format]
+docstring-code-format = true
+docstring-code-line-length = "dynamic"

compas_masonry-0.2.1/requirements-dev.txt

@@ -0,0 +1,7 @@
+bump-my-version
+compas_invocations2
+invoke >=0.14
+ruff
+sphinx_compas2_theme
+twine
+wheel

compas_masonry-0.2.1/requirements.txt

@@ -0,0 +1,10 @@
+cvxpy
+compas >=2.14.1
+# compas_3dec
+compas_cgal >=0.9.1
+compas_dem >=0.4
+compas_libigl >=0.7.6
+compas_rui >=0.6
+compas_session >=0.7
+compas_tna >=0.7
+compas_tno >=0.3

compas_masonry-0.2.1/setup.cfg

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

compas_masonry-0.2.1/src/compas_masonry/__init__.py

@@ -0,0 +1,3 @@
+__version__ = "0.2.1"
+
+__all_plugins__ = ["compas_masonry.scene"]

compas_masonry-0.2.1/src/compas_masonry/__main__.py

@@ -0,0 +1,2 @@
+if __name__ == "__main__":
+    pass

compas_masonry-0.2.1/src/compas_masonry/forms/settings.py

@@ -0,0 +1,203 @@
+#! python3
+# venv: brg-csd
+# r: compas_masonry
+
+from typing import Union
+
+import Eto.Drawing as drawing  # type: ignore
+import Eto.Forms as forms  # type: ignore
+import Rhino  # type: ignore
+import Rhino.UI  # type: ignore
+from pydantic import BaseModel
+from pydantic import Field
+
+from compas.colors import Color
+from compas_session.settings import Settings
+
+
+def field_ge(field):
+    """Get the 'greater than or equal to' constraint from a Pydantic field.
+
+    Parameters
+    ----------
+    field : ModelField
+        The Pydantic model field.
+
+    Returns
+    -------
+    float or int or None
+        The 'greater than or equal to' constraint if it exists, otherwise None.
+
+    """
+    ge = None
+    for m in field.metadata:
+        if hasattr(m, "ge"):
+            ge = m.ge
+            break
+    return ge
+
+
+def field_le(field):
+    """Get the 'less than or equal to' constraint from a Pydantic field.
+
+    Parameters
+    ----------
+    field : ModelField
+        The Pydantic model field.
+
+    Returns
+    -------
+    float or int or None
+        The 'less than or equal to' constraint if it exists, otherwise None.
+
+    """
+    le = None
+    for m in field.metadata:
+        if hasattr(m, "le"):
+            le = m.le
+            break
+    return le
+
+
+class SettingsForm(forms.Dialog[bool]):
+    """A dynamic form for editing Pydantic models.
+
+    Parameters
+    ----------
+    model_cls : Type[BaseModel]
+        The Pydantic model class to create the form for.
+    width : int, optional
+        The width of the form, by default 400.
+
+    """
+
+    def __init__(self, model: Union[Settings, BaseModel], title: str = "Settings", width: int = 400):
+        super().__init__()
+        self.ClientSize = drawing.Size(width, -1)
+        self.model = model
+        self.model_cls = type(model)
+        self.controls = {}
+        self.Title = title
+
+        self.Content = self._build_layout()
+
+        self.DefaultButton = self.ok_button
+        self.AbortButton = self.cancel_button
+
+    def _build_layout(self):
+        layout = forms.DynamicLayout()
+        layout.Padding = drawing.Padding(10)
+        layout.Spacing = drawing.Size(10, 10)
+
+        for name, field in self.model_cls.model_fields.items():
+            if issubclass(field.annotation, BaseModel):  # type: ignore
+                continue
+
+            text = field.title or name.replace("_", " ").capitalize()
+            label = forms.Label()
+            label.Text = text
+            control = self._create_control(name, field, field.default)
+            self.controls[name] = control
+            layout.AddRow(label, control)
+
+        layout.AddRow(None)
+
+        self.ok_button = forms.Button()
+        self.ok_button.Text = "OK"
+        self.ok_button.Click += self._on_ok
+
+        self.cancel_button = forms.Button()
+        self.cancel_button.Text = "Cancel"
+        self.cancel_button.Click += self._on_cancel
+
+        layout.AddRow(None, self.ok_button, self.cancel_button)
+        return layout
+
+    def _create_control(self, name, field, default):
+        if field.annotation is str:
+            value = getattr(self.model, name, default) or ""
+            control = forms.TextBox()
+            control.Text = value
+
+        elif field.annotation is int:
+            value = getattr(self.model, name, default) or 0
+            control = forms.NumericUpDown()
+            control.Value = value
+            control.MinValue = field_ge(field)
+            control.MaxValue = field_le(field)
+
+        elif field.annotation is float:
+            value = getattr(self.model, name, default) or 0.0
+            control = forms.NumericUpDown()
+            control.Value = value
+            control.DecimalPlaces = 3
+            control.MinValue = field_ge(field)
+            control.MaxValue = field_le(field)
+
+        elif field.annotation is bool:
+            value = getattr(self.model, name, default) or False
+            control = forms.CheckBox()
+            control.Checked = value
+
+        elif (
+            field.annotation is tuple
+            and hasattr(field, "default")
+            and isinstance(field.default, tuple)
+            and len(field.default) == 4
+            and all(isinstance(x, int) for x in field.default)
+        ):
+            value = getattr(self.model, name, default) or (255, 255, 255, 255)
+            color = drawing.Color.FromArgb(*value)
+            control = forms.ColorPicker()
+            control.Value = color
+
+        else:
+            value = getattr(self.model, name, default) or ""
+            control = forms.TextBox()
+            control.Text = str(value)
+
+        return control
+
+    def _on_ok(self, sender, e):
+        values = {}
+        for name, control in self.controls.items():
+            if isinstance(control, forms.TextBox):
+                values[name] = control.Text
+            elif isinstance(control, forms.NumericUpDown):
+                values[name] = control.Value
+            elif isinstance(control, forms.CheckBox):
+                values[name] = control.Checked
+            elif isinstance(control, forms.ColorPicker):
+                c = control.Value
+                values[name] = (c.R, c.G, c.B, c.A)
+        try:
+            for key, value in values.items():
+                setattr(self.model, key, value)
+            self.Close(True)
+        except Exception as ex:
+            forms.MessageBox.Show(str(ex), "Validation Error")
+
+    def _on_cancel(self, sender, e):
+        self.Close(False)
+
+    def show(self):
+        return self.ShowModal(Rhino.UI.RhinoEtoApp.MainWindow)
+
+
+# =============================================================================
+# Run as main
+# =============================================================================
+
+if __name__ == "__main__":
+
+    class TestSettings(BaseModel):
+        name: str = Field("Default", title="Name", description="Enter your name")
+        age: int = Field(30, title="Age", ge=0, le=120)
+        is_active: bool = Field(True, title="Active")
+        color: tuple = Field(Color.white().rgba255, title="Color", description="Pick a color")
+
+    settings = TestSettings(name="Alice", age=28, is_active=True, color=Color.red().rgba255)
+    dialog = SettingsForm(settings)  # type: ignore
+
+    if dialog.ShowModal(Rhino.UI.RhinoEtoApp.MainWindow):
+        print(dialog.model)

compas_masonry-0.2.1/src/compas_masonry/scene/__init__.py

@@ -0,0 +1,13 @@
+from compas.plugins import plugin
+from compas.scene.context import register
+
+from compas_tna.diagrams import FormDiagram
+from .formobject import RhinoFormDiagramObject
+
+# this clashes with TNA and/or RV
+# we need a strategy for this
+
+
+@plugin(category="factories", pluggable_name="register_scene_objects", requires=["Rhino"])
+def register_scene_objects_rhino():
+    register(FormDiagram, RhinoFormDiagramObject, context="Rhino")