Glassvision/IfcOpenShell
1
0
Fork 0
mirror of https://github.com/IfcOpenShell/IfcOpenShell.git synced 2026-08-10 09:48:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Replace BlenderBIM branding with Bonsai in docs

Browse Source
This commit is contained in:
Dion Moult
2024-08-22 21:02:19 +10:00
parent b6ccf505e7
commit d4e863ed3b
66 changed files with 426 additions and 487 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/bonsai/bonsai/bim/operator.py
+6 -6
View File
@@ -262,7 +262,7 @@ class FileAssociate(bpy.types.Operator):
# NOTE: really weird thing on windows that typing this command in cmd works
# when even if you create .bat with the command below and run it as administrator it won't
# Haven't found a workaround yet to automate process completely.
command = "ASSOC .IFC=BLENDERBIM"
command = "ASSOC .IFC=BONSAI"
self.layout.label(text="On the next step to create file association ")
self.layout.label(text="the system console will be opened ")
self.layout.label(text=f"and you will be asked to type command")
@@ -375,7 +375,7 @@ class FileUnassociate(bpy.types.Operator):
cmd = [
"powershell",
"-Command",
"Start-Process -Verb RunAs -Wait cmd -ArgumentList '/c reg delete HKCR\\BLENDERBIM /f'",
"Start-Process -Verb RunAs -Wait cmd -ArgumentList '/c reg delete HKCR\\BONSAI /f'",
]
subprocess.run(cmd, check=True)
self.report({"INFO"}, "Association removed.")
@@ -388,10 +388,10 @@ class FileUnassociate(bpy.types.Operator):
"share/applications/bonsai.desktop",
"share/mime/packages/bonsai.xml",
"bin/bonsai",
"share/icons/hicolor/128x128/apps/blenderbim.png",
"share/applications/blenderbim.desktop",
"share/mime/packages/blenderbim.xml",
"bin/blenderbim",
"share/icons/hicolor/128x128/apps/bonsai.png",
"share/applications/bonsai.desktop",
"share/mime/packages/bonsai.xml",
"bin/bonsai",
):
try:
os.remove(os.path.join(destdir, rel_path))
src/bonsai/docs/blenderbim/scene.rst
+5 -5
View File
@@ -17,15 +17,15 @@ System Setup
tree. You can see the tree of collections in the outliner when this is done.
* **Schema Directory** - this folder stores the current IFC schema. You can
download different schemas from the buildingSMART website. Unless you are an
IFC guru, you probably shouldn't touch this. BlenderBIM recognises different
IFC guru, you probably shouldn't touch this. Bonsai recognises different
IFC data based on what is provided in this schema folder. It defaults to the
``{{BLENDER_ADDONS_DIR}}/blenderbim/schema/`` folder, which is prepackaged
``{{BLENDER_ADDONS_DIR}}/bonsai/schema/`` folder, which is prepackaged
with the IFC4 schema. This is known as the ``{SCHEMA_DIR}``.
* **Data Directory** - the data directory holds the auxiliary data related to
your IFC model. Examples include related property definitions, documents, and
classification systems. Each project should have its own data directory. It
defaults to the data directory in the
``{{BLENDER_ADDONS_DIR}}/blenderbim/data/`` folder, which comes with some
``{{BLENDER_ADDONS_DIR}}/bonsai/data/`` folder, which comes with some
example preset data. You are encouraged to copy this template and set your
own. This is known as the ``{DATA_DIR}``.
@@ -115,13 +115,13 @@ IFC Classifications Panel
- **Classification** - this lets you select which classification system you'd
like to use. The list of possible classification systems is derived from the
``{DATA_DIR}/class/classifications.csv`` file. By default, BlenderBIM comes
``{DATA_DIR}/class/classifications.csv`` file. By default, Bonsai comes
with Uniclass 2015 and Omniclass. If you need another classification system,
you can add it to this ``.csv`` file.
- **Reference** - this lets you select a single classification reference item,
filtered depending on the currently active *Classification*. The list is
derived from the ``{DATA_DIR}/class/references.csv`` file. Out of the box,
BlenderBIM only lists a single Uniclass reference as an example. It is
Bonsai only lists a single Uniclass reference as an example. It is
advised to make a list of all the references you require for a project and
add it to this ``.csv`` file.
- **Assign Classification** - this assigns the currently active *Reference* to
src/bonsai/docs/contribute/translations.rst
+19 -19
View File
@@ -1,20 +1,20 @@
Translations
============
The BlenderBIM Add-on supports translations to all languages that Blender
supports. We'll describe how you can help translate the add-on as a translator,
or how you can ensure your strings are translatable as a developer.
Translations are managed using a separate add-on built for this purpose.
Bonsai supports translations to all languages that Blender supports. We'll
describe how you can help translate the add-on as a translator, or how you can
ensure your strings are translatable as a developer. Translations are managed
using a separate add-on built for this purpose.
1. Clone the `blenderbim-translations
<https://github.com/IfcOpenShell/blenderbim-translations>`_ repository. This
1. Clone the `bonsai-translations
<https://github.com/IfcOpenShell/bonsai-translations>`_ repository. This
repository holds all the core translation strings in ``.po`` format.
2. Download the `blenderbim-translations add-on
<https://github.com/IfcOpenShell/IfcOpenShell/blob/v0.8.0/src/blenderbim/scripts/bbim_translations.py>`_
2. Download the `bonsai-translations add-on
<https://github.com/IfcOpenShell/IfcOpenShell/blob/v0.8.0/src/bonsai/scripts/bbim_translations.py>`_
and install it as a Blender add-on. This add-on lets you convert translation
data to and from the ``.po`` files to the BlenderBIM Add-on.
3. In the **Render Properties** tab, find the **BlenderBIM Translations**
panel, and browse to where you have closed the ``blenderbim-translations``
data to and from the ``.po`` files for Bonsai.
3. In the **Render Properties** tab, find the **Bonsai Translations**
panel, and browse to where you have closed the ``bonsai-translations``
repository, and click on **Setup Translation UI**.
You should now see a new interface with two buttons.
@@ -24,13 +24,13 @@ You should now see a new interface with two buttons.
How to translate the add-on
---------------------------
Before beginning, look inside the ``blenderbim-translations`` repository for a
Before beginning, look inside the ``bonsai-translations`` repository for a
``.po`` file for the language you want to translate to (e.g. ``de_DE.po`` for
German). If this file does not yet exist, congratulations! You are the first
person to translate to this language! Create a folder in
``blenderbim-translations`` with your language code and copy the
``blenderbim.pot`` language template file to that folder and rename it
according to your language (e.g. for German you would copy ``blenderbim.pot`` to
``bonsai-translations`` with your language code and copy the
``bonsai.pot`` language template file to that folder and rename it
according to your language (e.g. for German you would copy ``bonsai.pot`` to
``de_DE/de_DE.po``).
Supported language codes are:
@@ -51,21 +51,21 @@ translation, suggestions, and tracking. Alternatively, you may edit the ``.po``
file as a text file.
Once you have edited the relevant language's ``.po`` file, click on the
**Update Translations From .po** button in the **BlenderBIM Translations**
**Update Translations From .po** button in the **Bonsai Translations**
panel.
How to add new translation strings
----------------------------------
When you have new strings to translate, press the **Parse BlenderBIM strings to
When you have new strings to translate, press the **Parse Bonsai strings to
.pot** button. This detects strings in the source code using regex patterns and
writes out to the ``blenderbim.pot`` language template file. You may then diff
writes out to the ``bonsai.pot`` language template file. You may then diff
this file and propagate changes manually to all translated ``.po`` files.
The ``.pot`` file is only used as a blank template for users to create or
compare ``.po`` files. The ``.po`` files are the source of truth for
translation strings. Blender does not read from the ``.pot`` or ``.po`` files.
Instead, Blender reads from ``blenderbim/translations.py`` which contains a
Instead, Blender reads from ``bonsai/translations.py`` which contains a
dictionary of strings formatted specifically for Blender. The
``translations.py`` file is generated from the ``.po`` files. This is generated
when we distribute installable packages, or when translators manually press the
src/bonsai/docs/contribute/writing_docs.rst
+4 -4
View File
@@ -10,8 +10,8 @@ Writing technical documentation
-------------------------------
All documentation is written in ReStructured Text and is available in the
`BlenderBIM Add-on docs directory
<https://github.com/IfcOpenShell/IfcOpenShell/tree/v0.8.0/src/blenderbim/docs>`_.
`Bonsai docs directory
<https://github.com/IfcOpenShell/IfcOpenShell/tree/v0.8.0/src/bonsai/docs>`_.
You can press the edit button on the top right on any documentation page to
quickly edit their content.
@@ -90,7 +90,7 @@ longer code snippets may use code blocks.
.. code-block:: bash
cd /path/to/blenderbim
cd /path/to/bonsai
ls
Be sure to specify the language to enable syntax highlighting.
@@ -159,7 +159,7 @@ Now you can generate the documentation:
.. code-block:: bash
cd /path/to/ifcopenshell/src/blenderbim/docs/
cd /path/to/ifcopenshell/src/bonsai/docs/
make html
cd _build/html
python -m http.server
src/bonsai/docs/devs/code_style.rst
+1 -1
View File
@@ -10,7 +10,7 @@ For Python code formatting, we use `Black code formatter <https://pypi.org/proje
.. code-block:: bash
black --line-length 120 src/blenderbim/blenderbim/bim/module/qto/operator.py
black --line-length 120 src/bonsai/bonsai/bim/module/qto/operator.py
Using PowerShell, you can run the Black formatter on the last commit in the repository.
You can change ``~1`` to ``~n`` to affect ``n`` commits.
src/bonsai/docs/devs/getting_started.rst
+4 -4
View File
@@ -1,11 +1,11 @@
Getting Started
===============
BlenderBIM is an open-source project, and its development is driven by the contributions of a dedicated community of developers,
Bonsai is an open-source project, and its development is driven by the contributions of a dedicated community of developers,
architects, engineers, and enthusiasts. If you're interested in contributing to the project, whether by submitting bug reports,
suggesting new features, or contributing code, your involvement is highly encouraged and appreciated.
This part of the documentation covers various aspects of the BlenderBIM development process, including:
This part of the documentation covers various aspects of the Bonsai development process, including:
- :doc:`Writing User Documentation </contribute/writing_docs>`
- :doc:`Translations and Internationalisation </contribute/translations>`
@@ -24,6 +24,6 @@ This part of the documentation covers various aspects of the BlenderBIM developm
- :doc:`System Support and Multiplatform Compatibility </devs/system_support>`
- :doc:`User Experience and User Interface Guidelines </devs/ux_guidelines>`
The BlenderBIM Developer Documentation is a living resource maintained by the core development team and the open-source community. It serves as a central hub for developers who want to get involved in the project, ensuring a consistent and efficient development process.
The Bonsai Developer Documentation is a living resource maintained by the core development team and the open-source community. It serves as a central hub for developers who want to get involved in the project, ensuring a consistent and efficient development process.
By contributing to BlenderBIM, you'll not only be helping to improve and expand the capabilities of this powerful open-source BIM authoring platform but also be part of a vibrant community driving innovation in the AEC industry.
By contributing to Bonsai, you'll not only be helping to improve and expand the capabilities of this powerful open-source BIM authoring platform but also be part of a vibrant community driving innovation in the AEC industry.
src/bonsai/docs/devs/hello_world.rst
+62 -65
View File
@@ -1,25 +1,24 @@
Hello, world!
=============
The BlenderBIM Add-on takes a unique approach to authoring BIM data. Traditional
BIM authoring apps create features that are tailored for a single discipline's
paradigm, such as a 3D environment, or a spreadsheet view, and store their data
structure in a schema that is unique to their application. In order to
interoperate with others, there is an export or import process that translates
between their bespoke schema to and from open data standards. The most famous
ISO standard for BIM is IFC. After this translation, they then serialise it
typically into a format, which may be saved to disk.
Bonsai takes a unique approach to authoring BIM data. Traditional BIM authoring
apps create features that are tailored for a single discipline's paradigm, such
as a 3D environment, or a spreadsheet view, and store their data structure in a
schema that is unique to their application. In order to interoperate with
others, there is an export or import process that translates between their
bespoke schema to and from open data standards. The most famous ISO standard
for BIM is IFC. After this translation, they then serialise it typically into a
format, which may be saved to disk.
The BlenderBIM Add-on does things differently.
Bonsai does things differently.
The BlenderBIM Add-on does not have its own bespoke data structure and does not
import or export. The BlenderBIM Add-on uses ISO open data standards directly in
memory. Most commonly, this is IFC data. We will place a focus on IFC on this
guide, but the reader should be aware that the BlenderBIM Add-on also takes the
same approach to dealing with other open data standards, like Brickschema or
BCF. The same concepts will apply. We can call this Native OpenBIM authoring,
which is a paradigm shift from traditional BIM which relies on translated IFC
data.
Bonsai does not have its own bespoke data structure and does not import or
export. Bonsai uses ISO open data standards directly in memory. Most commonly,
this is IFC data. We will place a focus on IFC on this guide, but the reader
should be aware that Bonsai also takes the same approach to dealing with other
open data standards, like Brickschema or BCF. The same concepts will apply. We
can call this Native OpenBIM authoring, which is a paradigm shift from
traditional BIM which relies on translated IFC data.
.. image:: images/native-openbim.png
@@ -32,9 +31,8 @@ IFC, and the ``.blend`` container is largely unnecessary, as nothing of
significance is stored in the Blender system, it is simply a snapshot of your
working session.
Due to this significant difference, hacking on the BlenderBIM Add-on requires
knowledge not just about how Blender works, but also how open data standards
like IFC works.
Due to this significant difference, hacking on Bonsai requires knowledge not
just about how Blender works, but also how open data standards like IFC works.
Just show me the code!
----------------------
@@ -49,10 +47,10 @@ need to :ref:`use Git to collaborate <submitting-code-to-git>`.
`Download Source
<https://github.com/IfcOpenShell/IfcOpenShell/archive/refs/heads/v0.8.0.zip>`__
BIM authoring is a really big topic. As a result, the BlenderBIM Add-on code is
separated into modules. Each module focuses on a particular topic of BIM. Most
modules are self-contained, but sometimes they connect to one another, just like
how BIM works.
BIM authoring is a really big topic. As a result, the Bonsai code is separated
into modules. Each module focuses on a particular topic of BIM. Most modules
are self-contained, but sometimes they connect to one another, just like how
BIM works.
.. image:: images/module-architecture.png
@@ -62,20 +60,20 @@ minimise the overlap between modules, so that developers can work on a single
portion of the code with relative certainty that their actions will not affects
other developers.
- `BlenderBIM Add-on modules <https://github.com/IfcOpenShell/IfcOpenShell/tree/v0.8.0/src/blenderbim/blenderbim/bim/module>`__
- `Bonsai modules <https://github.com/IfcOpenShell/IfcOpenShell/tree/v0.8.0/src/bonsai/bonsai/bim/module>`__
- `IFC modules <https://github.com/IfcOpenShell/IfcOpenShell/tree/v0.8.0/src/ifcopenshell-python/ifcopenshell/api>`__
The BlenderBIM Add-on comes with a secret **demo module** which is basically a
hello world coding tutorial which teaches you about all the moving parts. It's
far more interesting to read this code rather than 15 pages of abstract software
Bonsai comes with a secret **demo module** which is basically a hello world
coding tutorial which teaches you about all the moving parts. It's far more
interesting to read this code rather than 15 pages of abstract software
architecture flow charts and diagrams. The code and its comments will guide you
through the process.
Before playing with the demo module, you may want to switch to using a source
installation. See `blenderbim/installation <./installation.html>`_ for details.
installation. See `bonsai/installation <./installation.html>`_ for details.
To see the demo module in action, you'll need to enable it. In
``src/blenderbim/blenderbim/bim/__init__.py``, uncomment the line for the demo
``src/bonsai/bonsai/bim/__init__.py``, uncomment the line for the demo
module. When you restart Blender, you will see a new demo panel in your scene
properties interface tab. Have fun!
@@ -88,30 +86,30 @@ the code, reload Blender, and see what happens!
::
src/blenderbim/blenderbim/bim/module/demo/__init__.py
src/blenderbim/blenderbim/bim/module/demo/operator.py
src/blenderbim/blenderbim/bim/module/demo/prop.py
src/blenderbim/blenderbim/bim/module/demo/ui.py
src/blenderbim/blenderbim/bim/module/demo/data.py
src/blenderbim/blenderbim/core/demo.py
src/blenderbim/blenderbim/tool/demo.py
src/bonsai/bonsai/bim/module/demo/__init__.py
src/bonsai/bonsai/bim/module/demo/operator.py
src/bonsai/bonsai/bim/module/demo/prop.py
src/bonsai/bonsai/bim/module/demo/ui.py
src/bonsai/bonsai/bim/module/demo/data.py
src/bonsai/bonsai/core/demo.py
src/bonsai/bonsai/tool/demo.py
Wow! That's a lot of files needed for a hello world! Don't worry, it's mostly
tutorial comments and it's there to teach you the basics from how Blender's
add-on system works, how interfaces work, to how the BlenderBIM Add-on works,
and how to test and structure it so that you can build incredibly complex
features in a maintainable way.
add-on system works, how interfaces work, to how Bonsai works, and how to test
and structure it so that you can build incredibly complex features in a
maintainable way.
Tests for quality checking also exist. The system is designed so that you can
do "Test Driven Development". For reference on how to run these tests, see `blenderbim/running_tests <./running_tests.html>`_
do "Test Driven Development". For reference on how to run these tests, see `bonsai/running_tests <./running_tests.html>`_
for details. You can find the tests here:
::
src/blenderbim/test/bim/feature/demo.feature
src/blenderbim/test/core/test_demo.py
src/blenderbim/test/tool/test_demo.py
src/bonsai/test/bim/feature/demo.feature
src/bonsai/test/core/test_demo.py
src/bonsai/test/tool/test_demo.py
Not all developers, especially those learning how to code, are familiar with
testing and how to write tests. That's OK! Feel free to ignore the tests at
@@ -120,8 +118,8 @@ guide you when you're ready to make the leap. Don't let this stop you from
building things, others can also help write tests for you and clean your code.
It's a great way to learn!
Once you're through, you should be able to understand how most of the BlenderBIM
Add-on is built and where to find things.
Once you're through, you should be able to understand how most of Bonsai is
built and where to find things.
There are many Blender Python tutorials out there. A good place to start is the
`Start coding for Blender
@@ -131,9 +129,9 @@ OSArch Wiki. In addition, the Blender text editor comes with a menu called
create an add-on which creates objects, creates gizmos, new buttons, interfaces,
and so on. This is a great way to try out how to build different extensions.
Naturally, if you just want to tweak the BlenderBIM Add-on or build a small
feature just for yourself, you're free to ignore this advice, skip all the
tests, and just write half the code in a single file and it'll get the job done.
Naturally, if you just want to tweak Bonsai or build a small feature just for
yourself, you're free to ignore this advice, skip all the tests, and just write
half the code in a single file and it'll get the job done.
Software architecture
---------------------
@@ -161,10 +159,10 @@ is structured the way it is, here is a list of design principles we follow:
The rest of this contains nasty software architecture jargon. If that's not your
thing, stop reading now.
The BlenderBIM Add-on code may be understood in three separate layers: **Delivery**,
**Domain**, and **Data**. The BlenderBIM Add-on architecture separates these
three layers from one another. Because they are separate, they can be tested and
built separately.
Bonsai code may be understood in three separate layers: **Delivery**,
**Domain**, and **Data**. The Bonsai architecture separates these three layers
from one another. Because they are separate, they can be tested and built
separately.
.. image:: images/architecture.png
@@ -196,9 +194,9 @@ using a **Data** repository. The data ensures that stored information confirms
to a defined schema and is valid, and can be retrieved later. Some data is
stored in Blender, such as information about your working session and active
scene. Other data is stored in IFC, such as all the relationships in your BIM
model. We mention **Data** specifically because OpenBIM data authoring is such a
big aspect of the BlenderBIM Add-on. In fact, it's so big that most of it is
completely separated from the BlenderBIM Add-on code and lives elsewhere.
model. We mention **Data** specifically because OpenBIM data authoring is such
a big aspect of Bonsai. In fact, it's so big that most of it is completely
separated from the Bonsai code and lives elsewhere.
For example, all the code that handles IFC data, which you can think of as a
graph database, is in a completely separate codebase, even under a different
@@ -211,10 +209,9 @@ with the entire industry.
IfcOpenShell Architecture
-------------------------
A large part of the BlenderBIM Add-on is understanding how IFC data is modified.
This code is not technically part of the the BlenderBIM Add-on codebase, but it
is vital to understand. You will need to be familiar with the IfcOpenShell
Python module.
A large part of Bonsai is understanding how IFC data is modified. This code is
not technically part of the Bonsai codebase, but it is vital to understand. You
will need to be familiar with the IfcOpenShell Python module.
Manipulating IFC data is not simple. IFC may be serialised into multiple
formats, multiple schema versions must be supported, and geometry may be defined
@@ -224,9 +221,9 @@ library.
The IfcOpenShell library consists of a C++ based core. Its geometry processing
is done using OpenCascade, and optionally CGAL as an experimental option. By the
time the BlenderBIM Add-on interacts with IFC, it uses the IfcOpenShell Python
bindings, so all IFC data is already deserialised into Python objects. The inner
workings of the C++ base is out of scope.
time Bonsai interacts with IFC, it uses the IfcOpenShell Python bindings, so
all IFC data is already deserialised into Python objects. The inner workings of
the C++ base is out of scope.
.. image:: images/ifcopenshell-architecture.png
@@ -282,8 +279,8 @@ Here's an example of it in action:
Because the API performs all the IFC manipulations to achieve a usecase, no
further interaction is required in a typical native IFC authoring environment.
For this reason, the BlenderBIM Add-on only interacts with the API for its
authoring capabilities.
For this reason, Bonsai only interacts with the API for its authoring
capabilities.
The code for IfcOpenShell's various systems can be found here:
src/bonsai/docs/devs/images/diagrams.svg
+58 -58
View File
@@ -98,7 +98,7 @@
height="33.75"
x="18.001902"
y="209.28447"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/ifcopenshell-architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/ifcopenshell-architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150" />
<rect
@@ -108,7 +108,7 @@
height="15"
x="31.374842"
y="80.024109"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/module-architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/module-architecture.png"
inkscape:export-xdpi="150.7067"
inkscape:export-ydpi="150.7067" />
<rect
@@ -118,7 +118,7 @@
height="34.211998"
x="31.375"
y="34.362999"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291" />
<rect
@@ -128,7 +128,7 @@
height="5"
x="32.624676"
y="35.613266"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291" />
<text
@@ -137,7 +137,7 @@
x="33.639542"
y="39.292789"
id="text10513"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291"><tspan
sodipodi:role="line"
@@ -148,7 +148,7 @@
<g
id="g21115"
transform="translate(0.61405499,1.9493724)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291">
<rect
@@ -181,7 +181,7 @@
x="38.284809"
y="44.570713"
id="text1347"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291"><tspan
sodipodi:role="line"
@@ -195,7 +195,7 @@
<g
id="g7150"
transform="translate(2.359969,-4.1086273)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291">
<rect
@@ -220,7 +220,7 @@
<g
id="g7158"
transform="translate(12.615555,-4.1086273)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291">
<rect
@@ -245,7 +245,7 @@
<g
id="g8993"
transform="translate(-1.2498087)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291">
<path
@@ -262,7 +262,7 @@
<g
id="g9079"
transform="translate(9.0057773)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291">
<path
@@ -279,7 +279,7 @@
<g
id="g9543"
transform="translate(0.0040118)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291">
<rect
@@ -307,7 +307,7 @@
x="82.531517"
y="61.082714"
id="text12207"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291"><tspan
sodipodi:role="line"
@@ -321,7 +321,7 @@
x="82.319496"
y="44.570713"
id="text14251"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291"><tspan
sodipodi:role="line"
@@ -336,7 +336,7 @@
height="10.012"
x="62.382"
y="47.112999"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291" />
<text
@@ -345,7 +345,7 @@
x="72.65979"
y="50.792648"
id="text17876"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291"><tspan
sodipodi:role="line"
@@ -361,7 +361,7 @@
<g
id="g9378"
transform="translate(-6.282204)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291">
<rect
@@ -391,7 +391,7 @@
<g
id="g9384"
transform="translate(-3.6949788)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291">
<rect
@@ -424,7 +424,7 @@
x="93.24408"
y="44.570713"
id="text271"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291"><tspan
sodipodi:role="line"
@@ -438,7 +438,7 @@
x="67.225174"
y="44.570713"
id="text1867"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291"><tspan
sodipodi:role="line"
@@ -452,7 +452,7 @@
x="117.22007"
y="44.570713"
id="text2187"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291"><tspan
sodipodi:role="line"
@@ -463,7 +463,7 @@
<g
id="g7184"
transform="translate(35.25409,-4.1086273)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291">
<rect
@@ -488,7 +488,7 @@
<g
id="g7282"
transform="translate(85.425758,-4.1086273)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291">
<rect
@@ -513,7 +513,7 @@
<g
id="g9085"
transform="translate(31.644313)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291">
<path
@@ -530,7 +530,7 @@
<g
id="g9091"
transform="matrix(0,-1,-1,0,145.182,93.19419)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291">
<path
@@ -547,7 +547,7 @@
<g
id="g9549"
transform="rotate(90,79.317431,90.361238)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291">
<path
@@ -567,7 +567,7 @@
x="106.81617"
y="61.082714"
id="text9634"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291"><tspan
sodipodi:role="line"
@@ -581,7 +581,7 @@
x="107.02819"
y="44.570713"
id="text9638"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291"><tspan
sodipodi:role="line"
@@ -592,7 +592,7 @@
<g
id="g10685"
transform="translate(81.81598)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291">
<path
@@ -611,13 +611,13 @@
d="M 59.782,35.613 V 67.124734"
id="path10689"
sodipodi:nodetypes="cc"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/native-openbim.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/native-openbim.png"
inkscape:export-xdpi="150.0291"
inkscape:export-ydpi="150.0291" />
<g
id="g3174"
transform="translate(-7.5899582,-5.7398397)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/module-architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/module-architecture.png"
inkscape:export-xdpi="150.7067"
inkscape:export-ydpi="150.7067">
<rect
@@ -646,7 +646,7 @@
height="5"
x="32.624676"
y="81.274216"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/module-architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/module-architecture.png"
inkscape:export-xdpi="150.7067"
inkscape:export-ydpi="150.7067" />
<text
@@ -655,18 +655,18 @@
x="33.639542"
y="84.953735"
id="text11678"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/module-architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/module-architecture.png"
inkscape:export-xdpi="150.7067"
inkscape:export-ydpi="150.7067"><tspan
sodipodi:role="line"
id="tspan11676"
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.0094px;font-family:'OpenGost Type B TT';-inkscape-font-specification:'OpenGost Type B TT, Normal';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;fill:#1a1a1a;stroke:none;stroke-width:0.264583px"
x="33.639542"
y="84.953735">BLENDERBIM ADD-ON MODULES</tspan></text>
y="84.953735">bonsai ADD-ON MODULES</tspan></text>
<g
id="g3159"
transform="translate(-17.165814,-5.7398397)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/module-architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/module-architecture.png"
inkscape:export-xdpi="150.7067"
inkscape:export-ydpi="150.7067">
<rect
@@ -691,7 +691,7 @@
<g
id="g3164"
transform="translate(-15.466982,-5.7398397)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/module-architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/module-architecture.png"
inkscape:export-xdpi="150.7067"
inkscape:export-ydpi="150.7067">
<rect
@@ -716,7 +716,7 @@
<g
id="g3169"
transform="translate(-15.628441,-6.8018972)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/module-architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/module-architecture.png"
inkscape:export-xdpi="150.7067"
inkscape:export-ydpi="150.7067">
<rect
@@ -745,7 +745,7 @@
height="29.282"
x="108.96313"
y="103.46361"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150" />
<rect
@@ -755,7 +755,7 @@
height="5.25"
x="130.25627"
y="117.214"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150" />
<rect
@@ -765,7 +765,7 @@
height="5"
x="130.25627"
y="112.214"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150" />
<text
@@ -774,7 +774,7 @@
x="131.27151"
y="115.89352"
id="text25338"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150"><tspan
sodipodi:role="line"
@@ -789,7 +789,7 @@
height="5"
x="110.21295"
y="104.71371"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150" />
<text
@@ -798,7 +798,7 @@
x="111.22782"
y="108.39323"
id="text25346"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150"><tspan
sodipodi:role="line"
@@ -809,7 +809,7 @@
<g
id="g25354"
transform="translate(75.831033,-0.0537536)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150">
<rect
@@ -838,7 +838,7 @@
height="5"
x="153.33815"
y="112.214"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150" />
<text
@@ -847,7 +847,7 @@
x="154.35301"
y="115.89352"
id="text25360"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150"><tspan
sodipodi:role="line"
@@ -860,7 +860,7 @@
d="M 125.25628,114.714 H 130.25628"
id="path25382"
sodipodi:nodetypes="cc"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150" />
<path
@@ -868,7 +868,7 @@
d="M 148.35428,119.839 H 150.85428"
id="path25384"
sodipodi:nodetypes="cc"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150" />
<rect
@@ -878,7 +878,7 @@
height="14.281691"
x="110.21295"
y="117.214"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150" />
<text
@@ -887,7 +887,7 @@
x="111.1705"
y="120.61481"
id="text25856"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150"><tspan
sodipodi:role="line"
@@ -916,7 +916,7 @@
x="131.36548"
y="120.61481"
id="text27516"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150"><tspan
sodipodi:role="line"
@@ -931,7 +931,7 @@
height="11.652216"
x="153.33815"
y="117.214"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150" />
<text
@@ -940,7 +940,7 @@
x="154.46107"
y="120.57252"
id="text28633"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150"><tspan
sodipodi:role="line"
@@ -964,7 +964,7 @@
x="142.04053"
y="120.61481"
id="text41508"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150"><tspan
sodipodi:role="line"
@@ -977,7 +977,7 @@
d="M 141.00506,117.214 V 122.464"
id="path42066"
sodipodi:nodetypes="cc"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150" />
<path
@@ -985,20 +985,20 @@
d="M 153.35428,114.714 H 150.85428"
id="path42943"
sodipodi:nodetypes="cc"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150" />
<path
style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.2;stroke-linecap:round;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
d="M 150.85428,119.839 V 114.714"
id="path43121"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150" />
<g
id="g68588"
transform="translate(-86.189108,50.221466)"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/blenderbim/docs/blenderbim/ifcopenshell-architecture.png"
inkscape:export-filename="/home/dion/Projects/IfcOpenShell/src/bonsai/docs/bonsai/ifcopenshell-architecture.png"
inkscape:export-xdpi="150"
inkscape:export-ydpi="150">
<g
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 85 KiB

After

Width:  |  Height:  |  Size: 84 KiB

src/bonsai/docs/devs/installation.rst
+31 -32
View File
@@ -14,13 +14,13 @@ Unstable installation
**Unstable installation** is almost the same as **Stable installation**, except
that they are typically updated every day. Simply download a daily build from
the `GitHub releases page
<https://github.com/IfcOpenShell/IfcOpenShell/releases?q=blenderbim&expanded=true>`__,
<https://github.com/IfcOpenShell/IfcOpenShell/releases?q=bonsai&expanded=true>`__,
then follow the usual :doc:`installation
instructions</users/quickstart/installation>`.
The BlenderBIM Add-on officially supports all major 64-bit platforms, as well as
the Python version shipped by the Blender Foundation for the most recent three
major Blender versions:
Bonsai officially supports all major 64-bit platforms, as well as the Python
version shipped by the Blender Foundation for the most recent three major
Blender versions:
- 64-bit Linux (``linux-x64``)
- 64-bit MacOS Intel (``macos-x64``)
@@ -44,15 +44,15 @@ but it happens.
Bundling for Blender
--------------------
Instead of waiting for an official release on the BlenderBIM Add-on website, it
Instead of waiting for an official release on the Bonsai website, it
is possible to make your own Blender add-on from the bleeding edge source code
of BlenderBIM. BlenderBIM is coded in Python and doesn't require any
of Bonsai. Bonsai is coded in Python and doesn't require any
compilation, so this is a relatively easy process.
Note that the BlenderBIM Add-on does depend on IfcOpenShell, and IfcOpenShell
does require compilation. The following instructions will use a pre-built
IfcOpenShell (using an IfcOpenBot build) for convenience. Instructions on how to
compile IfcOpenShell is out of scope of this document.
Note that Bonsai depends on IfcOpenShell, and IfcOpenShell does require
compilation. The following instructions will use a pre-built IfcOpenShell
(using an IfcOpenBot build) for convenience. Instructions on how to compile
IfcOpenShell is out of scope of this document.
You can create your own package by using the Makefile as shown below. You can
choose between a ``PLATFORM`` of ``linux``, ``macos``, ``macosm1``, and ``win``.
@@ -61,7 +61,7 @@ You can choose between a ``PYVERSION`` of ``py312``, ``py311``, ``py310``, or
.. code-block:: bash
cd src/blenderbim
cd src/bonsai
make dist PLATFORM=linux PYVERSION=py311
ls dist/
@@ -104,7 +104,7 @@ Blender for the changes to take effect.
The downside with this approach is that if a new dependency is added, or a
compiled dependency version requirement has changed, or the build system
changes, you'll need to fix your setup manually. But this is relatively rare.
Reviewing the Makefile history, `here <https://github.com/IfcOpenShell/IfcOpenShell/commits/v0.8.0/src/blenderbim/Makefile>`__, is one quick way to see if a dependency has changed.
Reviewing the Makefile history, `here <https://github.com/IfcOpenShell/IfcOpenShell/commits/v0.8.0/src/bonsai/Makefile>`__, is one quick way to see if a dependency has changed.
.. seealso::
@@ -123,15 +123,15 @@ Packaged installation
---------------------
- **Arch Linux**: `Direct from Git <https://aur.archlinux.org/packages/ifcopenshell-git/>`__.
- **Chocolatey on Windows**: `Unstable <https://community.chocolatey.org/packages/blenderbim-nightly/>`__.
- **Chocolatey on Windows**: `Unstable <https://community.chocolatey.org/packages/bonsai-nightly/>`__.
Tips for package managers
-------------------------
The BlenderBIM Add-on is fully contained in the ``blenderbim/`` subfolder of the
Blender add-ons directory. This is typically distributed as a zipfile as per
Blender add-on conventions. Within this folder, you'll find the following file
structure:
Bonsai is fully contained in the ``bonsai/`` subfolder of the Blender add-ons
directory. This is typically distributed as a zipfile as per Blender add-on
conventions. Within this folder, you'll find the following file structure:
::
core/ (Blender agnostic core logic)
@@ -142,35 +142,34 @@ structure:
__init__.py
This corresponds to the structure found in the source code `here
<https://github.com/IfcOpenShell/IfcOpenShell/tree/v0.8.0/src/blenderbim/blenderbim>`__.
<https://github.com/IfcOpenShell/IfcOpenShell/tree/v0.8.0/src/bonsai/bonsai>`__.
The BlenderBIM Add-on is complex, and requires many dependencies, including
Python modules, binaries, and static assets. When packaged for users, these
dependencies are bundled with the add-on for convenience.
Bonsai is complex, and requires many dependencies, including Python modules,
binaries, and static assets. When packaged for users, these dependencies are
bundled with the add-on for convenience.
If you choose to install the BlenderBIM Add-on and use your own system
dependencies, the source of truth for how dependencies are bundled are found in
If you choose to install Bonsai and use your own system dependencies, the
source of truth for how dependencies are bundled are found in
the `Makefile
<https://github.com/IfcOpenShell/IfcOpenShell/blob/v0.8.0/src/blenderbim/Makefile>`__
<https://github.com/IfcOpenShell/IfcOpenShell/blob/v0.8.0/src/bonsai/Makefile>`__
in the ``dist`` target.
Add-on compatibility
--------------------
The BlenderBIM Add-on is a non-trivial add-on. By turning Blender into a
graphical front-end to a native IFC authoring platform, some fundamental Blender
features (such as hotkeys for basic functionality like object deletion or
duplication) have been patched and many dependencies have been introduced.
Bonsai is a non-trivial add-on. By turning Blender into a graphical front-end
to a native IFC authoring platform, some fundamental Blender features (such as
hotkeys for basic functionality like object deletion or duplication) have been
patched and many dependencies have been introduced.
Other add-ons may no longer work as intended when the BlenderBIM Add-on is
enabled, or vice versa, the BlenderBIM Add-on may no longer work as intended
when other add-ons are enabled.
Other add-ons may no longer work as intended when Bonsai is enabled, or vice
versa, Bonsai may no longer work as intended when other add-ons are enabled.
Known scenarios which will lead to add-on incompatibility include:
- The add-on also overrides the same hotkeys. For example, if an add-on
overrides the "X" key to delete an object, you will need to manually trigger
(either via menu or custom hotkey) the BlenderBIM Add-on equivalent operator
(either via menu or custom hotkey) the Bonsai equivalent operator
(e.g. IFC Delete).
- The add-on uses object deletion or duplication macros with dictionary
override. Note that this is also deprecated in Blender, so the other add-on
src/bonsai/docs/devs/running_tests.rst
+12 -19
View File
@@ -1,14 +1,11 @@
.. _blenderbim/running_tests:
Running tests
=============
The BlenderBIM Add-on has three layers of tests for each of its three technology
layers:
Bonsai has three layers of tests for each of its three technology layers:
1. **Core tests**: abstract domain logic unit tests agnostic of Blender
2. **Tool tests**: low-level concrete unit tests dependent on Blender
3. **BIM tests**: high-level integration UI and smoke tests dependent on Blender
3. **UI tests**: high-level integration UI and smoke tests dependent on Blender
These tests use ``pytest`` as the test framework and runner, so install it:
@@ -23,9 +20,8 @@ When running tests, Makefile targets are provided for convenience so you can
type in a simple command without knowing the internals. This means you can run
tests by using the ``make`` command.
Because the BlenderBIM Add-on depends on IfcOpenShell, it is advised to also run
tests for IfcOpenShell and its Python bindings, which is not covered in this
document.
Because Bonsai depends on IfcOpenShell, it is advised to also run tests for
IfcOpenShell and its Python bindings, which is not covered in this document.
Core tests
----------
@@ -42,7 +38,7 @@ similar.
.. code-block:: bash
cd src/blenderbim/
cd src/bonsai/
make test-core
# If you're on Windows, and don't want to use make, use:
pytest -p no:pytest-blender test/core
@@ -85,7 +81,7 @@ You can install the dependencies by running the ``setup_pytest.py`` script in
Blender:
1. Launch Blender
2. Load ``src/blenderbim/scripts/setup_pytest.py`` in the Blender text editor
2. Load ``src/bonsai/scripts/setup_pytest.py`` in the Blender text editor
3. Run the script by pressing ``Text > Run Script``.
4. Check the Blender console for any errors or success messages.
@@ -104,31 +100,28 @@ of all concrete functions.
.. code-block:: bash
cd src/blenderbim/
cd src/bonsai/
make test-tool # Test everything
make test-tool MODULE=foo # Only test a single module
# If you're on Windows, and don't want to use make, use:
pytest test/tool # Test everything
pytest test/tool/test_foo.py # Only test a single module
BlenderBIM Add-on tests
-----------------------
UI tests
--------
The BIM layer acts as a full integration test. It is not possible to fully test
the UI, as we cannot reliably emit interface signals, nor read the interface as
a DOM of sorts. The best we can do is to call Blender operators as a smoke test,
and also check simple property and scene changes.
The UI layer acts as a full integration test.
Before running these tests, follow the instructions for running tool tests
above.
You will also need to enable the **Sun Position** add-on, as it is required to
test georeferencing features: ``Edit > Preferences > Add-ons`` and enable
test georeferencing features: ``Edit > Preferences > Add-ons`` and install
**Lighting: Sun Position**.
.. code-block:: bash
cd src/blenderbim/
cd src/bonsai/
make test-bim # Test everything
make test-bim MODULE=foo # Only test a single module
# If you're on Windows, and don't want to use make, use:
src/bonsai/docs/devs/undo_system.rst
+14 -14
View File
@@ -4,11 +4,11 @@ Undo system
Supporting undo and redo is quite a complex problem because the Blender undo
system only keeps track of changes occurring in the Blender system. However,
changes actually occur in two other locations that Blender doesn't know about:
the IFC dataset, and the BlenderBIM Add-on system that synchronises Blender and
the IFC dataset.
the IFC dataset, and the Bonsai system that synchronises Blender and the IFC
dataset.
Let's see how undo works in a basic Blender add-on without IFC or the BlenderBIM
Add-on getting involved.
Let's see how undo works in a basic Blender add-on without IFC or Bonsai
getting involved.
.. code-block:: python
:emphasize-lines: 4
@@ -47,8 +47,8 @@ Pure IfcOpenShell let's you start and stop recording transactions whenever you
want. Since IfcOpenShell has no interface, you manually run code like
``model.undo()`` and ``model.redo()`` to undo and redo.
This scenario where there is pure IfcOpenShell never occurs with the BlenderBIM
Add-on. Instead, stuff happens in Blender operators.
This scenario where there is pure IfcOpenShell never occurs with Bonsai.
Instead, stuff happens in Blender operators.
.. code-block:: python
:emphasize-lines: 6,7
@@ -69,16 +69,16 @@ When your operator manipulates (creates, removes, or edits) IFC data directly or
indirectly (i.e. through calling another operator), your operator must be
wrapped in an ``IfcStore.execute_ifc_operator`` call. This wrapper will:
1. Begin a BlenderBIM Add-on transaction
1. Begin a Bonsai transaction
2. Begin an IfcOpenShell transaction
3. Runs your operator's ``_execute``.
4. Ends the IfcOpenShell transaction
5. Ends the BlenderBIM Add-on transaction
3. Run your operator's ``_execute``.
4. End the IfcOpenShell transaction
5. End the Bonsai transaction
The IfcOpenShell transaction keeps track of IFC data changes, and the BlenderBIM
Add-on transaction keeps track of all other custom data changes, like changes in
the ``id_map`` and ``guid_map``. For the vast majority of operations, this
wrapper provides everything that you need.
The IfcOpenShell transaction keeps track of IFC data changes, and the Bonsai
transaction keeps track of all other custom data changes, like changes in the
``id_map`` and ``guid_map``. For the vast majority of operations, this wrapper
provides everything that you need.
If, however, your operator manipulates data that is not tracked by Blender, is
not tracked in the IFC data, and is not tracked in the element map, then you
src/bonsai/docs/devs/ux_guidelines.rst
+3 -3
View File
@@ -1,7 +1,7 @@
User Experience and User Interface guidelines
=============================================
This is intended as a reference document for developers working on the BlenderBim addon.
This is intended as a reference document for developers working on the Bonsai.
Operators
^^^^^^^^^
@@ -16,7 +16,7 @@ BIM will by definition contain a (big) number of submodules or subschemas. Grant
* **Blender**
These considerations must be adapted to the Python API, to the general paradigm we have chosen to access, modify or create IFC data, and to the general philosophy of Blender. There are many ways and places where an add-on creator can choose to present information to the user. BlenderBim currently works that way :
These considerations must be adapted to the Python API, to the general paradigm we have chosen to access, modify or create IFC data, and to the general philosophy of Blender. There are many ways and places where an add-on creator can choose to present information to the user. Bonsai currently works that way :
- Information about the current context is displayed inside the properties editor. We leverage the fact that it is already built around displaying different types of information whether we are in the Scene, Material, Mesh, Object, Curve, Texture, etc. subpanels. It fits really well with the way things are already organized in the IFC classification.
@@ -24,7 +24,7 @@ BIM will by definition contain a (big) number of submodules or subschemas. Grant
- Some Misc tools and information are displayed in the N panel of the 3D viewport . They're shortcuts to things that are already present elsewhere in the UI, but are handy to have when modifying objects or geometry in the Viewport.
- Adding specific Import / Export IFC operators (arguably a bit misleading since BlenderBim does more than import / export in these operations)
- Adding specific Import / Export IFC operators (arguably a bit misleading since Bonsai does more than import / export in these operations)
* **Interface panels**
src/bonsai/docs/images/icon-EXPORT.svg
+1 -1
View File
@@ -2,7 +2,7 @@
<svg
inkscape:export-ydpi="153.60001"
inkscape:export-xdpi="153.60001"
inkscape:export-filename="../Projects/ifcopenshell/src/blenderbim/docs/images/icon-FILE_TICK.svg"
inkscape:export-filename="../Projects/ifcopenshell/src/bonsai/docs/images/icon-FILE_TICK.svg"
style="display:inline;enable-background:new"
inkscape:output_extension="org.inkscape.output.svg.inkscape"
sodipodi:docname="blender_icons.svg"
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 5.5 KiB

After

Width:  |  Height:  |  Size: 5.5 KiB

src/bonsai/docs/images/icon-FILE.svg
+1 -1
View File
@@ -2,7 +2,7 @@
<svg
inkscape:export-ydpi="153.60001"
inkscape:export-xdpi="153.60001"
inkscape:export-filename="../Projects/ifcopenshell/src/blenderbim/docs/images/icon-FILE.svg"
inkscape:export-filename="../Projects/ifcopenshell/src/bonsai/docs/images/icon-FILE.svg"
style="display:inline;enable-background:new"
inkscape:output_extension="org.inkscape.output.svg.inkscape"
sodipodi:docname="blender_icons.svg"
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 4.1 KiB

After

Width:  |  Height:  |  Size: 4.1 KiB

src/bonsai/docs/images/icon-FILE_CACHE.svg
+1 -1
View File
@@ -2,7 +2,7 @@
<svg
inkscape:export-ydpi="153.60001"
inkscape:export-xdpi="153.60001"
inkscape:export-filename="../Projects/ifcopenshell/src/blenderbim/docs/images/icon-FILE.svg"
inkscape:export-filename="../Projects/ifcopenshell/src/bonsai/docs/images/icon-FILE.svg"
style="display:inline;enable-background:new"
inkscape:output_extension="org.inkscape.output.svg.inkscape"
sodipodi:docname="blender_icons.svg"
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 6.5 KiB

After

Width:  |  Height:  |  Size: 6.5 KiB

src/bonsai/docs/images/icon-FILE_HIDDEN.svg
+1 -1
View File
@@ -2,7 +2,7 @@
<svg
inkscape:export-ydpi="153.60001"
inkscape:export-xdpi="153.60001"
inkscape:export-filename="../Projects/ifcopenshell/src/blenderbim/docs/images/icon-FILE_CACHE.svg"
inkscape:export-filename="../Projects/ifcopenshell/src/bonsai/docs/images/icon-FILE_CACHE.svg"
style="display:inline;enable-background:new"
inkscape:output_extension="org.inkscape.output.svg.inkscape"
sodipodi:docname="blender_icons.svg"
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 5.6 KiB

After

Width:  |  Height:  |  Size: 5.6 KiB

src/bonsai/docs/images/icon-FILE_TICK.svg
+1 -1
View File
@@ -2,7 +2,7 @@
<svg
inkscape:export-ydpi="153.60001"
inkscape:export-xdpi="153.60001"
inkscape:export-filename="../Projects/ifcopenshell/src/blenderbim/docs/images/icon-GREASEPENCIL.svg"
inkscape:export-filename="../Projects/ifcopenshell/src/bonsai/docs/images/icon-GREASEPENCIL.svg"
style="display:inline;enable-background:new"
inkscape:output_extension="org.inkscape.output.svg.inkscape"
sodipodi:docname="blender_icons.svg"
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 4.2 KiB

After

Width:  |  Height:  |  Size: 4.2 KiB

src/bonsai/docs/images/icon-GREASEPENCIL.svg
+1 -1
View File
@@ -2,7 +2,7 @@
<svg
inkscape:export-ydpi="153.60001"
inkscape:export-xdpi="153.60001"
inkscape:export-filename="../Projects/ifcopenshell/src/blenderbim/docs/images/icon-FILE_HIDDEN.svg"
inkscape:export-filename="../Projects/ifcopenshell/src/bonsai/docs/images/icon-FILE_HIDDEN.svg"
style="display:inline;enable-background:new"
inkscape:output_extension="org.inkscape.output.svg.inkscape"
sodipodi:docname="blender_icons.svg"
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 4.4 KiB

After

Width:  |  Height:  |  Size: 4.4 KiB

src/bonsai/docs/images/location-breadcrumb.svg
+1 -1
View File
@@ -2,7 +2,7 @@
<svg
inkscape:export-ydpi="153.60001"
inkscape:export-xdpi="153.60001"
inkscape:export-filename="../Projects/ifcopenshell/src/blenderbim/docs/images/location-scene.svg"
inkscape:export-filename="../Projects/ifcopenshell/src/bonsai/docs/images/location-scene.svg"
style="display:inline;enable-background:new"
inkscape:output_extension="org.inkscape.output.svg.inkscape"
sodipodi:docname="blender_icons.svg"
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 3.7 KiB

After

Width:  |  Height:  |  Size: 3.6 KiB

src/bonsai/docs/images/location-scene.svg
+1 -1
View File
@@ -2,7 +2,7 @@
<svg
inkscape:export-ydpi="153.60001"
inkscape:export-xdpi="153.60001"
inkscape:export-filename="../Projects/ifcopenshell/src/blenderbim/docs/images/location-breadcrumb.svg"
inkscape:export-filename="../Projects/ifcopenshell/src/bonsai/docs/images/location-breadcrumb.svg"
style="display:inline;enable-background:new"
inkscape:output_extension="org.inkscape.output.svg.inkscape"
sodipodi:docname="blender_icons.svg"
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 4.7 KiB

After

Width:  |  Height:  |  Size: 4.7 KiB

src/bonsai/docs/index.rst
+12 -16
View File
@@ -1,12 +1,8 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
BlenderBIM Reference Manual
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Learn Bonsai
============
Welcome to the manual for `Bonsai <https://bonsaibim.org>`__,
the free and open source BIM add-on for Blender.
Quickstart
==========
Welcome to the manual for `Bonsai <https://bonsaibim.org>`__, the free and open
source BIM add-on for Blender.
.. only:: builder_html and (not singlehtml)
@@ -15,7 +11,7 @@ Quickstart
.. container:: card
:doc:`/users/quickstart/introduction_to_bim` (2-minute read)
Brief overview of BIM concepts and BlenderBIM's role.
Brief overview of BIM concepts and Bonsai's role.
.. container:: card
@@ -55,7 +51,7 @@ Sections
.. container:: card
:doc:`/users/modeling/interface`
Guide to the BlenderBIM interface.
Guide to the Bonsai interface.
.. container:: card
@@ -75,7 +71,7 @@ Sections
.. container:: card
:doc:`/users/structural_analysis/index`
Structural analysis capabilities in BlenderBIM.
Structural analysis capabilities.
.. container:: card
@@ -135,9 +131,9 @@ Please consider joining the effort and :doc:`/contribute/writing_docs`.
You can also can help with :doc:`Translations and Internationalisation </contribute/translations>`
For users who want to contribute to the BlenderBIM codebase,
For users who want to contribute to the Bonsai codebase,
please refer to the :doc:`Documentation for Developers </devs/getting_started>`.
This part of the documentation covers various aspects of the BlenderBIM development process.
This part of the documentation covers various aspects of the Bonsai development process.
You can get in touch by `joining the chat <https://osarch.org/chat/>`__.
@@ -153,7 +149,7 @@ You can get in touch by `joining the chat <https://osarch.org/chat/>`__.
Developer Documentation
=======================
BlenderBIM is an open-source project, and its development is driven by the contributions of a dedicated community of developers,
Bonsai is an open-source project, and its development is driven by the contributions of a dedicated community of developers,
architects, engineers, and enthusiasts. If you're interested in contributing to the project, whether by submitting bug reports,
suggesting new features, or contributing code, your involvement is highly encouraged and appreciated.
@@ -166,7 +162,7 @@ suggesting new features, or contributing code, your involvement is highly encour
.. container:: card
:doc:`/devs/getting_started`
Introduction to contributing to BlenderBIM.
Introduction to contributing to Bonsai.
.. container:: card
@@ -181,7 +177,7 @@ suggesting new features, or contributing code, your involvement is highly encour
.. container:: card
:doc:`/devs/undo_system`
Working with BlenderBIM's undo system.
Working with Bonsai's undo system.
.. container:: card
src/bonsai/docs/users/advanced/dealing_with_large_models.rst
+7 -8
View File
@@ -1,9 +1,9 @@
Dealing with large models
=========================
The BlenderBIM Add-on can handle large models, or federated collections of
models where the combined total IFCs may be many gigabytes or object counts may
be in the hundreds of thousands.
Bonsai can handle large models, or federated collections of models where the
combined total IFCs may be many gigabytes or object counts may be in the
hundreds of thousands.
Models may be large in terms of different metrics, such as:
@@ -141,11 +141,10 @@ older Blender versions.
Coordination only models
------------------------
The BlenderBIM Add-on defaults to authoring IFCs. This allows full editing and
inspection of all element properties and relationships. However, sometimes only
geometry and basic attributes such as names are sufficient. Example usecases
include CG visualisation, overall federated model coordination, or pure
geometric checks.
Bonsai defaults to authoring IFCs. This allows full editing and inspection of
all element properties and relationships. However, sometimes only geometry and
basic attributes such as names are sufficient. Example usecases include CG
visualisation, overall federated model coordination, or pure geometric checks.
Click on :ref:`Enable Advanced Mode <Project Info Advanced Loading Mode>` checkbox when loading a model and you will be presented
with model loading options in the **Project Info** panel. Enable **For
src/bonsai/docs/users/advanced/georeferencing.rst
+17 -18
View File
@@ -4,8 +4,8 @@ Georeferencing
There are two types of construction: vertical construction (such as buildings
and sites) which deal with small distances typically under 1km, and horizontal
construction (such as transport, transmission, and subterranean networks) where
distances frequently exceed 1km. Blender and the BlenderBIM Add-on focuses on
vertical construction, and will typically just work out of the box.
distances frequently exceed 1km. Blender and Bonsai focuses on vertical
construction, and will typically just work out of the box.
Coordinate reference systems
----------------------------
@@ -121,11 +121,11 @@ value close to, but not exactly 1.
Working with Map Coordinates
----------------------------
The BlenderBIM Add-on is designed to work with small coordinates (under 1km),
whereas map coordinates are typically large. When you load an IFC which uses map
Bonsai is designed to work with small coordinates (under 1km), whereas map
coordinates are typically large. When you load an IFC which uses map
coordinates directly, or when you are working with IFC2X3 and you cannot use a
map conversion, the BlenderBIM Add-on will autodetect a point on your model to
use as a false origin.
map conversion, Bonsai will autodetect a point on your model to use as a false
origin.
The XYZ offset used for the false origin will be shown in the **IFC
Georeferencing** panel under the **Blender Offset** header. It
@@ -182,12 +182,12 @@ the same Blender session.
Many IFC viewers only show geometry, and don't show object placements. This may
give users the false impression that their coordinates in their IFC project
do not have such a large range. However, as a native IFC authoring platform,
the BlenderBIM Add-on will not accept this inconsistency.
Bonsai will not accept this inconsistency.
At this point, it is the users responsibility to reconcile this inconsistency in
their coordinates. Either the user needs to fix their file to consistently
offset all coordinates, or the user needs to manually tell the BlenderBIM Add-on
the coordinates of the desired false origin and accept the precision loss.
offset all coordinates, or the user needs to manually tell Bonsai the
coordinates of the desired false origin and accept the precision loss.
Converting local and map coordinates
------------------------------------
@@ -231,11 +231,10 @@ fixed value.
Coordinate precision limits
---------------------------
The BlenderBIM Add-on focuses on vertical construction. Vertical construction
typically uses **Local engineering coordinates** on a small site. The
buildingSMART georeferencing technical experts panel have determined that a
small site under 1km square can be assumed to have a constant **Map
Conversion**.
Bonsai focuses on vertical construction. Vertical construction typically uses
**Local engineering coordinates** on a small site. The buildingSMART
georeferencing technical experts panel have determined that a small site under
1km square can be assumed to have a constant **Map Conversion**.
Therefore, if your model is less than 1km square, you are within the coordinate
precision limits. This is where the 1km default distance limit is derived from.
@@ -244,10 +243,10 @@ If you want to exceed the 1km square surveying limitation, you will need to be
aware of software limitations that can result in precision loss when large
coordinate ranges are used.
Blender, and subsequently the BlenderBIM Add-on, is not designed for **Map
Coordinates**. Blender internally uses single precision floating point
calculations. A full description of the precision implications are described in
the `Blender working limits documentation
Blender, and subsequently Bonsai, is not designed for **Map Coordinates**.
Blender internally uses single precision floating point calculations. A full
description of the precision implications are described in the `Blender working
limits documentation
<https://docs.blender.org/manual/en/latest/advanced/limits.html>`__.
This means that lengths greater than 5,000 meters start to accumulate software
src/bonsai/docs/users/costing_and_scheduling/index.rst
+5 -5
View File
@@ -1,7 +1,7 @@
Costing and Scheduling
======================
This section covers the cost estimation and project scheduling features in BlenderBIM.
This section covers the cost estimation and project scheduling features in Bonsai.
.. note::
This page is a stub. More detailed content will be added in future updates.
@@ -9,7 +9,7 @@ This section covers the cost estimation and project scheduling features in Blend
Overview
--------
BlenderBIM offers integrated tools for cost estimation and project scheduling, allowing users to link BIM elements directly to cost data and timeline information.
Bonsai offers integrated tools for cost estimation and project scheduling, allowing users to link BIM elements directly to cost data and timeline information.
Key Features
------------
@@ -23,13 +23,13 @@ Key Features
Getting Started
---------------
To begin using the costing and scheduling features in BlenderBIM:
To begin using the costing and scheduling features in Bonsai:
1. Access the Costing and Scheduling panel in the BlenderBIM interface
1. Access the Costing and Scheduling panel in the Bonsai interface
2. Associate costs with materials and elements
3. Create a project timeline
4. Link BIM elements to schedule activities
.. seealso::
- :doc:`/users/modeling/ifc_modeling`
- :doc:`/users/advanced/index`
- :doc:`/users/advanced/index`
src/bonsai/docs/users/drawing/index.rst
+3 -3
View File
@@ -2,7 +2,7 @@
Drawings and Documents
======================
The BlenderBIM Add-on provides powerful tools for generating 2D drawings from your 3D BIM models and adding detailed annotations.
Bonsai provides powerful tools for generating 2D drawings from your 3D BIM models and adding detailed annotations.
This section covers the process of creating various types of drawings and enhancing them with annotations.
Prerequisites
@@ -11,7 +11,7 @@ Prerequisites
Before starting with 2D drafting:
1. Ensure you have completed the IFC modeling section or have a completed IFC model ready.
2. Install and update to the latest compatible version of the BlenderBIM addon as Drafting module is still in early development.
2. Install and update to the latest compatible version of Bonsai as the Drafting module is still in early development.
3. Install InkScape as the drafting is heavily based on SVG files.
Generating 2D Drawings
@@ -116,4 +116,4 @@ After mastering these basics, you may want to explore:
- Advanced annotation techniques
Remember, effective drawings are key to communicating your design intent.
Take time to explore the various options and develop a consistent style for your project documentation.
Take time to explore the various options and develop a consistent style for your project documentation.
src/bonsai/docs/users/git_support.rst
+16 -16
View File
@@ -1,10 +1,10 @@
Tracking revisions with Git
===========================
BlenderBIM supports tracking the development of your IFC files with a Git
Bonsai supports tracking the development of your IFC files with a Git
repository.
BlenderBIM is an IFC file editor, you can create or load an IFC project,
Bonsai is an IFC file editor, you can create or load an IFC project,
change, add or remove BIM objects and save to disk. A Git repository is a
special folder on your computer where text files, such as IFC files, can be
efficiently stored and past versions recalled.
@@ -24,7 +24,7 @@ Adding your IFC file to a repository
First, save your file to disk. If the folder is already a repository you can
*Add* the file in the *IFC Git panel* to tell Git you want to track it,
otherwise BlenderBIM will offer to convert the folder into a repository.
otherwise Bonsai will offer to convert the folder into a repository.
.. Warning::
@@ -41,7 +41,7 @@ the top of the revision list.
As you work on your IFC project, save the file regularly as usual. When you
get to a point where it would be useful to later retrieve this state, you need
to *commit* this to the Git repository. BlenderBIM gives you three options:
to *commit* this to the Git repository. Bonsai gives you three options:
- Showing uncommitted changes will temporarily highlight the differences
between the saved file and the last committed revision. Green objects are new
@@ -77,20 +77,20 @@ Viewing object history
----------------------
The history of *everything* in the project is tracked in Git, the revision log
for the currently selected object can be viewed with the BlenderBIM side-bar.
for the currently selected object can be viewed with the Bonsai side-bar.
Retrieving Revisions
--------------------
Colourising the model will show you *which* things are different, but it won't
show you *how* they are different. As long as you have no uncommitted changes,
you can switch to the selected revision, this will load in BlenderBIM as a
you can switch to the selected revision, this will load in Bonsai as a
full model that can be viewed and even edited.
.. Warning::
Switching to a different revision actually changes the file on disk before
loading it in BlenderBIM. Don't worry, the original hasn't been lost,
loading it in Bonsai. Don't worry, the original hasn't been lost,
simply select the revision at the top of the list, switch back to
that and you can continue as before.
@@ -108,12 +108,12 @@ other branches.
this is a convention, and older versions of Git call it *master*. Branch
names should be short, but can contain unicode characters, emojis etc...
Branch names can't contain spaces, and have some other minor limitations -
BlenderBIM will not allow you to create invalid branch names.
Bonsai will not allow you to create invalid branch names.
To create a new branch from the current HEAD (ie. the top of the revision list)
enter a branch name when committing. Leaving this field empty just adds a
normal commit without creating a branch, however committing a change to an
earlier revision necessarily implies a new branch, so BlenderBIM will insist
earlier revision necessarily implies a new branch, so Bonsai will insist
that you give it a name.
Each branch can now be navigated separately in the revision list, to switch
@@ -147,9 +147,9 @@ changes don't directly conflict.
When two branches have diverged, merging an IFC model requires *conflict
resolution* (because added entities may inadvertently reuse the same Step-IDs),
this means that data on one side or the other may be rewritten by BlenderBIM in
this means that data on one side or the other may be rewritten by Bonsai in
order to accommodate both sets of changes. ie. the merge process is
*asymmetrical*. BlenderBIM privileges data in the remote `origin/main` branch
*asymmetrical*. Bonsai privileges data in the remote `origin/main` branch
over the local working branch, similarly it privileges data in the local `main`
branch over any other local working branch. The practical result of this is
that branches branched-off the `main` branch can generally be merged back into
@@ -169,7 +169,7 @@ optional message text.
Tag names have the same limitations as branch names, names should be short
and without spaces, but can contain unicode characters, emojis etc...
BlenderBIM will not allow you to create invalid or duplicate tag names.
Bonsai will not allow you to create invalid or duplicate tag names.
Similar to commit messages, tag messages should be 50 characters or less,
though there is no practical limit.
@@ -190,7 +190,7 @@ could be hosted by an online Git-forge service.
Your repository can have multiple remote repositories registered, each
can have potentially multiple branches.
BlenderBIM allows you to make a local *clone* of a remote repository. You will
Bonsai allows you to make a local *clone* of a remote repository. You will
need to provide a URL *origin* to fetch, and an empty local folder to become
the local repository.
@@ -208,14 +208,14 @@ tries to update the remote branch using changes from the selected local branch.
protocols, for example, can require authentication. This authentication may
expect you to generate and upload ssh keys, store API tokens, save
username/password pairs, or use some other form of credential.
BlenderBIM can't configure these credentials for you, follow the
Bonsai can't configure these credentials for you, follow the
configuration instructions provided by your online service before trying
actions that require authentication.
Using other Git tools
---------------------
BlenderBIM is not a full Git user interface, but it provides most of the tools
Bonsai is not a full Git user interface, but it provides most of the tools
you will need for day-to-day usage. In general if you need other Git
functionality you can use external Git tools with your repository and any
changes will be reflected in the BlenderBIM UI.
changes will be reflected in the Bonsai UI.
src/bonsai/docs/users/modeling/advanced_modeling/material_assignment.rst
+5 -5
View File
@@ -1,7 +1,7 @@
Material Assignment
===================
This section covers how to assign and customize materials in your BIM model using the BlenderBIM Add-on.
This section covers how to assign and customize materials in your BIM model using the Bonsai.
Types of Material Definitions
-----------------------------
@@ -34,7 +34,7 @@ Materials should be categorized for easy identification and scheduling:
To view all materials in your project:
1. Go to the Materials schedule in the BlenderBIM panels.
1. Go to the Materials schedule in the Bonsai panels.
2. You'll see a list of all materials used in the model.
Best Practices for Material Naming
@@ -66,7 +66,7 @@ For structural models, especially steel structures:
To view profiles:
1. Look for the Profiles schedule in BlenderBIM panels.
1. Look for the Profiles schedule in Bonsai panels.
2. You should see a list of all profiles used in the project.
Color vs. Material
@@ -82,7 +82,7 @@ Avoid merging these concepts; an object can have a material without a specific c
Saving and Exporting
--------------------
Remember that BlenderBIM .ifc files cannot currently save textures from image files. To preserve both BIM data and detailed materials:
Remember that Bonsai .ifc files cannot currently save textures from image files. To preserve both BIM data and detailed materials:
1. Save your project as a .blend file to retain all material and texture information for rendering.
2. Also save as an .ifc file to store BIM data.
@@ -99,4 +99,4 @@ See Also
--------
- :doc:`../../structural_analysis/index`
- :doc:`../../costing_and_scheduling/index`
- :doc:`../../costing_and_scheduling/index`
src/bonsai/docs/users/modeling/advanced_modeling/parametric_geometry.rst
+2 -2
View File
@@ -1,7 +1,7 @@
Parametric Geometry
===================
The BlenderBIM Add-on provides tools for creating and editing parametric geometry for IFC elements.
Bonsai provides tools for creating and editing parametric geometry for IFC elements.
Parametric geometry allows you to define building elements using parameters that can be easily adjusted, rather than modeling fixed geometry.
Key features of the parametric geometry system include:
@@ -34,4 +34,4 @@ The parametric definition is stored in the IFC data and can be exchanged with ot
Some elements like windows and doors have additional specialized parametric options in their respective tools.
Parametric geometry allows for efficient modeling and updating of BIM elements while maintaining IFC compatibility.
Experiment with the available options to find parametric workflows that suit your modeling needs.
Experiment with the available options to find parametric workflows that suit your modeling needs.
src/bonsai/docs/users/modeling/basic_modeling/creating_walls.rst
+3 -3
View File
@@ -1,10 +1,10 @@
Creating Walls
--------------
Walls are fundamental elements in any building design. BlenderBIM provides powerful tools for creating and manipulating wall elements.
Walls are fundamental elements in any building design. Bonsai provides powerful tools for creating and manipulating wall elements.
This section will guide you through the process of creating standalone walls, multiple connected walls, and joining walls using various techniques.
By following these steps and utilizing the various tools provided by BlenderBIM,
By following these steps and utilizing the various tools provided by Bonsai,
you can efficiently create, modify, and join walls to form complex building layouts.
Remember to use snapping and alignment tools to ensure precision in your model.
@@ -35,7 +35,7 @@ Creating Multiple Connected Walls
Modifying and Joining Walls
^^^^^^^^^^^^^^^^^^^^^^^^^^^
BlenderBIM offers various tools for modifying and joining wall segments:
Bonsai offers various tools for modifying and joining wall segments:
- **Extend (SHIFT + E)**: Extend an existing wall to intersect with another face.
- **Butt (SHIFT + T)**: Join wall segments end-to-end.
src/bonsai/docs/users/modeling/basic_modeling/openings/door.rst
+2 -2
View File
@@ -6,14 +6,14 @@ A door is a wall opening that allows passage between spaces, controlled access f
In IFC, it's represented by the IfcDoor entity, which is a subtype of IfcBuildingElement.
Doors play a crucial role in building design, affecting circulation, accessibility, and space functionality.
This section covers how to add and customize doors in your BIM model using the BlenderBIM Add-on.
This section covers how to add and customize doors in your BIM model using Bonsai.
Adding a Door
-------------
1. Select the wall where you want to place the door.
2. Set the 3D cursor on the wall at the desired door location.
3. Click on the "Create Door" tool in the BlenderBIM toolbar.
3. Click on the "Create Door" tool in the Bonsai toolbar.
4. In the top bar, you'll see "[No IfcDoorType Found] | Name [TYPEX] | + Add IfcDoorType".
5. Edit [TYPEX] to use a door type name of your choice (e.g., DOOR001).
6. Click "+ Add IfcDoorType". The top bar will update with additional options.
src/bonsai/docs/users/modeling/basic_modeling/openings/index.rst
+3 -3
View File
@@ -1,7 +1,7 @@
Openings
========
This section covers the creation and management of openings in BlenderBIM.
This section covers the creation and management of openings in Bonsai.
Openings are crucial elements in building design, serving various purposes such as passage, ventilation, and lighting.
.. only:: builder_html and (not singlehtml)
@@ -33,7 +33,7 @@ standard, openings are represented through a combination of elements:
2. Fillings: These are the elements that occupy the voids, such as doors (IfcDoor) or windows (IfcWindow).
3. Relationships: These are abstract objects that connect fillings to voids and voids to elements in which they're created.
BlenderBIM provides tools to create and manage these elements:
Bonsai provides tools to create and manage these elements:
- Door Creation Tool: For adding doors to walls.
- Window Creation Tool: For adding windows to walls.
@@ -47,7 +47,7 @@ These tools allow you to:
- Modify opening properties and geometries.
- Manage the relationships between walls, voids, and fillings.
The following pages provide detailed guides on working with each type of wall opening in BlenderBIM.
The following pages provide detailed guides on working with each type of wall opening in Bonsai.
.. container:: global-index-toc
src/bonsai/docs/users/modeling/basic_modeling/openings/opening.rst
+1 -4
View File
@@ -8,7 +8,7 @@ These openings can serve various purposes such as ventilation, pass-throughs, se
In IFC, it's represented by the IfcOpeningElement entity, which is a subtype of IfcFeatureElementSubtraction.
This section covers how to create openings without fillings in your BIM model using the BlenderBIM Add-on.
This section covers how to create openings without fillings in your BIM model using Bonsai.
Creating an Opening Without Filling
@@ -31,9 +31,6 @@ Here's the process:
This process will leave you with an opening element without a filling.
.. note::
Future versions of BlenderBIM may include a dedicated tool for creating openings without fillings, which would simplify this process.
Additionally, you can create an opening by using the "Add Void" button in Create Wall tool.
This tool will add an Opening IFC element to the Outline and its 3D representation in the 3D Vieport.
Blender move and scale tools will allow you to modify the opening.
src/bonsai/docs/users/modeling/basic_modeling/openings/window.rst
+3 -3
View File
@@ -6,14 +6,14 @@ A window is an opening that allows light and air to enter a building, providing
In IFC, it's represented by the IfcWindow entity, which is a subtype of IfcBuildingElement.
Windows play a crucial role in building design, affecting natural lighting, ventilation, energy efficiency, and aesthetics.
This section covers how to add and customize windows in your BIM model using the BlenderBIM Add-on.
This section covers how to add and customize windows in your BIM model using Bonsai.
Adding a Window
---------------
1. Select the wall where you want to place the window.
2. Set the 3D cursor on the wall at the desired window location.
3. Click on the "Create Window" tool in the BlenderBIM toolbar.
3. Click on the "Create Window" tool in the Bonsai toolbar.
4. In the top bar, you'll see "[No IfcWindowType Found] | Name [TYPEX] | + Add IfcWindowType".
5. Edit [TYPEX] to use a window type name of your choice (e.g., WINDOW001).
6. Click "+ Add IfcWindowType". The top bar will update with additional options.
@@ -142,4 +142,4 @@ See Also
--------
- :doc:`../creating_walls`
- :doc:`../../advanced_modeling/material_assignment`
- :doc:`../../advanced_modeling/material_assignment`
src/bonsai/docs/users/modeling/ifc_concepts/geometry_and_representations.rst
+7 -7
View File
@@ -4,7 +4,7 @@ Geometry and Representations
Understanding IFC Elements and Geometry
---------------------------------------
In BlenderBIM, it's crucial to understand the relationship between IFC elements, their classification, types, and geometry.
In Bonsai, it's crucial to understand the relationship between IFC elements, their classification, types, and geometry.
These concepts work together but serve different purposes.
IFC Classification
@@ -47,7 +47,7 @@ IFC supports various geometry types:
- Mesh-like: Facetations, tessellations, triangulations, or planar breps.
- Solid modeling: CSGs, swept solids, extrusions, lofts, etc.
In BlenderBIM, you can create simple mesh geometries (like a cube) and assign them to IFC elements.
In Bonsai, you can create simple mesh geometries (like a cube) and assign them to IFC elements.
However, for more complex elements like walls, slabs, or columns, other representation types are more appropriate.
Parametric Materials
@@ -60,12 +60,12 @@ IFC standardizes certain parametric modeling techniques:
These are typically defined at the type level and inherited by occurrences.
Working with Representations in BlenderBIM
------------------------------------------
Working with Representations in Bonsai
--------------------------------------
- Creating swept solids: Currently, the best method is to use parametric material layers (e.g., for walls) or material profiles.
- Mesh editing: For mesh-like representations, you can edit them directly in Blender's edit mode.
- Non-mesh modeling: BlenderBIM currently has limited tools for direct modeling of non-mesh geometries.
- Non-mesh modeling: Bonsai currently has limited tools for direct modeling of non-mesh geometries.
Future updates will include more intuitive interfaces for this purpose.
- Deleting representations: This should be avoided as it can create invalid IFC data.
If you delete a representation, the element should no longer be visible in the 3D view.
@@ -77,5 +77,5 @@ Working with Representations in BlenderBIM
Future Developments
-------------------
The BlenderBIM team plans to develop more intuitive interfaces for non-mesh direct modeling tools in future versions.
This will make it easier to create and manipulate complex geometric representations without needing to understand the intricacies of IFC data structures.
The Bonsai team plans to develop more intuitive interfaces for non-mesh direct modeling tools in future versions.
This will make it easier to create and manipulate complex geometric representations without needing to understand the intricacies of IFC data structures.
src/bonsai/docs/users/modeling/ifc_concepts/working_with_representations.rst
+6 -6
View File
@@ -1,7 +1,7 @@
Working with Representations
----------------------------
BlenderBIM provides tools to view, edit, and manage representations of IFC elements directly within Blender's interface.
Bonsai provides tools to view, edit, and manage representations of IFC elements directly within Blender's interface.
This section covers how to work with these representations effectively.
Viewing Representations
@@ -37,10 +37,10 @@ To add a new representation to an element:
4. In the dialog that appears, choose the method for creating the representation (e.g., Trace Outline, Bounding Box).
5. Follow any additional prompts to complete the creation of the new representation.
Common Representation Types in BlenderBIM
Common Representation Types in Bonsai
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
BlenderBIM supports several representation types, each suitable for different purposes:
Bonsai supports several representation types, each suitable for different purposes:
1. SweptSolid
- RepresentationIdentifier: 'Body'
@@ -76,7 +76,7 @@ BlenderBIM supports several representation types, each suitable for different pu
Converting Representations
^^^^^^^^^^^^^^^^^^^^^^^^^^
BlenderBIM offers tools to convert between different representation types:
Bonsai offers tools to convert between different representation types:
1. Select the representation you want to convert.
2. In the Representation Utilities section, you'll find options like:
@@ -99,10 +99,10 @@ Best Practices
Future Developments
^^^^^^^^^^^^^^^^^^^
The BlenderBIM team is continually working on improving the representation editing experience. Future updates may include:
The Bonsai team is continually working on improving the representation editing experience. Future updates may include:
- More intuitive interfaces for non-mesh modeling.
- Enhanced tools for working with parametric representations.
- Improved validation and error checking when editing representations.
For the latest updates and feature requests, refer to the BlenderBIM Add-on GitHub repository.
For the latest updates and feature requests, refer to the Bonsai GitHub repository.
src/bonsai/docs/users/modeling/ifc_modeling.rst
+4 -4
View File
@@ -2,7 +2,7 @@
IFC modeling
============
This chapter covers the essential aspects of working with Industry Foundation Classes (IFC) in BlenderBIM. It is divided into five main sections:
This chapter covers the essential aspects of working with Industry Foundation Classes (IFC) in Bonsai. It is divided into five main sections:
.. only:: builder_html and (not singlehtml)
@@ -20,14 +20,14 @@ This chapter covers the essential aspects of working with Industry Foundation Cl
.. container:: card
:doc:`importing_viewing_models`
A guide on how to import existing IFC models into BlenderBIM and navigate them effectively.
This section includes techniques for inspecting and querying IFC data within the BlenderBIM environment.
A guide on how to import existing IFC models into Bonsai and navigate them effectively.
This section includes techniques for inspecting and querying IFC data within the Bonsai environment.
.. container:: card
:doc:`starting_new_project`
Instructions on creating and setting up a new IFC project from scratch in BlenderBIM.
Instructions on creating and setting up a new IFC project from scratch in Bonsai.
This covers initial project setup, including advanced options for more complex projects.
.. container:: card
src/bonsai/docs/users/modeling/interface.rst
+10 -10
View File
@@ -1,16 +1,16 @@
============================
BlenderBIM Interface Guide
Bonsai Interface Guide
============================
Introduction
============
The BlenderBIM interface extends Blender's powerful 3D environment with specialized tools for Building Information Modeling (BIM). This guide will help you navigate the BlenderBIM interface and understand its key components.
Bonsai's interface extends Blender's powerful 3D environment with specialized tools for Building Information Modeling (BIM). This guide will help you navigate the Bonsai interface and understand its key components.
BlenderBIM Workspace
====================
Bonsai Workspace
================
When you start Blender with BlenderBIM installed, you can switch to the BlenderBIM workspace
When you start Blender with Bonsai installed, you can switch to the Bonsai workspace
by clicking on the BIM workspace tab at the top of the Blender window.
This workspace is preconfigured with the most commonly used panels and tools for BIM workflows.
@@ -51,7 +51,7 @@ Found in the Outliner, the IFC Tree View displays the hierarchical structure of
Customizing the Interface
=========================
BlenderBIM respects Blender's highly customizable interface. You can:
Bonsai respects Blender's highly customizable interface. You can:
- Rearrange editors and panels
- Save custom workspace layouts
@@ -61,13 +61,13 @@ Tips for Efficient Use
======================
1. Familiarize yourself with IFC classes and their properties.
2. Utilize Blender's search function (F3) to quickly access BlenderBIM tools.
2. Utilize Blender's search function (F3) to quickly access Bonsai tools.
Next Steps
==========
Now that you're familiar with the BlenderBIM interface, you have two main paths to continue your learning:
Now that you're familiar with the Bonsai interface, you have two main paths to continue your learning:
1. Proceed with IFC Modeling:
If you're ready to start creating and working with BIM models, you can move on to:
@@ -75,7 +75,7 @@ Now that you're familiar with the BlenderBIM interface, you have two main paths
- :doc:`IFC Modeling Basics </users/modeling/ifc_modeling>`
2. Dive deeper into the User Interface:
If you want to explore more details about the BlenderBIM interface, you can refer to:
If you want to explore more details about the Bonsai interface, you can refer to:
- :doc:`User Interface Reference </users/user_interface>`
@@ -86,7 +86,7 @@ Remember, as you become more comfortable with the interface and basic modeling,
- :doc:`Generating Documentation </users/drawing/index>`
- :doc:`Advanced BIM Techniques </users/advanced/index>`
The BlenderBIM interface is designed to integrate seamlessly with Blender while providing powerful BIM-specific functionality.
The Bonsai interface is designed to integrate seamlessly with Blender while providing powerful BIM-specific functionality.
As you progress, you'll find your BIM workflow becoming increasingly efficient and productive.
src/bonsai/docs/users/modeling/starting_new_project.rst
+5 -5
View File
@@ -62,9 +62,9 @@ Using New Project Wizard / Scene Properties
Cleaning the scene
------------------
- After creating a new project, BlenderBIM considers the presence of three default Blender objects:
- After creating a new project, Bonsai considers the presence of three default Blender objects:
a mesh (usually the default cube), a camera, and a light.
- If have scene setup like this, BlenderBIM will clean it up
- If have scene setup like this, Bonsai will clean it up
- Any customizations you make to the Blender scene before finalizing the IFC project creation will be preserved.
If you like, you can delete the default cube, camera and light manually. Or create your own objects.
@@ -92,7 +92,7 @@ Saving
Project Info in Unsaved Mode
After creating a new project, BlenderBIM enters an Unsaved Mode. It's important to understand how saving works in BlenderBIM:
After creating a new project, Bonsai enters an Unsaved Mode. It's important to understand how saving works in Bonsai:
**Saving IFC Project**:
- Using the keyboard shortcut `Ctrl+S` or `File > Save IFC Project` will save only the `.ifc` file.
@@ -124,7 +124,7 @@ After creating a new project, BlenderBIM enters an Unsaved Mode. It's important
- Focus on the `.ifc` file as the primary source of truth for your BIM data.
- Use `.blend` files if you need to preserve specific Blender setups or visual configurations, but remember these are secondary to the IFC data.
Remember, in BlenderBIM, the `.ifc` file contains the critical BIM information.
Remember, in Bonsai, the `.ifc` file contains the critical BIM information.
The `.blend` file is primarily for Blender-specific settings and visual representations.
Always ensure your IFC project is saved before closing Blender or starting a new session.
If you need to preserve Blender-specific configurations, save the `.blend` file separately.
@@ -140,4 +140,4 @@ Next Steps
.. seealso::
- :doc:`/users/user_interface/property_editor/scene_editor/project_overview/project_info`
- :doc:`/users/user_interface/topbar`
- :doc:`/users/user_interface/topbar`
src/bonsai/docs/users/modeling/understanding_ifc.rst
+3 -3
View File
@@ -21,7 +21,7 @@ They also develop other related standards like BCF (BIM Collaboration Format) an
IfcOpenShell
------------
IfcOpenShell is the open-source software library used by BlenderBIM to read, write, and manipulate IFC files.
IfcOpenShell is the open-source software library used by Bonsai to read, write, and manipulate IFC files.
It provides the core functionality for working with IFC data.
Interoperability and Other Standards
@@ -40,7 +40,7 @@ and preserves data integrity throughout the building lifecycle.
Key Concepts
============
This section provides an overview of key IFC concepts and how they're implemented in BlenderBIM.
This section provides an overview of key IFC concepts and how they're implemented in Bonsai.
.. only:: builder_html and (not singlehtml)
@@ -65,7 +65,7 @@ This section provides an overview of key IFC concepts and how they're implemente
.. container:: card
:doc:`ifc_concepts/working_with_representations`
Representations in BlenderBIM.
Representations in Bonsai.
.. container:: global-index-toc
src/bonsai/docs/users/other_addons.rst
+5 -8
View File
@@ -1,16 +1,15 @@
Other add-ons
=============
Blender has a large ecosystem of add-ons. The BlenderBIM Add-on is one of many
add-ons which provide utility to the architecture, engineering, and construction
industry.
Blender has a large ecosystem of add-ons. Bonsai is one of many add-ons which
provide utility to the architecture, engineering, and construction industry.
Some of these add-ons come with Blender and merely need to be enabled in the
``Edit > Preferences > Add-ons`` tab.
- **Sun Position** - will allow you to set the correct location of the sun and
true north. Integrates with IFC4 georeferencing features in the BlenderBIM
Add-on.
true north. Integrates with IFC4 georeferencing and solar analysis features
in Bonsai.
- **AutoCAD DXF Format (.dxf)** - provides import and export support of the DXF
format in Blender.
- **tinyCAD Mesh tools** - provides basic intersection and circle reconstruction
@@ -23,9 +22,7 @@ Some of these add-ons are not shipped with Blender:
highly recommended for precision modeling in Blender.
- `Blender Archipack <https://blender-archipack.org/>`__ - Archipack lets you
create parametric architectural objects, like walls, floors, ceilings, doors,
roofs, and furniture with a single click from a preset templates. It
integrates with the BlenderBIM Add-on, so you have the choice to combine both
parametric and modeling by hand.
roofs, and furniture with a single click from a preset templates.
- `Sverchok <https://github.com/nortikin/sverchok/>`__ - Sverchok is a visual
programming add-on for Blender that allows you to generate parametric
geometry, create scripts for non-programmers, model solids from FreeCAD, and
src/bonsai/docs/users/quickstart/explore_model.rst
+1 -1
View File
@@ -25,7 +25,7 @@ Blender's interface is divided into three panels. The left **Outliner** panel
shows a tree of geometric objects. The centre main **Viewport** panel shows 3D
geometry. The right **Properties** panel shows data and relationships.
.. image:: images/blenderbim-layout.png
.. image:: images/bonsai-layout.png
The **Properties** panel has tabs to switch between different types of
properties.
src/bonsai/docs/users/quickstart/images/blenderbim-layout.png → src/bonsai/docs/users/quickstart/images/bonsai-layout.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 305 KiB

After

Width:  |  Height:  |  Size: 305 KiB

src/bonsai/docs/users/quickstart/images/install-blenderbim-1.png → src/bonsai/docs/users/quickstart/images/install-bonsai-1.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 215 KiB

After

Width:  |  Height:  |  Size: 215 KiB

src/bonsai/docs/users/quickstart/images/install-blenderbim-2.png → src/bonsai/docs/users/quickstart/images/install-bonsai-2.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 48 KiB

src/bonsai/docs/users/quickstart/images/install-blenderbim-3.png → src/bonsai/docs/users/quickstart/images/install-bonsai-3.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 35 KiB

src/bonsai/docs/users/quickstart/images/install-blenderbim-4.png → src/bonsai/docs/users/quickstart/images/install-bonsai-4.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 82 KiB

After

Width:  |  Height:  |  Size: 82 KiB

src/bonsai/docs/users/quickstart/images/install-blenderbim-5.png → src/bonsai/docs/users/quickstart/images/install-bonsai-5.png
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 199 KiB

After

Width:  |  Height:  |  Size: 199 KiB

src/bonsai/docs/users/quickstart/installation.rst
+5 -5
View File
@@ -17,23 +17,23 @@ Installation
2. Open up Blender, and click on ``Edit > Preferences``.
.. image:: images/install-blenderbim-1.png
.. image:: images/install-bonsai-1.png
3. Select the **Get Extensions** tab, and press **Allow Online Access**.
.. image:: images/install-blenderbim-2.png
.. image:: images/install-bonsai-2.png
4. Search for **Bonsai** in the top left search bar, then press the **Install** button.
.. image:: images/install-blenderbim-3.png
.. image:: images/install-bonsai-3.png
5. You should now see **Bonsai** available in your add-ons list. You're done!
.. image:: images/install-blenderbim-4.png
.. image:: images/install-bonsai-4.png
Your interface will now look similar to below. If you check the ``File`` menu you should also see an option to ``Open IFC Project``.
.. image:: images/install-blenderbim-5.png
.. image:: images/install-bonsai-5.png
You can enable add-ons permanently by using ``Save User Settings`` from the Addons menu.
src/bonsai/docs/users/quickstart/introduction_to_bim.rst
+7 -46
View File
@@ -33,17 +33,17 @@ construction type, and quantities. **IFC** will also describe that a wall that
be associated with a location, like a building storey, or have an associated
cost item in a schedule.
When you use the BlenderBIM Add-on, you will be able to view and create **BIM**
objects and relationships using the **IFC** standard.
When you use Bonsai, you will be able to view and create **BIM** objects and
relationships using the **IFC** standard.
Things you can do
-----------------
The BlenderBIM Add-on is designed to be a comprehensive and truly native
BIM authoring platform. Its capabilities include a wide range of tasks
and workflows typically found across various BIM and CAD software, costing
programs, scheduling tools, and simulation applications. While not
an exhaustive list, some of the key things you can do with BlenderBIM include:
Bonsai is designed to be a comprehensive and truly native BIM authoring
platform. Its capabilities include a wide range of tasks and workflows
typically found across various BIM and CAD software, costing programs,
scheduling tools, and simulation applications. While not an exhaustive list,
some of the key things you can do with Bonsai include:
- View and explore IFC models, including spaces, properties, and relationships
- Edit and extract attributes, properties, and metadata directly from IFC data
@@ -57,42 +57,3 @@ an exhaustive list, some of the key things you can do with BlenderBIM include:
- Derive quantities from model elements and create cost schedules with formulas
- Perform clash detection and coordinate models, managing issues across disciplines
- Integrate non-geometric data like costing, scheduling, and asset management
Roadmap and Upcoming Features
-----------------------------
While BlenderBIM already offers a comprehensive set of BIM authoring capabilities,
the development team and community are continuously working to expand its functionality and improve existing workflows.
Some of the most ambitious features and enhancements on the roadmap include:
Usability and Workflow Enhancements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Improve user-friendliness to equip average "Joe" with capabilities to model simple projects like single family homes, making BlenderBIM a viable alternative to SketchUp.
- Make BlenderBIM more approachable for users across different skill levels, from advanced BIM experts to architects working on smaller residential projects.
Improved Drawing and Documentation Workflows
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Continued enhancements to the drawing generation capabilities, including better dimensioning tools and support for associative dimensions linked to model geometry.
- Advanced annotation tools with customizable tags, callouts, and the ability to define reusable annotation styles and templates.
- Streamlined sheet layout management and improved integration with external tools like Inkscape for creating title blocks and sheet compositions.
- Continued improvement of BlenderBIM's ability to generate comprehensive documentation sets, including drawing annotations, door schedules, wall schedules, and material tagging.
Expanded Parametric Modeling Capabilities
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Native modeling tools for complex building elements like curtain wall systems and facade panels.
- Expanded libraries with support for country-specific and manufacturer-provided object types.
- Enhanced support for multi-story modeling, enabling efficient duplication and coordination of building elements across various levels.
- Expanded parametric relationships and automating more common BIM tasks to reduce manual effort and enhance productivity.
Enhanced Coordination and Collaboration Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Robust model merge and coordination workflows, with detailed clash detection capabilities across different disciplines and data sources.
- Built-in support for version control and model sharing using Git repositories, enabling better team collaboration and change tracking.
The development roadmap is continuously updated based on user feedback, industry requirements,
and contributions from the open-source community. By embracing an open and collaborative approach,
BlenderBIM aims to push the boundaries of what's possible in BIM authoring,
ensuring that it remains at the forefront of innovation in the AEC industry.
src/bonsai/docs/users/quickstart/next_steps.rst
+2 -2
View File
@@ -1,7 +1,7 @@
Next Steps
==========
Now that you've completed the quickstart guide, you're ready to dive deeper into BlenderBIM's capabilities. Here are some suggested next steps to continue your learning journey:
Now that you've completed the quickstart guide, you're ready to dive deeper into Bonsai's capabilities. Here are some suggested next steps to continue your learning journey:
* :doc:`Modeling and Creating IFC Models </users/modeling/ifc_modeling>`
Explore advanced modeling techniques and learn how to create complex IFC models.
@@ -9,4 +9,4 @@ Now that you've completed the quickstart guide, you're ready to dive deeper into
* :doc:`Tutorials and Real-World Projects </users/tutorials/index>`
Apply your skills to practical, real-world BIM projects with our step-by-step tutorials.
These resources will help you build upon the foundation you've established and develop more advanced skills in using BlenderBIM for your architectural and engineering projects.
These resources will help you build upon the foundation you've established and develop more advanced skills in using Bonsai for your architectural and engineering projects.
src/bonsai/docs/users/structural_analysis/index.rst
+5 -5
View File
@@ -1,7 +1,7 @@
Structural Analysis
===================
This section covers the structural analysis capabilities in BlenderBIM.
This section covers the structural analysis capabilities in Bonsai.
.. note::
This page is a stub. More detailed content will be added in future updates.
@@ -9,7 +9,7 @@ This section covers the structural analysis capabilities in BlenderBIM.
Overview
--------
BlenderBIM provides tools for structural analysis within the BIM environment.
Bonsai provides tools for structural analysis within the BIM environment.
This integration allows for seamless workflow between architectural and structural engineering disciplines.
Key Features
@@ -22,12 +22,12 @@ Key Features
Getting Started
---------------
To begin using the structural analysis features in BlenderBIM:
To begin using the structural analysis features in Bonsai:
1. Ensure your model contains properly defined structural elements
2. Access the Structural Analysis panel in the BlenderBIM interface
2. Access the Structural Analysis panel in the Bonsai interface
3. Define load cases and boundary conditions
.. seealso::
- :doc:`/users/modeling/ifc_modeling`
- :doc:`/users/advanced/index`
- :doc:`/users/advanced/index`
src/bonsai/docs/users/tutorials/project0.rst
+11 -11
View File
@@ -2,14 +2,14 @@
Project 0: Designing a Room
===========================
In this introductory project, you'll learn the basics of using BlenderBIM to design a simple room.
In this introductory project, you'll learn the basics of using Bonsai to design a simple room.
By the end of this tutorial, you'll have created a basic 3D model and a 2D floor plan drawing.
Prerequisites
=============
- Basic knowledge of Blender interface
- BlenderBIM Add-on installed and activated
- Bonsai installed and activated
Learning Objectives
===================
@@ -32,7 +32,7 @@ Tutorial Steps
Setup the `project0` project.
1. Open Blender and switch to the BlenderBIM workspace.
1. Open Blender and switch to the Bonsai workspace.
2. Create a new IFC project. Use Metric.
3. Save it as `project0.ifc` file.
4. (optional) Save the `project0.blend` file.
@@ -43,10 +43,10 @@ Tutorial Steps
-----------------
.. figure:: images/project0-walls.png
:alt: Creating Walls in BlenderBIM
:alt: Creating Walls in Bonsai
:width: 100%
Creating Walls in BlenderBIM
Creating Walls in Bonsai
1. Use the "Create Wall" tool to draw the room's perimeter of a room 6m by 3m. Use mitre join.
2. Add an interior wall across the room in the middle. Use butt join.
@@ -69,10 +69,10 @@ If you still struggling, here's what you should get:
------------------
.. figure:: images/project0-openings.png
:alt: Adding Openings in BlenderBIM
:alt: Adding Openings in Bonsai
:width: 100%
Adding Openings in BlenderBIM
Adding Openings in Bonsai
1. Create two door openings:
@@ -130,14 +130,14 @@ If you're having difficulties, you can download the sample file:
6. Placing Furniture
--------------------
1. Import basic furniture from the BlenderBIM library
1. Import basic furniture from the Bonsai library
2. Position and rotate furniture items
3. Adjust furniture properties if needed
7. Generating a Floor Plan
--------------------------
1. Set up a plan view using the BlenderBIM drawing tools
1. Set up a plan view using the Bonsai drawing tools
2. Add dimensions to the floor plan
3. Include basic annotations and labels
@@ -150,7 +150,7 @@ If you're having difficulties, you can download the sample file:
Conclusion
==========
Congratulations! You've completed your first room design using BlenderBIM. You should now have a basic understanding of creating walls, openings, slabs, and simple MEP elements, as well as generating a basic floor plan.
Congratulations! You've completed your first room design using Bonsai. You should now have a basic understanding of creating walls, openings, slabs, and simple MEP elements, as well as generating a basic floor plan.
Next Steps
==========
@@ -159,4 +159,4 @@ Next Steps
- Try creating a more complex room shape
- Explore additional MEP elements and their properties
In the next project, we'll build upon these skills to design a complete flat, introducing more advanced concepts and techniques.
In the next project, we'll build upon these skills to design a complete flat, introducing more advanced concepts and techniques.
src/bonsai/docs/users/tutorials/project1.rst
+5 -5
View File
@@ -2,7 +2,7 @@
Project 1: Designing a Flat
===========================
Building on the skills from Project 0, this tutorial will guide you through designing a complete flat using BlenderBIM.
Building on the skills from Project 0, this tutorial will guide you through designing a complete flat using Bonsai.
You'll learn more advanced techniques for creating walls and openings, working with profiles, defining rooms and spaces,
and generating more detailed drawings.
@@ -10,7 +10,7 @@ Prerequisites
=============
- Completion of Project 0: Designing a Room
- Familiarity with basic BlenderBIM tools and interface
- Familiarity with basic Bonsai tools and interface
Learning Objectives
===================
@@ -27,7 +27,7 @@ Tutorial Steps
1. Project Setup
----------------
1. Open Blender and switch to the BlenderBIM workspace
1. Open Blender and switch to the Bonsai workspace
2. Create a new IFC project
3. Save it as `project1.ifc` file (and optionally, `project1.blend` file)
4. Load custom libraries and templates
@@ -69,7 +69,7 @@ Tutorial Steps
6. Using Furniture and Fixture Libraries
----------------------------------------
1. Import furniture from BlenderBIM libraries
1. Import furniture from Bonsai libraries
2. Place and arrange furniture in each room
3. Add plumbing fixtures (sinks, toilets, bathtub/shower)
4. Include kitchen appliances and cabinetry
@@ -116,4 +116,4 @@ Next Steps
- Explore more advanced MEP systems
- Learn about creating custom annotation styles for drawings
In the next project, we'll scale up to design a full bungalow, introducing concepts like roof design, foundations, and basic structural elements.
In the next project, we'll scale up to design a full bungalow, introducing concepts like roof design, foundations, and basic structural elements.
src/bonsai/docs/users/tutorials/project2.rst
+3 -3
View File
@@ -2,7 +2,7 @@
Project 2: Building a Bungalow
==============================
In this project, we'll take your BlenderBIM skills to the next level by designing a complete bungalow.
In this project, we'll take your Bonsai skills to the next level by designing a complete bungalow.
You'll learn about roof design, advanced foundations, structural elements, and more complex MEP systems.
We'll also introduce basic costing and scheduling concepts.
@@ -10,7 +10,7 @@ Prerequisites
=============
- Completion of Project 1: Designing a Flat
- Good understanding of BlenderBIM's basic and intermediate features
- Good understanding of Bonsai's basic and intermediate features
Learning Objectives
===================
@@ -147,4 +147,4 @@ Next Steps
- Develop more detailed cost estimates and construction schedules
In the next project, we'll scale up to a multi-story single-family home, introducing concepts like complex roofs,
advanced MEP systems, and basic site landscaping.
advanced MEP systems, and basic site landscaping.
src/bonsai/docs/users/tutorials/project3.rst
+3 -3
View File
@@ -2,7 +2,7 @@
Project 3: Multi-Storey Single-Family Home
==========================================
In this project, we'll design a multi-storey single-family home using BlenderBIM.
In this project, we'll design a multi-storey single-family home using Bonsai.
This tutorial will introduce more advanced concepts such as templating, complex roofs, and sophisticated MEP systems.
We'll also touch on basic site landscaping.
@@ -10,7 +10,7 @@ Prerequisites
=============
- Completion of Project 2: Building a Bungalow
- Strong understanding of BlenderBIM's features and IFC concepts
- Strong understanding of Bonsai's features and IFC concepts
Learning Objectives
===================
@@ -150,4 +150,4 @@ Next Steps
- Study more advanced structural analysis integration
In the next project, we'll tackle a more complex residential development with multiple units,
introducing concepts like shared walls, parametric design, and clash detection.
introducing concepts like shared walls, parametric design, and clash detection.
src/bonsai/docs/users/tutorials/project4.rst
+3 -3
View File
@@ -2,7 +2,7 @@
Project 4: Terraced/Town Houses/Duplexes
========================================
In this project, we'll design a row of terraced houses, town houses, or duplexes using BlenderBIM.
In this project, we'll design a row of terraced houses, town houses, or duplexes using Bonsai.
This tutorial will introduce concepts such as shared walls, duplicating units, parametric design,
and collaboration with other stakeholders.
@@ -10,7 +10,7 @@ Prerequisites
=============
- Completion of Project 3: Multi-Storey Single-Family Home
- Advanced understanding of BlenderBIM and IFC concepts
- Advanced understanding of Bonsai and IFC concepts
Learning Objectives
===================
@@ -148,4 +148,4 @@ Next Steps
- Study algorithms for optimizing unit layouts and site arrangement
In the final project, we'll scale up to an apartment block, introducing concepts like vertical transportation,
advanced MEP systems, and complex structural analysis.
advanced MEP systems, and complex structural analysis.
src/bonsai/docs/users/tutorials/project5.rst
+5 -5
View File
@@ -2,7 +2,7 @@
Project 5: Apartment Block
==========================
In this final project, we'll design a complex apartment block using BlenderBIM.
In this final project, we'll design a complex apartment block using Bonsai.
This tutorial will introduce advanced concepts such as multi-level design, vertical transportation, parametric services,
complex structural elements, and advanced project management techniques.
@@ -10,7 +10,7 @@ Prerequisites
=============
- Completion of Project 4: Terraced/Town Houses/Duplexes
- Expert-level understanding of BlenderBIM and IFC concepts
- Expert-level understanding of Bonsai and IFC concepts
- Basic knowledge of structural and MEP engineering principles
Learning Objectives
@@ -168,7 +168,7 @@ Conclusion
==========
Congratulations on completing the design of a complex apartment block!
You've now mastered advanced concepts in multi-level building design, complex systems integration, and project lifecycle management using BlenderBIM.
You've now mastered advanced concepts in multi-level building design, complex systems integration, and project lifecycle management using Bonsai.
Next Steps
==========
@@ -180,5 +180,5 @@ Next Steps
- Learn about BIM implementation strategies for large organizations
This project concludes our tutorial series.
You now have a comprehensive understanding of using BlenderBIM for various scales of architectural projects,
from single rooms to complex multi-unit buildings.
You now have a comprehensive understanding of using Bonsai for various scales of architectural projects,
from single rooms to complex multi-unit buildings.
src/bonsai/docs/users/user_interface.rst
+1 -1
View File
@@ -1,7 +1,7 @@
User Interface Reference
========================
This section covers the general user interface of BlenderBIM. User interface documentation does not cover any specific use case but provides a general reference of BlenderBIM UI.
This section covers the general user interface of Bonsai. User interface documentation does not cover any specific use case but provides a general reference of Bonsai UI.
The documentation doesn't cover Blender UI, but makes references to `Blender documentation <https://docs.blender.org/manual/en/latest/interface/index.html>`__ where appropriate.
src/bonsai/docs/users/user_interface/property-editor.rst
+5 -5
View File
@@ -7,7 +7,7 @@ Property Editor Scene Properties
.. |location| image:: /images/location-scene.svg
BlenderBIM adds new functionality to the `Property Editor` -> `Scene` tab.
Bonsai adds new functionality to the `Property Editor` -> `Scene` tab.
.. figure:: images/interface_property-editor_project-overview_start-up.png
:alt: Property editor on Blender start-up
@@ -18,9 +18,9 @@ Most of these sub-tabs become available with a created or loaded IFC file.
Don't worry, the default Blender scene properties are still reachable under their own dedicated sub-tab.
.. figure:: images/interface_property-editor_icons.png
:alt: Overview over the added property sub-tabs by BlenderBIM
:alt: Overview over the added property sub-tabs by Bonsai
Overview over the added property sub-tabs by BlenderBIM.
Overview over the added property sub-tabs by Bonsai.
1. Project Overview
2. Object Information
@@ -37,9 +37,9 @@ Don't worry, the default Blender scene properties are still reachable under thei
You can also select the needed panel via the drop-down menue.
.. figure:: images/interface_property-editor_panel-dropdown.png
:alt: BlenderBIM property editor sub-tabs drop-down menue
:alt: Bonsai property editor sub-tabs drop-down menue
Switching between BlenderBIM property editor sub-tabs via the drop-down menue.
Switching between Bonsai property editor sub-tabs via the drop-down menue.
.. toctree::
src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/index.rst
+1 -1
View File
@@ -8,7 +8,7 @@ Project Overview
.. |location| image:: /images/location-scene.svg
.. |>| image:: /images/location-breadcrumb.svg
The Project Overview sub-tab in the BlenderBIM Add-on interface provides a central hub
The Project Overview sub-tab in the Bonsai interface provides a central hub
for accessing and managing essential information and settings related to an IFC project.
Located within the Scene Properties tab of Property Editor, this sub-tab is organized into several panels, each focusing on a specific aspect of the project.
src/bonsai/docs/users/user_interface/property_editor/scene_editor/project_overview/project_info.rst
+3 -2
View File
@@ -79,8 +79,9 @@ Fields
whereas the IFC4 Demo Template is recommended for users wanting to experiment
and learn with a basic set of objects.
The BlenderBIM Add-on provides other larger libraries containing hundreds of objects,
but loading them as a template is not recommended due to their size and complexity.
Bonsai provides other larger libraries containing hundreds of objects, but
loading them as a template is not recommended due to their size and
complexity.
.. seealso::
src/bonsai/docs/users/user_interface/toolbar/explore.rst
+5 -5
View File
@@ -1,9 +1,9 @@
Explore Tool
============
The Explore Tool is a powerful feature in BlenderBIM that enhances your ability to navigate and inspect IFC models.
The Explore Tool is a powerful feature in Bonsai that enhances your ability to navigate and inspect IFC models.
It introduces functionality commonly found in dedicated IFC viewers,
making BlenderBIM a more comprehensive native IFC authoring and viewing tool.
making Bonsai a more comprehensive native IFC authoring and viewing tool.
Shortcut
--------
@@ -14,7 +14,7 @@ Toolbar Icon
------------
.. figure:: images/toolbar_explore-tool.png
:alt: Explore tool icon in the BlenderBIM toolbar
:alt: Explore tool icon in the Bonsai toolbar
Tool Options
------------
@@ -47,6 +47,6 @@ Usage
* For Walk Mode, use WASD or arrow keys to move through the model.
* For Clipping Plane, drag the plane to desired position and use Shift+F to flip if needed.
The Explore Tool significantly enhances the model navigation and inspection capabilities of BlenderBIM.
The Explore Tool significantly enhances the model navigation and inspection capabilities of Bonsai.
It's particularly useful for understanding spatial relationships, inspecting building cross-sections, and navigating through complex interiors.
These features make BlenderBIM more comparable to dedicated IFC viewers while retaining its powerful authoring capabilities.
These features make Bonsai more comparable to dedicated IFC viewers while retaining its powerful authoring capabilities.
src/bonsai/docs/users/user_interface/toolbar/index.rst
+5 -5
View File
@@ -5,7 +5,7 @@ Toolbar
Tool System Overview
====================
BlenderBIM extends Blender's tool system, which provides a consistent way to interact with the 3D viewport. Here are some key points about the tool system:
Bonsai extends Blender's tool system, which provides a consistent way to interact with the 3D viewport. Here are some key points about the tool system:
- Tools are accessed from the Toolbar, typically located on the left side of the 3D viewport.
- Only one tool can be active per Workspace and mode.
@@ -13,7 +13,7 @@ BlenderBIM extends Blender's tool system, which provides a consistent way to int
- Press :kbd:`Shift` + :kbd:`Spacebar` to open the tool shortcut menu for quick access.
- The Quick Favorites menu (:kbd:`Q`) allows you to gather your most-used tools for easy access.
BlenderBIM integrates its tools seamlessly into this system, adding BIM-specific functionality while maintaining consistency with Blender's interface.
Bonsai integrates its tools seamlessly into this system, adding BIM-specific functionality while maintaining consistency with Blender's interface.
Tool Settings Access
--------------------
@@ -44,10 +44,10 @@ providing context-specific controls and parameters.
refer to the `Blender Manual <https://docs.blender.org/manual/en/latest/interface/tool_system.html>`_.
BlenderBIM Tools
================
Bonsai Tools
============
The BlenderBIM toolbar extends Blender's built-in toolbar with additional tools specific to BIM modeling.
The Bonsai toolbar extends Blender's built-in toolbar with additional tools specific to BIM modeling.
These tools are positioned between the Transform and Annotate sections of the standard Blender toolbar.
.. tip::
src/bonsai/docs/users/user_interface/toolbar/wall.rst
+3 -3
View File
@@ -1,14 +1,14 @@
Create Wall
===========
The Create Wall tool in BlenderBIM allows you to add and manipulate wall elements in your floor plan.
The Create Wall tool in Bonsai allows you to add and manipulate wall elements in your floor plan.
It provides options for specifying wall element properties and adjusting their alignment and orientation.
Toolbar Icon
------------
.. figure:: images/toolbar_create-wall.png
:alt: Create Wall tool icon in the BlenderBIM toolbar
:alt: Create Wall tool icon in the Bonsai toolbar
Tool Options
------------
@@ -98,5 +98,5 @@ To use the Create Wall tool:
13. **Add voids** by clicking "Add Void" and placing openings where necessary.
14. **Calculate quantities** by pressing :kbd:`Q` to ensure accurate measurements.
The Create Wall tool in BlenderBIM enables precise and flexible wall creation and management,
The Create Wall tool in Bonsai enables precise and flexible wall creation and management,
enhancing your ability to develop detailed floor plans efficiently.
src/bonsai/docs/users/user_interface/topbar.rst
+1 -1
View File
@@ -41,4 +41,4 @@ or a more customizable approach through the Project Wizard.
BIM Workspace
-------------
BlenderBIM adds the **BIM** Workspace to the Topbar Workspaces tabs.
Bonsai adds the **BIM** Workspace to the Topbar Workspaces tabs.
src/bonsai/docs/users/user_interface/workspace.rst
+6 -6
View File
@@ -4,23 +4,23 @@ BIM Workspace
For general informations about the Blender Workspaces see the respective
`Workspaces <https://docs.blender.org/manual/en/latest/interface/window_system/workspaces.html>`__ section in Blender documentation.
After installation of BlenderBIM the default Blender start-up screen looks different from the standard Blender interface.
After installation of Bonsai the default Blender start-up screen looks different from the standard Blender interface.
BlenderBIM adds the **BIM** Workspace to the interface and by default activates this workspace on start-up.
Bonsai adds the **BIM** Workspace to the interface and by default activates this workspace on start-up.
It also modifies the layout of views and sidebars and adds custom functionality to the toolbar.
The left **Outliner** panel shows a tree of geometric objects. The centre main **Viewport** panel shows 3D geometry.
The right **Properties** panel shows data and relationships.
.. figure:: images/interface_window_start-up.png
:alt: Blender start-up window with installed BlenderBIM add-on
:alt: Blender start-up window with installed Bonsai
Blender start-up window with installed BlenderBIM add-on.
Blender start-up window with installed Bonsai.
1. **BIM** Workspace tab
2. Outliner with the document tree
3. Main 3D viewport
4. Property editor
5. Toolbar with added BIM functionality
6. Sidebar with BlenderBIM & 4D/5D Toolkit panels
7. Status bar with information about the currently used Blender and BlenderBIM version
6. Sidebar with Bonsai & 4D/5D Toolkit panels
7. Status bar with information about the currently used Blender and Bonsai version