diff --git a/src/ifcopenshell-python/docs/blenderbim.rst b/src/ifcopenshell-python/docs/blenderbim.rst deleted file mode 100644 index 6cbad3e992..0000000000 --- a/src/ifcopenshell-python/docs/blenderbim.rst +++ /dev/null @@ -1,6 +0,0 @@ -Bonsai Add-on -================= - -Bonsai Add-on for Blender lets you analyse, create, and modify OpenBIM with -Blender. For more information, visit the `Bonsai website -`_. diff --git a/src/ifcopenshell-python/docs/bonsai.rst b/src/ifcopenshell-python/docs/bonsai.rst new file mode 100644 index 0000000000..5ad65d1a01 --- /dev/null +++ b/src/ifcopenshell-python/docs/bonsai.rst @@ -0,0 +1,5 @@ +Bonsai +====== + +Bonsai lets you analyse, create, and modify OpenBIM with Blender. For more +information, visit the `Bonsai website `_. diff --git a/src/ifcopenshell-python/docs/ifcdiff.rst b/src/ifcopenshell-python/docs/ifcdiff.rst index c1baa8e03a..ce1da441b3 100644 --- a/src/ifcopenshell-python/docs/ifcdiff.rst +++ b/src/ifcopenshell-python/docs/ifcdiff.rst @@ -19,8 +19,8 @@ Changes will be sorted into three lists: There are different methods of installation, depending on your situation. 1. **PyPI** is recommended for developers using Pip. -2. **Using the BlenderBIM Add-on** is recommended for non-developers wanting a - graphical interface. +2. **Using Bonsai** is recommended for non-developers wanting a graphical + interface. 3. **Source installation** is recommended for users wanting to use the latest code as a library or a CLI utility. @@ -31,19 +31,19 @@ PyPI pip install ifcdiff -Using the BlenderBIM Add-on ---------------------------- +Using Bonsai +------------ -The BlenderBIM Add-on is a Blender based graphical interface to IfcOpenShell. -Other than providing a graphical IFC authoring platform, it also comes with -IfcOpenShell, its utilities, and a Python shell built-in. This means you don't -need to install Python first, and you also can compare your IfcOpenShell -scripting to what you see with a visual model viewer, or use a graphical -interface to access the IfcOpenShell utilities. +Bonsai is a Blender based graphical interface to IfcOpenShell. Other than +providing a graphical IFC authoring platform, it also comes with IfcOpenShell, +its utilities, and a Python shell built-in. This means you don't need to +install Python first, and you also can compare your IfcOpenShell scripting to +what you see with a visual model viewer, or use a graphical interface to access +the IfcOpenShell utilities. -1. Install the BlenderBIM Add-on by following the `BlenderBIM Add-on +1. Install Bonsai by following the `Bonsai installation documentation - `_. + `_. 2. Launch Blender. Change to the **Scene Properties** tab in the **Properties Panel**. Scroll down to the **IFC Quality Control > IFC Diff** panel. diff --git a/src/ifcopenshell-python/docs/ifcmax.rst b/src/ifcopenshell-python/docs/ifcmax.rst index a564e15b93..0252ed3d6c 100644 --- a/src/ifcopenshell-python/docs/ifcmax.rst +++ b/src/ifcopenshell-python/docs/ifcmax.rst @@ -17,4 +17,4 @@ It is recommended to use the latest version of IfcOpenShell and 3ds Max. This plugin is purely an importer and does not handle native IFC authoring or exporting. For more information for native IFC authoring, we recommend - using the :doc:`BlenderBIM Add-on`. + using :doc:`Bonsai`. diff --git a/src/ifcopenshell-python/docs/ifcopenshell-python/selector_syntax.rst b/src/ifcopenshell-python/docs/ifcopenshell-python/selector_syntax.rst index 6893ddba95..1a94781002 100644 --- a/src/ifcopenshell-python/docs/ifcopenshell-python/selector_syntax.rst +++ b/src/ifcopenshell-python/docs/ifcopenshell-python/selector_syntax.rst @@ -15,8 +15,8 @@ take length values defined in feet, and apply imperial formatting such that it shows both feet and inches including fractions. These three usecases of filtering, getting a value, and formatting that value -are common and used in many utilities, such as in the BlenderBIM Add-on, -IfcCSV, IfcDiff, IfcClash, IfcPatch, and IfcFM. +are common and used in many utilities, such as in Bonsai, IfcCSV, IfcDiff, +IfcClash, IfcPatch, and IfcFM. IfcOpenShell provides a custom syntax to consistently and concisely describe filters, value queries, and formatting rules. diff --git a/src/ifcopenshell-python/docs/ifcopenshell/installation.rst b/src/ifcopenshell-python/docs/ifcopenshell/installation.rst index 69fe987d5a..4dbf755642 100644 --- a/src/ifcopenshell-python/docs/ifcopenshell/installation.rst +++ b/src/ifcopenshell-python/docs/ifcopenshell/installation.rst @@ -28,7 +28,7 @@ IfcOpenShell depends on: for IfcConvert to be able to write tessellated Collada (.dae) files - (Optional) `SWIG `__ and `Python `__ - for building the IfcOpenShell Python interface - and use in the BlenderBIM Add-on + and use in Bonsai - (Optional) `HDF5 `__ - for caching geometry using the HDF5 format diff --git a/src/ifcopenshell-python/docs/ifcsverchok/installation.rst b/src/ifcopenshell-python/docs/ifcsverchok/installation.rst index 50e05dab17..b1967cf39c 100644 --- a/src/ifcopenshell-python/docs/ifcsverchok/installation.rst +++ b/src/ifcopenshell-python/docs/ifcsverchok/installation.rst @@ -18,7 +18,7 @@ Like all Blender add-ons, they can be installed using ``Edit > Preferences > Addons > Install > Choose Downloaded ZIP > Enable Add-on Checkbox``. You can enable add-ons permanently by using ``Save User Settings`` from the Addons menu. -Before installing, you will also need to `install the BlenderBIM Add-on +Before installing, you will also need to `install Bonsai `__ and `install Sverchok `__. diff --git a/src/ifcopenshell-python/docs/index.rst b/src/ifcopenshell-python/docs/index.rst index eb9f2d700f..8d241bbf74 100644 --- a/src/ifcopenshell-python/docs/index.rst +++ b/src/ifcopenshell-python/docs/index.rst @@ -12,7 +12,7 @@ Let's learn IfcOpenShell! ifcopenshell ifcopenshell-python ifcconvert - blenderbim + bonsai .. toctree:: :hidden: diff --git a/src/ifcopenshell-python/docs/introduction.rst b/src/ifcopenshell-python/docs/introduction.rst index 773fa7aea1..76032d334d 100644 --- a/src/ifcopenshell-python/docs/introduction.rst +++ b/src/ifcopenshell-python/docs/introduction.rst @@ -3,7 +3,7 @@ Introduction **IfcOpenShell** is an open source software library for software developers and BIM powerusers working with Industry Foundation Classes (`IFC `_). -In addition to a C++ and Python API, **IfcOpenShell** comes with an ecosystem of tools, notably including **IfcConvert** (an application to convert IFC models to other formats), the **BlenderBIM Add-on** (an add-on to Blender providing a graphical IFC authoring platform), and many other libraries, CLI apps, and more. Support is also provided for auxiliary standards such as BCF, bSDD, and IDS. +In addition to a C++ and Python API, **IfcOpenShell** comes with an ecosystem of tools, notably including **IfcConvert** (an application to convert IFC models to other formats), **Bonsai** (an add-on to Blender providing a graphical IFC authoring platform), and many other libraries, CLI apps, and more. Support is also provided for auxiliary standards such as BCF, bSDD, and IDS. Things you can do ----------------- @@ -78,7 +78,7 @@ IfcOpenShell is a modular ecosystem of tools that work together, where each tool .. note:: - **IfcOpenShell** and all of its libraries are licensed under LGPL-3.0-or-later. Two exceptions to this are the **BlenderBIM Add-on** and **IfcSverchok**, which are both licensed under GPL-3.0-or-later. + **IfcOpenShell** and all of its libraries are licensed under LGPL-3.0-or-later. Two exceptions to this are **Bonsai** and **IfcSverchok**, which are both licensed under GPL-3.0-or-later. .. toctree:: :hidden: