Brep plugin

[chenkasirer]

Edit:

• Tests fail because compas is installed from conda-forge and new Brep pluggable is only available in the unreleased COMPAS main. Have to wait for next release?

This PR adds compas_occ plugins to the new pluggable compas.geometry.Brep. There's also a small bugfix and some open issues.

The pluggable Brep allows writing (somewhat) context agnostic code when working with a Brep, this is realized using the COMPAS plugin system and some backends (currently Rhino).

>>> from compas.geometry import Brep, Box
>>> Brep.from_box(Box.from_width_height_depth(5,5,5))
<compas_occ.brep.brep.BRep object at 0x00000198E97052B0>

This also allows serializing a Brep created in compas_occ and using is in e.g. Rhino

# in compas_occ
from compas.data json_dump
from compas.geometry import Box, Brep

path = r"..."

brep = Brep.from_box(Box.from_width_height_depth(5,5,5))

>>> type(brep)
<class 'compas_occ.brep.brep.BRep'>

json_dump(brep, path)

# in Rhino/Grasshopper
from compas.data json_load

path = r"..."

brep = json_load(path)

>>> type(brep)
<class 'compas_rhino.geometry.brep.RhinoBrep'>

Known issues:

• Interoperability with Rhino is fragile. OCC surfaces are serialized as different kinds of shapes whereas Rhino can currently only deal with NURBS surfaces.

What type of change is this?

• [x] Bug fix in a backwards-compatible manner.
• [x] New feature in a backwards-compatible manner.
• [ ] Breaking change: bug fix or new feature that involve incompatible API changes.
• [ ] Other (e.g. doc update, configuration, etc)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

• [x] I added a line to the CHANGELOG.md file in the Unreleased section under the most fitting heading (e.g. Added, Changed, Removed).
• [x] I ran all tests on my computer and it's all green (i.e. invoke test).
• [x] I ran lint on my computer and there are no errors (i.e. invoke lint).
• [ ] I added new functions/classes and made them available on a second-level import, e.g. compas.datastructures.Mesh.
• [x] I have added tests that prove my fix is effective or that my feature works.
• [ ] I have added necessary documentation (if appropriate)

[gonzalocasas]

Tests fail because compas is installed from conda-forge and new Brep pluggable is only available in the unreleased COMPAS main. Have to wait for next release?

This makes me feel that we would technically need a new minor release, 1.18.x for COMPAS, so that we can bump the requirement here to greater than that. It would technically be possible to do it with the patch part of version as well, but it wouldn't be very semver-ish ;)

[chenkasirer]

Tests fail because compas is installed from conda-forge and new Brep pluggable is only available in the unreleased COMPAS main. Have to wait for next release?

This makes me feel that we would technically need a new minor release, 1.18.x for COMPAS, so that we can bump the requirement here to greater than that. It would technically be possible to do it with the patch part of version as well, but it wouldn't be very semver-ish ;)

Isn't 1.17 the next one?

Does it make sense in anyway to install COMPAS from Github rather than from Pypi/conda-forge? Or do we definitely want that COMPAS extensions only rely on released features in core?

[gonzalocasas]

Isn't 1.17 the next one?

you're right, sorry, I thought we had already released 1.17

Does it make sense in anyway to install COMPAS from Github rather than from Pypi/conda-forge? Or do we definitely want that COMPAS extensions only rely on released features in core?

I think it's a good idea that by default CI runs on released versions. For wip branches, we could change the github actions workflow files so that on the branch, the build depends on main instead, but it'd need to be reverted before merge.

[tomvanmele]

@chenkasirer @gonzalocasas shall we do a sprint this week to get 1.17 out?

[chenkasirer]

Sorry, was away this week. If you haven't done one yet, then I'm in!

[tomvanmele]

quick discussion about this in the afternoon?

[gonzalocasas]

@chenkasirer I'm a bit lost here, has this been superseded by other PRs after this, or do we need to revive and merge this?

[chenkasirer]

@chenkasirer I'm a bit lost here, has this been superseded by other PRs after this, or do we need to revive and merge this?

This was waiting for the first release of compas.geometry.Brep which was 1.17.0, I think, but since forgotten due to work mostly focused on the RhinoBrep.

I think this one is worth reviving - I'll refresh it and re-open.

In the grand scheme of things, there are still two tasks:

1. Making OCC BRep a plugin for compas.geometry.Brep which is relatively trivial - is the purpose of this PR.
2. Sorting out the OCC BRep serialization, which in the meantime has been removed altogether. This will require some more significant work and will have it's own PR.