2024-08-22 21:02:19 +10:00
|
|
|
Learn Bonsai
|
|
|
|
|
============
|
2022-05-04 16:04:18 +10:00
|
|
|
|
2024-08-22 21:02:19 +10:00
|
|
|
Welcome to the manual for `Bonsai <https://bonsaibim.org>`__, the free and open
|
|
|
|
|
source BIM add-on for Blender.
|
2023-04-03 12:35:10 +10:00
|
|
|
|
2024-06-21 10:54:05 +03:00
|
|
|
.. only:: builder_html and (not singlehtml)
|
2023-04-03 12:35:10 +10:00
|
|
|
|
2024-06-21 10:54:05 +03:00
|
|
|
.. container:: toc-cards
|
2023-04-03 12:35:10 +10:00
|
|
|
|
2024-06-21 10:54:05 +03:00
|
|
|
.. container:: card
|
2023-04-03 12:35:10 +10:00
|
|
|
|
2024-06-21 10:54:05 +03:00
|
|
|
:doc:`/users/quickstart/introduction_to_bim` (2-minute read)
|
2024-08-22 21:02:19 +10:00
|
|
|
Brief overview of BIM concepts and Bonsai's role.
|
2023-04-03 12:35:10 +10:00
|
|
|
|
2024-06-21 10:54:05 +03:00
|
|
|
.. container:: card
|
2022-05-04 16:04:18 +10:00
|
|
|
|
2024-06-21 10:54:05 +03:00
|
|
|
:doc:`/users/quickstart/installation` (5 to 10-minute process)
|
|
|
|
|
Installation guide and system requirements.
|
2020-01-08 10:58:52 +11:00
|
|
|
|
2024-06-21 10:54:05 +03:00
|
|
|
.. container:: card
|
|
|
|
|
|
|
|
|
|
:doc:`/users/quickstart/explore_model` (15-minute guide)
|
|
|
|
|
Load and navigate an IFC model.
|
|
|
|
|
|
|
|
|
|
.. container:: card
|
|
|
|
|
|
|
|
|
|
:doc:`/users/quickstart/create_model` (20-minute guide)
|
|
|
|
|
Create a simple BIM project.
|
|
|
|
|
|
|
|
|
|
.. container:: global-index-toc
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:hidden:
|
|
|
|
|
:caption: Quickstart
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
|
|
users/quickstart/introduction_to_bim
|
|
|
|
|
users/quickstart/installation
|
|
|
|
|
users/quickstart/explore_model
|
|
|
|
|
users/quickstart/create_model
|
|
|
|
|
users/quickstart/next_steps
|
|
|
|
|
|
|
|
|
|
Sections
|
|
|
|
|
========
|
|
|
|
|
|
|
|
|
|
.. only:: builder_html and (not singlehtml)
|
|
|
|
|
|
|
|
|
|
.. container:: toc-cards
|
|
|
|
|
|
|
|
|
|
.. container:: card
|
|
|
|
|
|
|
|
|
|
:doc:`/users/modeling/interface`
|
2024-08-22 21:02:19 +10:00
|
|
|
Guide to the Bonsai interface.
|
2024-06-21 10:54:05 +03:00
|
|
|
|
|
|
|
|
.. container:: card
|
|
|
|
|
|
|
|
|
|
:doc:`/users/modeling/ifc_modeling`
|
|
|
|
|
IFC modeling techniques and concepts.
|
|
|
|
|
|
2024-07-22 12:13:37 +10:00
|
|
|
.. container:: card
|
|
|
|
|
|
|
|
|
|
:doc:`/users/git_support`
|
|
|
|
|
Collaborate on projects using Git
|
|
|
|
|
|
2024-06-21 10:54:05 +03:00
|
|
|
.. container:: card
|
|
|
|
|
|
|
|
|
|
:doc:`/users/drawing/index`
|
|
|
|
|
2D drawing generation and annotation.
|
|
|
|
|
|
2024-06-26 04:31:29 +03:00
|
|
|
.. container:: card
|
|
|
|
|
|
|
|
|
|
:doc:`/users/structural_analysis/index`
|
2024-08-22 21:02:19 +10:00
|
|
|
Structural analysis capabilities.
|
2024-06-26 04:31:29 +03:00
|
|
|
|
|
|
|
|
.. container:: card
|
|
|
|
|
|
|
|
|
|
:doc:`/users/costing_and_scheduling/index`
|
|
|
|
|
Cost estimation and project scheduling features.
|
|
|
|
|
|
2024-06-21 10:54:05 +03:00
|
|
|
.. container:: card
|
|
|
|
|
|
|
|
|
|
:doc:`/users/advanced/index`
|
|
|
|
|
Advanced topics and large-scale modeling.
|
|
|
|
|
|
|
|
|
|
.. container:: card
|
|
|
|
|
|
|
|
|
|
:doc:`/users/tutorials/index`
|
|
|
|
|
Real-world BIM project tutorials.
|
|
|
|
|
|
|
|
|
|
.. container:: card
|
|
|
|
|
|
|
|
|
|
:doc:`/users/user_interface`
|
|
|
|
|
Detailed UI reference.
|
|
|
|
|
|
|
|
|
|
.. container:: card
|
|
|
|
|
|
2024-07-22 12:13:37 +10:00
|
|
|
:doc:`/users/other_addons`
|
|
|
|
|
Other complementary add-ons
|
|
|
|
|
|
|
|
|
|
.. container:: card
|
|
|
|
|
|
|
|
|
|
:doc:`/users/troubleshooting`
|
|
|
|
|
Troubleshooting when things go wrong
|
2024-06-21 10:54:05 +03:00
|
|
|
|
|
|
|
|
.. container:: global-index-toc
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:hidden:
|
|
|
|
|
:caption: Sections
|
|
|
|
|
:maxdepth: 2
|
|
|
|
|
|
|
|
|
|
users/modeling/interface
|
|
|
|
|
users/modeling/ifc_modeling
|
2024-07-22 12:13:37 +10:00
|
|
|
users/git_support
|
2024-06-21 10:54:05 +03:00
|
|
|
users/drawing/index
|
2024-06-26 04:31:29 +03:00
|
|
|
users/structural_analysis/index
|
|
|
|
|
users/costing_and_scheduling/index
|
2024-06-21 10:54:05 +03:00
|
|
|
users/advanced/index
|
|
|
|
|
users/tutorials/index
|
|
|
|
|
users/user_interface
|
2024-07-22 12:13:37 +10:00
|
|
|
users/other_addons
|
|
|
|
|
users/troubleshooting
|
2024-06-21 10:54:05 +03:00
|
|
|
|
|
|
|
|
Get Involved
|
|
|
|
|
============
|
|
|
|
|
|
|
|
|
|
This manual is maintained largely by volunteers.
|
|
|
|
|
|
|
|
|
|
Please consider joining the effort and :doc:`/contribute/writing_docs`.
|
|
|
|
|
|
|
|
|
|
You can also can help with :doc:`Translations and Internationalisation </contribute/translations>`
|
|
|
|
|
|
2024-08-22 21:02:19 +10:00
|
|
|
For users who want to contribute to the Bonsai codebase,
|
2024-06-21 10:54:05 +03:00
|
|
|
please refer to the :doc:`Documentation for Developers </devs/getting_started>`.
|
2024-08-22 21:02:19 +10:00
|
|
|
This part of the documentation covers various aspects of the Bonsai development process.
|
2024-06-21 10:54:05 +03:00
|
|
|
|
|
|
|
|
You can get in touch by `joining the chat <https://osarch.org/chat/>`__.
|
2020-01-08 10:58:52 +11:00
|
|
|
|
2022-05-04 13:06:39 +10:00
|
|
|
.. toctree::
|
|
|
|
|
:hidden:
|
2024-06-21 10:54:05 +03:00
|
|
|
:caption: Get Involved
|
2022-05-04 13:06:39 +10:00
|
|
|
:maxdepth: 1
|
2024-06-21 10:54:05 +03:00
|
|
|
|
|
|
|
|
contribute/writing_docs
|
|
|
|
|
contribute/translations
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Developer Documentation
|
|
|
|
|
=======================
|
|
|
|
|
|
2024-08-22 21:02:19 +10:00
|
|
|
Bonsai is an open-source project, and its development is driven by the contributions of a dedicated community of developers,
|
2024-06-21 10:54:05 +03:00
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. only:: builder_html and (not singlehtml)
|
|
|
|
|
|
|
|
|
|
.. container:: toc-cards
|
|
|
|
|
|
|
|
|
|
.. container:: card
|
|
|
|
|
|
|
|
|
|
:doc:`/devs/getting_started`
|
2024-08-22 21:02:19 +10:00
|
|
|
Introduction to contributing to Bonsai.
|
2024-06-21 10:54:05 +03:00
|
|
|
|
|
|
|
|
.. container:: card
|
|
|
|
|
|
|
|
|
|
:doc:`/devs/installation`
|
|
|
|
|
Setting up a development environment.
|
|
|
|
|
|
|
|
|
|
.. container:: card
|
|
|
|
|
|
|
|
|
|
:doc:`/devs/hello_world`
|
|
|
|
|
Understanding the project structure.
|
|
|
|
|
|
|
|
|
|
.. container:: card
|
|
|
|
|
|
|
|
|
|
:doc:`/devs/undo_system`
|
2024-08-22 21:02:19 +10:00
|
|
|
Working with Bonsai's undo system.
|
2024-06-21 10:54:05 +03:00
|
|
|
|
|
|
|
|
.. container:: card
|
|
|
|
|
|
|
|
|
|
:doc:`/devs/code_style`
|
|
|
|
|
Code style guidelines and best practices.
|
|
|
|
|
|
|
|
|
|
.. container:: card
|
|
|
|
|
|
|
|
|
|
:doc:`/devs/running_tests`
|
|
|
|
|
Testing and quality assurance.
|
|
|
|
|
|
|
|
|
|
.. container:: card
|
|
|
|
|
|
|
|
|
|
:doc:`/devs/ux_guidelines`
|
|
|
|
|
User experience and interface guidelines.
|
|
|
|
|
|
|
|
|
|
.. container:: global-index-toc
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:hidden:
|
|
|
|
|
:caption: Developer Documentation
|
|
|
|
|
:maxdepth: 1
|
|
|
|
|
|
|
|
|
|
devs/getting_started
|
|
|
|
|
devs/installation
|
|
|
|
|
devs/hello_world
|
|
|
|
|
devs/undo_system
|
|
|
|
|
devs/code_style
|
|
|
|
|
devs/running_tests
|
|
|
|
|
devs/ux_guidelines
|
