compas-brep 0.1.0__tar.gz

compas_brep-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Gramazio Kohler Research
+
+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_brep-0.1.0/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.3
+Name: compas-brep
+Version: 0.1.0
+Summary: Canonical Brep wrapper based on COMPAS framework with pluggable OCC/Rhino backends
+Author: Chen Kasirer
+Author-email: Chen Kasirer <kasirer@arch.ethz.ch>
+License: MIT License
+         
+         Copyright (c) 2026 Gramazio Kohler Research
+         
+         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.
+Requires-Dist: compas>=2.0
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: invoke ; extra == 'dev'
+Requires-Dist: ruff ; extra == 'dev'
+Requires-Dist: pytest ; extra == 'dev'
+Requires-Dist: compas-invocations2[mkdocs] ; extra == 'dev'
+Requires-Dist: bump-my-version ; extra == 'dev'
+Requires-Dist: twine ; extra == 'dev'
+Requires-Dist: wheel ; extra == 'dev'
+Requires-Dist: build ; extra == 'dev'
+Requires-Dist: mkdocstrings[python] ; extra == 'docs'
+Requires-Dist: cadquery-ocp-novtk>=7.8 ; python_full_version >= '3.10' and extra == 'occ'
+Requires-Dist: compas-viewer>=1.0 ; extra == 'occ'
+Requires-Python: >=3.9
+Project-URL: Repository, https://github.com/gramaziokohler/compas_brep
+Provides-Extra: dev
+Provides-Extra: docs
+Provides-Extra: occ
+Description-Content-Type: text/markdown
+
+# compas_brep
+
+[![Github Actions Build Status](https://github.com/gramaziokohler/compas_brep/actions/workflows/build.yml/badge.svg)](https://github.com/gramaziokohler/compas_brep/actions)
+[![License](https://img.shields.io/github/license/gramaziokohler/compas_brep.svg)](https://pypi.python.org/pypi/compas-brep)
+[![PyPI Package latest release](https://img.shields.io/pypi/v/compas-brep.svg)](https://pypi.python.org/pypi/compas-brep)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/compas-brep.svg)](https://pypi.python.org/pypi/compas-brep)
+[![Made with COMPAS](https://compas.dev/badge.svg)](https://compas.dev/#/)
+
+A unified Brep wrapper for the [COMPAS](https://github.com/compas-dev/compas) framework with pluggable OCC and Rhino backends.
+
+Provides a single `Brep` class with a stable public interface. The backend (OCC or Rhino) is selected automatically at runtime based on what is importable. All inputs and outputs are COMPAS types — never backend types.
+
+Examples in `examples/` have mostly been copied from [COMPAS OCC](https://github.com/compas-dev/compas_occ) which is used as benchmark for this project.
+
+## Installation
+
+**Base (no backend):**
+
+```bash
+pip install compas_brep
+```
+
+**With [OCC backend](https://github.com/CadQuery/OCP):**
+
+```bash
+pip install "compas_brep[occ]"
+```
+
+The Rhino backend is available automatically when running inside Rhino.
+
+## Usage
+
+```python
+import os
+from compas_brep import Brep, DATA
+from compas_viewer import Viewer
+
+brep = Brep.from_step(os.path.join(DATA, "box_with_holes.stp"))
+
+for face in brep.faces:
+    print(face.surface)  # Plane for flat faces, NurbsSurface for curved faces
+
+viewer = Viewer()
+viewer.scene.add(brep)
+
+viewer.show()
+
+```
+
+## Running tests
+
+Install the OCC backend and run:
+
+```bash
+uv pip install "cadquery-ocp-novtk>=7.8"
+pytest -m occ -q
+```

compas_brep-0.1.0/README.md

@@ -0,0 +1,57 @@
+# compas_brep
+
+[![Github Actions Build Status](https://github.com/gramaziokohler/compas_brep/actions/workflows/build.yml/badge.svg)](https://github.com/gramaziokohler/compas_brep/actions)
+[![License](https://img.shields.io/github/license/gramaziokohler/compas_brep.svg)](https://pypi.python.org/pypi/compas-brep)
+[![PyPI Package latest release](https://img.shields.io/pypi/v/compas-brep.svg)](https://pypi.python.org/pypi/compas-brep)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/compas-brep.svg)](https://pypi.python.org/pypi/compas-brep)
+[![Made with COMPAS](https://compas.dev/badge.svg)](https://compas.dev/#/)
+
+A unified Brep wrapper for the [COMPAS](https://github.com/compas-dev/compas) framework with pluggable OCC and Rhino backends.
+
+Provides a single `Brep` class with a stable public interface. The backend (OCC or Rhino) is selected automatically at runtime based on what is importable. All inputs and outputs are COMPAS types — never backend types.
+
+Examples in `examples/` have mostly been copied from [COMPAS OCC](https://github.com/compas-dev/compas_occ) which is used as benchmark for this project.
+
+## Installation
+
+**Base (no backend):**
+
+```bash
+pip install compas_brep
+```
+
+**With [OCC backend](https://github.com/CadQuery/OCP):**
+
+```bash
+pip install "compas_brep[occ]"
+```
+
+The Rhino backend is available automatically when running inside Rhino.
+
+## Usage
+
+```python
+import os
+from compas_brep import Brep, DATA
+from compas_viewer import Viewer
+
+brep = Brep.from_step(os.path.join(DATA, "box_with_holes.stp"))
+
+for face in brep.faces:
+    print(face.surface)  # Plane for flat faces, NurbsSurface for curved faces
+
+viewer = Viewer()
+viewer.scene.add(brep)
+
+viewer.show()
+
+```
+
+## Running tests
+
+Install the OCC backend and run:
+
+```bash
+uv pip install "cadquery-ocp-novtk>=7.8"
+pytest -m occ -q
+```

compas_brep-0.1.0/pyproject.toml

@@ -0,0 +1,88 @@
+[build-system]
+requires = ["uv_build>=0.10.2,<0.11.0"]
+build-backend = "uv_build"
+
+# ============================================================================
+# project info
+# ============================================================================
+
+[project]
+name = "compas-brep"
+version = "0.1.0"
+description = "Canonical Brep wrapper based on COMPAS framework with pluggable OCC/Rhino backends"
+readme = "README.md"
+authors = [
+    { name = "Chen Kasirer", email = "kasirer@arch.ethz.ch" }
+]
+requires-python = ">=3.9"
+license = { file = "LICENSE" }
+dependencies = [
+    "compas>=2.0",
+    "numpy",
+    "scipy",
+]
+
+[project.urls]
+Repository = "https://github.com/gramaziokohler/compas_brep"
+
+[project.optional-dependencies]
+occ = ["cadquery-ocp-novtk>=7.8; python_version >= '3.10'", "compas_viewer>=1.0"]
+dev = [
+    "invoke",
+    "ruff",
+    "pytest",
+    "compas_invocations2[mkdocs]",
+    "bump-my-version",
+    "twine",
+    "wheel",
+    "build",
+]
+docs = [
+    #"zensical",  # TODO: this works, need to figure our how to use with mike and add to compas-actions.
+    "mkdocstrings[python]",
+]
+
+# ============================================================================
+# Linting and formatting
+# ============================================================================
+
+[tool.ruff]
+line-length = 179
+target-version = "py313"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"]
+
+[tool.ruff.lint.isort]
+force-single-line = true
+
+[tool.ruff.format]
+quote-style = "double"
+
+# ============================================================================
+# Testing
+# ============================================================================
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-m occ"
+
+# ============================================================================
+# Release 
+# ============================================================================
+
+[tool.bumpversion]
+current_version = "0.1.0"
+message = "Bump version to {new_version}"
+commit = true
+tag = true
+
+[[tool.bumpversion.files]]
+filename = "src/compas_brep/__init__.py"
+search = "{current_version}"
+replace = "{new_version}"
+
+[[tool.bumpversion.files]]
+filename = "CHANGELOG.md"
+search = "Unreleased"
+replace = "[{new_version}] {now:%Y-%m-%d}"

compas_brep-0.1.0/src/compas_brep/__init__.py

@@ -0,0 +1,45 @@
+"""compas_brep: Pure Python Brep implementation based on the COMPAS framework."""
+
+__version__ = "0.1.0"
+
+import os
+
+from compas_brep.brep import Brep
+from compas_brep.curves import NurbsCurve
+from compas_brep.edge import BrepEdge
+from compas_brep.errors import BrepError
+from compas_brep.errors import BrepFilletError
+from compas_brep.errors import BrepInvalidError
+from compas_brep.errors import BrepTrimmingError
+from compas_brep.face import BrepFace
+from compas_brep.loop import BrepLoop
+from compas_brep.surfaces import NurbsSurface
+from compas_brep.trim import BrepTrim
+from compas_brep.vertex import BrepVertex
+
+DATA = os.path.join(os.path.dirname(__file__), "data")
+
+
+__all_plugins__ = [
+    "compas_brep.scene",
+    "compas_brep.backend.occ.plugins",
+    "compas_brep.backend.rhino.plugins",
+    "compas_brep.scene.viewer",
+    "compas_brep.scene.rhino",
+]
+
+__all__ = [
+    "DATA",
+    "Brep",
+    "BrepVertex",
+    "BrepEdge",
+    "BrepLoop",
+    "BrepFace",
+    "BrepTrim",
+    "NurbsCurve",
+    "NurbsSurface",
+    "BrepError",
+    "BrepInvalidError",
+    "BrepTrimmingError",
+    "BrepFilletError",
+]

compas_brep-0.1.0/src/compas_brep/backend/__init__.py

@@ -0,0 +1,50 @@
+"""Backend implementations for compas_brep.
+
+This package contains pluggable backend sub-packages for different geometry kernels.
+Each backend is a sub-package with logically split modules:
+
+- **OCC** (``occ/``): Uses cadquery-ocp-novtk.
+  - ``occ/conversion.py`` — bidirectional OCC ↔ Brep conversion
+  - ``occ/factories.py``  — primitive constructors and shape builders
+  - ``occ/operations.py`` — boolean and geometric operations
+  - ``occ/queries.py``    — property queries and tessellation
+  - ``occ/io.py``         — STEP/STL/IGES import and export
+  - ``occ/plugins.py``    — COMPAS plugin registrations
+
+- **Rhino** (``rhino/``): Uses Rhino.Geometry.
+  - ``rhino/conversion.py`` — bidirectional Rhino ↔ Brep conversion
+  - ``rhino/factories.py``  — primitive constructors and shape builders
+  - ``rhino/operations.py`` — boolean and geometric operations
+  - ``rhino/io.py``         — STEP import and export
+  - ``rhino/plugins.py``    — COMPAS plugin registrations
+
+The plugin modules are only loaded by the COMPAS plugin system when the
+corresponding kernel is available (``requires=["OCP"]`` or ``requires=["Rhino"]``).
+They are **not** imported at package level so that ``compas_brep`` remains
+importable in any environment.
+"""
+
+from .occ.topology import OccBrepEdge as OccBrepEdge
+from .occ.topology import OccBrepFace as OccBrepFace
+from .occ.topology import OccBrepLoop as OccBrepLoop
+from .occ.topology import OccBrepTrim as OccBrepTrim
+from .occ.topology import OccBrepVertex as OccBrepVertex
+from .rhino.topology import RhinoBrepEdge as RhinoBrepEdge
+from .rhino.topology import RhinoBrepFace as RhinoBrepFace
+from .rhino.topology import RhinoBrepLoop as RhinoBrepLoop
+from .rhino.topology import RhinoBrepTrim as RhinoBrepTrim
+from .rhino.topology import RhinoBrepVertex as RhinoBrepVertex
+
+try:
+    from .occ.conversion import brep_to_occ as brep_to_occ
+    from .occ.conversion import occ_to_brep as occ_to_brep
+except ImportError:
+    pass
+
+try:
+    from .rhino.conversion import brep_to_rhino as brep_to_rhino
+    from .rhino.conversion import nurbs_curve_to_rhino as nurbs_curve_to_rhino
+    from .rhino.conversion import nurbs_surface_to_rhino as nurbs_surface_to_rhino
+    from .rhino.conversion import rhino_to_brep as rhino_to_brep
+except ImportError:
+    pass

compas_brep-0.1.0/src/compas_brep/backend/occ/__init__.py

@@ -0,0 +1,22 @@
+"""OCC backend sub-package for compas_brep.
+
+Modules
+-------
+conversion
+    Bidirectional conversion between canonical Brep data and OCC shapes
+    (``occ_to_brep``, ``brep_to_occ``, and all private helper functions).
+factories
+    Primitive constructors and shape builders
+    (``make_box``, ``make_cylinder``, ``occ_sweep``, ``occ_from_surface``, …).
+operations
+    Boolean and geometric operations
+    (``boolean_difference``, ``occ_trimmed``, ``occ_fillet``, ``occ_rebuild``, …).
+queries
+    Property queries and tessellation
+    (``occ_area``, ``occ_aabb``, ``occ_tessellate``, …).
+io
+    File import/export
+    (``occ_to_step``, ``occ_from_step``, ``occ_to_stl``, …).
+plugins
+    COMPAS plugin registrations for the OCC backend.
+"""