mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-10 09:48:32 +00:00
Update Bonsai viewer licensing docs
Update Bonsai viewer headers to identify Bonsai and GPL licensing, add Bonsai Viewer documentation, and document debug output capture. Generated with the assistance of an AI coding tool.
This commit is contained in:
@@ -0,0 +1,10 @@
|
||||
.. This file was generated with the assistance of an AI coding tool.
|
||||
|
||||
Bonsai Viewer
|
||||
=============
|
||||
|
||||
Bonsai Viewer is a high performance viewing and coordination tool for IFC
|
||||
models. It is designed for quickly opening large projects, inspecting model
|
||||
geometry and metadata, and coordinating issues across federated project data.
|
||||
|
||||
For more information, visit the `Bonsai website <https://bonsaibim.org>`_.
|
||||
@@ -13,6 +13,7 @@ Let's learn IfcOpenShell!
|
||||
ifcopenshell-python
|
||||
ifcconvert
|
||||
bonsai
|
||||
bonsai-viewer
|
||||
|
||||
.. 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), **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.
|
||||
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 viewer), 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
|
||||
-----------------
|
||||
@@ -58,6 +58,9 @@ IfcOpenShell is a modular ecosystem of tools that work together, where each tool
|
||||
"`IfcOpenShell-Python <https://docs.ifcopenshell.org/ifcopenshell-python.html>`_", "Python bindings to the core IfcOpenShell C++ system, as well as high level analysis and authoring functions."
|
||||
"`IfcConvert <https://docs.ifcopenshell.org/ifcconvert.html>`_", "A command-line application for converting IFC geometry into file formats such as OBJ, DAE, GLB, STP, IGS, XML, SVG, H5, and IFC itself."
|
||||
"`Bonsai <https://docs.ifcopenshell.org/bonsai.html>`_", "A graphical add-on for Blender that lets you analyse, author, and modify IFC with Blender. Graphically create BIM models from scratch!"
|
||||
"`Bonsai Viewer <https://docs.ifcopenshell.org/bonsai-viewer.html>`_", "A high performance viewing and coordination tool for opening and inspecting IFC models."
|
||||
"`IfcViewer <https://docs.ifcopenshell.org/ifcviewer.html>`_", "A WebGPU-based desktop IFC viewer and shared viewer core used by the standalone viewer targets."
|
||||
"IfcViewerWeb", "A WebAssembly and WebGPU viewer target for viewing IFC models in a web browser."
|
||||
"`BCF <https://docs.ifcopenshell.org/bcf.html>`_", "BIM Collaboration Format (BCF) is a standard to manage and exchange coordination topics between disciplines collaborating on a project by changing XML files or querying an API."
|
||||
"`BIMServer-Plugin <https://docs.ifcopenshell.org/bimserver-plugin.html>`_", "A plugin to the open source BIMServer CDE to allow you to use IfcOpenShell to parse, view, and audit models."
|
||||
"`BIMTester <https://docs.ifcopenshell.org/bimtester.html>`_", "A utility that allows you to write Gherkin-based tests for models."
|
||||
@@ -81,7 +84,9 @@ 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 **Bonsai** and **IfcSverchok**, which are both licensed under GPL-3.0-or-later.
|
||||
**IfcOpenShell** and its libraries and viewer targets are licensed under
|
||||
LGPL-3.0-or-later. Exceptions include **Bonsai**, **Bonsai Viewer**, and
|
||||
**IfcSverchok**, which are licensed under GPL-3.0-or-later.
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
Reference in New Issue
Block a user