diff --git a/src/ifcopenshell-python/docs/ifcfm.rst b/src/ifcopenshell-python/docs/ifcfm.rst index 2decea229a..f096ed69e9 100644 --- a/src/ifcopenshell-python/docs/ifcfm.rst +++ b/src/ifcopenshell-python/docs/ifcfm.rst @@ -44,6 +44,11 @@ with this data structure that IfcFM supports: finishes. It is published by the U.S. Army Corps of Engineers, National Building Information Model (NBIMS-US) standard, version 2, chapter 2.4, and in British Standard BS 1192-4:2014. +- **COBie 2.4 Legacy**: During the original development of **COBie 2.4**, a + mapping to IFC was developed as part of the now unmaintained `COBie-plugins + `__ and loosely defined in + Annex A with a number of ambiguities and oddities to accommodate the poor + state of BIM vendors at the time. This preserves the original implementation. - **COBie 3.0**: an update to **COBie 2.4** published by the National Building Information Model (NBIMS-US) standard. Unlike **COBie 2.4**, it is not a British Standard nor developed by the U.S. Army Corps of Engineers. diff --git a/src/ifcopenshell-python/docs/ifcopenshell-python/geometry_processing.rst b/src/ifcopenshell-python/docs/ifcopenshell-python/geometry_processing.rst index 6de1a70c48..75c89cfcc3 100644 --- a/src/ifcopenshell-python/docs/ifcopenshell-python/geometry_processing.rst +++ b/src/ifcopenshell-python/docs/ifcopenshell-python/geometry_processing.rst @@ -66,9 +66,12 @@ related information in ``shape.geometry``: verts = shape.geometry.verts # Indices of vertices per edge e.g. [e1v1, e1v2, e2v1, e2v2, ...] + # If the geometry is mesh-like, edges contain the original edges. + # These may be quads or ngons and not necessarily triangles. edges = shape.geometry.edges # Indices of vertices per triangle face e.g. [f1v1, f1v2, f1v3, f2v1, f2v2, f2v3, ...] + # Note that faces are always triangles. faces = shape.geometry.faces # Since the lists are flattened, you may prefer to group them like so depending on your geometry kernel diff --git a/src/ifcopenshell-python/docs/ifcopenshell-python/geometry_tree.rst b/src/ifcopenshell-python/docs/ifcopenshell-python/geometry_tree.rst index 93561d073f..485113d735 100644 --- a/src/ifcopenshell-python/docs/ifcopenshell-python/geometry_tree.rst +++ b/src/ifcopenshell-python/docs/ifcopenshell-python/geometry_tree.rst @@ -5,6 +5,8 @@ IfcOpenShell includes a utility to build a unbalanced binary tree of geometry and their bounding boxes. After a tree is built, you can efficiently select geometry by specifying a point, radius, or bounding box. +.. image:: images/geometry-tree.png + The most efficient way to build tree is by using the iterator, as shown in the example below: diff --git a/src/ifcopenshell-python/docs/ifcopenshell-python/images/geometry-tree.png b/src/ifcopenshell-python/docs/ifcopenshell-python/images/geometry-tree.png new file mode 100644 index 0000000000..a61c3c171f Binary files /dev/null and b/src/ifcopenshell-python/docs/ifcopenshell-python/images/geometry-tree.png differ diff --git a/src/ifcopenshell-python/docs/ifcopenshell-python/installation.rst b/src/ifcopenshell-python/docs/ifcopenshell-python/installation.rst index f7ea78d3c6..9b8bbe02d6 100644 --- a/src/ifcopenshell-python/docs/ifcopenshell-python/installation.rst +++ b/src/ifcopenshell-python/docs/ifcopenshell-python/installation.rst @@ -20,7 +20,9 @@ Pre-built packages ------------------ Pre-built packages are prepared sporadically depending on whether there are -changes in the IfcOpenShell C++ core. +changes in the IfcOpenShell C++ core. This will give you the latest available +C++ bindings, but may potentially contain outdated pure Python modules, such as +the API. 1. Choose which version to download based on your operating system, Python version, and computer architecture. @@ -94,9 +96,10 @@ changes in the IfcOpenShell C++ core. PyPI ---- -PyPI releases are automatically performed once a month. +PyPI releases are automatically performed once a month and contain the latest +Python code that point in time. -Releases on PyPI may potentially ship slightly outdated precompiled binaires of +Releases on PyPI may potentially ship slightly outdated precompiled binaries of the C++ core. This is because the binaries typically go through a period of manual testing prior in case of high-risk changes.