mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-10 17:58:20 +00:00
Rebrand to Bonsai in IOS-Python docs
This commit is contained in:
@@ -1,6 +0,0 @@
|
||||
Bonsai Add-on
|
||||
=================
|
||||
|
||||
Bonsai Add-on for Blender lets you analyse, create, and modify OpenBIM with
|
||||
Blender. For more information, visit the `Bonsai website
|
||||
<https://bonsaibim.org>`_.
|
||||
@@ -0,0 +1,5 @@
|
||||
Bonsai
|
||||
======
|
||||
|
||||
Bonsai lets you analyse, create, and modify OpenBIM with Blender. For more
|
||||
information, visit the `Bonsai website <https://bonsaibim.org>`_.
|
||||
@@ -19,8 +19,8 @@ Changes will be sorted into three lists:
|
||||
There are different methods of installation, depending on your situation.
|
||||
|
||||
1. **PyPI** is recommended for developers using Pip.
|
||||
2. **Using the BlenderBIM Add-on** is recommended for non-developers wanting a
|
||||
graphical interface.
|
||||
2. **Using Bonsai** is recommended for non-developers wanting a graphical
|
||||
interface.
|
||||
3. **Source installation** is recommended for users wanting to use the latest
|
||||
code as a library or a CLI utility.
|
||||
|
||||
@@ -31,19 +31,19 @@ PyPI
|
||||
|
||||
pip install ifcdiff
|
||||
|
||||
Using the BlenderBIM Add-on
|
||||
---------------------------
|
||||
Using Bonsai
|
||||
------------
|
||||
|
||||
The BlenderBIM Add-on is a Blender based graphical interface to IfcOpenShell.
|
||||
Other than providing a graphical IFC authoring platform, it also comes with
|
||||
IfcOpenShell, its utilities, and a Python shell built-in. This means you don't
|
||||
need to install Python first, and you also can compare your IfcOpenShell
|
||||
scripting to what you see with a visual model viewer, or use a graphical
|
||||
interface to access the IfcOpenShell utilities.
|
||||
Bonsai is a Blender based graphical interface to IfcOpenShell. Other than
|
||||
providing a graphical IFC authoring platform, it also comes with IfcOpenShell,
|
||||
its utilities, and a Python shell built-in. This means you don't need to
|
||||
install Python first, and you also can compare your IfcOpenShell scripting to
|
||||
what you see with a visual model viewer, or use a graphical interface to access
|
||||
the IfcOpenShell utilities.
|
||||
|
||||
1. Install the BlenderBIM Add-on by following the `BlenderBIM Add-on
|
||||
1. Install Bonsai by following the `Bonsai
|
||||
installation documentation
|
||||
<https://docs.bonsaibim.org/users/installation.html>`_.
|
||||
<https://docs.bonsaibim.org/quickstart/installation.html>`_.
|
||||
|
||||
2. Launch Blender. Change to the **Scene Properties** tab in the **Properties
|
||||
Panel**. Scroll down to the **IFC Quality Control > IFC Diff** panel.
|
||||
|
||||
@@ -17,4 +17,4 @@ It is recommended to use the latest version of IfcOpenShell and 3ds Max.
|
||||
|
||||
This plugin is purely an importer and does not handle native IFC authoring
|
||||
or exporting. For more information for native IFC authoring, we recommend
|
||||
using the :doc:`BlenderBIM Add-on<blenderbim>`.
|
||||
using :doc:`Bonsai<bonsai>`.
|
||||
|
||||
@@ -15,8 +15,8 @@ take length values defined in feet, and apply imperial formatting such that it
|
||||
shows both feet and inches including fractions.
|
||||
|
||||
These three usecases of filtering, getting a value, and formatting that value
|
||||
are common and used in many utilities, such as in the BlenderBIM Add-on,
|
||||
IfcCSV, IfcDiff, IfcClash, IfcPatch, and IfcFM.
|
||||
are common and used in many utilities, such as in Bonsai, IfcCSV, IfcDiff,
|
||||
IfcClash, IfcPatch, and IfcFM.
|
||||
|
||||
IfcOpenShell provides a custom syntax to consistently and concisely describe
|
||||
filters, value queries, and formatting rules.
|
||||
|
||||
@@ -28,7 +28,7 @@ IfcOpenShell depends on:
|
||||
for IfcConvert to be able to write tessellated Collada (.dae) files
|
||||
- (Optional) `SWIG <http://www.swig.org/>`__ and `Python
|
||||
<https://www.python.org/>`__ - for building the IfcOpenShell Python interface
|
||||
and use in the BlenderBIM Add-on
|
||||
and use in Bonsai
|
||||
- (Optional) `HDF5 <https://www.hdfgroup.org/solutions/hdf5>`__ - for caching
|
||||
geometry using the HDF5 format
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ Like all Blender add-ons, they can be installed using ``Edit > Preferences >
|
||||
Addons > Install > Choose Downloaded ZIP > Enable Add-on Checkbox``. You can
|
||||
enable add-ons permanently by using ``Save User Settings`` from the Addons menu.
|
||||
|
||||
Before installing, you will also need to `install the BlenderBIM Add-on
|
||||
Before installing, you will also need to `install Bonsai
|
||||
<https://bonsaibim.org/download.html>`__ and `install Sverchok
|
||||
<https://github.com/nortikin/sverchok#installation>`__.
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ Let's learn IfcOpenShell!
|
||||
ifcopenshell
|
||||
ifcopenshell-python
|
||||
ifcconvert
|
||||
blenderbim
|
||||
bonsai
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
@@ -3,7 +3,7 @@ Introduction
|
||||
|
||||
**IfcOpenShell** is an open source software library for software developers and BIM powerusers working with Industry Foundation Classes (`IFC <https://technical.buildingsmart.org/standards/ifc/>`_).
|
||||
|
||||
In addition to a C++ and Python API, **IfcOpenShell** comes with an ecosystem of tools, notably including **IfcConvert** (an application to convert IFC models to other formats), the **BlenderBIM Add-on** (an add-on to Blender providing a graphical IFC authoring platform), and many other libraries, CLI apps, and more. Support is also provided for auxiliary standards such as BCF, bSDD, and IDS.
|
||||
In addition to a C++ and Python API, **IfcOpenShell** comes with an ecosystem of tools, notably including **IfcConvert** (an application to convert IFC models to other formats), **Bonsai** (an add-on to Blender providing a graphical IFC authoring platform), and many other libraries, CLI apps, and more. Support is also provided for auxiliary standards such as BCF, bSDD, and IDS.
|
||||
|
||||
Things you can do
|
||||
-----------------
|
||||
@@ -78,7 +78,7 @@ IfcOpenShell is a modular ecosystem of tools that work together, where each tool
|
||||
|
||||
.. note::
|
||||
|
||||
**IfcOpenShell** and all of its libraries are licensed under LGPL-3.0-or-later. Two exceptions to this are the **BlenderBIM Add-on** and **IfcSverchok**, which are both licensed under GPL-3.0-or-later.
|
||||
**IfcOpenShell** and all of its libraries are licensed under LGPL-3.0-or-later. Two exceptions to this are **Bonsai** and **IfcSverchok**, which are both licensed under GPL-3.0-or-later.
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
Reference in New Issue
Block a user