See #4919. Include pip install instructions for utils in docs.

This commit is contained in:
Dion Moult
2024-06-26 09:16:15 +10:00
parent 39cd980008
commit ae91c2b9f0
5 changed files with 67 additions and 32 deletions
+7
View File
@@ -29,6 +29,13 @@ The upstream documentation by buildingSMART for BCF is available here:
The IfcOpenShell **BCF** library supports BCF-XML version 2.1 and 3.0, and
BCF-API 3.0.
PyPI
----
.. code-block::
pip install bcf-client
BCF-XML
-------
+7
View File
@@ -30,6 +30,13 @@ More reading:
1. `Swagger API docs <https://bs-dd-api-prototype.azurewebsites.net/swagger/index.html>`_
2. `bSDD Github Repository <https://github.com/buildingSMART/bSDD>`_
PyPI
----
.. code-block::
pip install bsdd
Examples
--------
+8 -2
View File
@@ -5,11 +5,17 @@ IfcClash is both a CLI utility and library that lets you perform clash detection
on one or more IFC models. Clashes are defined in terms of clash sets with
filters using the IFC query syntax.
PyPI
----
.. code-block::
pip install ifcclash
Source installation
-------------------
1. :doc:`Install IfcOpenShell <ifcopenshell-python/installation>`
2. `Install hppfcl <https://github.com/humanoid-path-planner/hpp-fcl>`_
3. Optionally `install bcf <https://github.com/IfcOpenShell/IfcOpenShell/tree/v0.7.0/src/bcf>`_ (needed for BCF reports of results)
4. `Clone the source code <https://github.com/IfcOpenShell/IfcOpenShell/tree/v0.7.0/src/ifcclash>`_.
5. ``cd /path/to/IfcOpenShell/src/ifcclash``
@@ -67,7 +73,7 @@ defined with data sources.
"b": [
{
"file": "/path/to/two.ifc",
"selector": ".IfcWall",
"selector": "IfcWall",
"mode": "i"
}
]
+38 -30
View File
@@ -43,10 +43,46 @@ you make in the spreadsheet or table will also be made in the IFC.
There are different methods of installation, depending on your situation.
1. **Source installation** is recommended for developers wanting to use the
latest code as a library or a CLI utility.
1. **PyPI** is recommended for developers using Pip.
2. **Using the BlenderBIM Add-on** is recommended for non-developers wanting a
graphical interface.
3. **Source installation** is recommended for developers wanting to use the
latest code as a library or a CLI utility.
PyPI
----
.. code-block::
pip install ifccsv
Using the BlenderBIM Add-on
---------------------------
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.
1. Install the BlenderBIM Add-on by following the `BlenderBIM Add-on
installation documentation
<https://docs.blenderbim.org/users/installation.html>`_.
2. Launch Blender. Change to the **Scene Properties** tab in the **Properties
Panel**. Scroll down to the **IFC Collaboration > IFC CSV Import / Export**
panel.
3. Browse to your IFC file.
4. Type in a filter query, such as ``IfcDoor``.
5. Optionally add attributes you'd like to export.
6. Press **Export IFC to CSV**
TODO: add pictures and make this clearer for non-developers.
Source installation
-------------------
@@ -140,31 +176,3 @@ Here is a minimal example of how to use IfcCSV as a library:
# You can also import changes from a CSV
ifc_csv.Import(model, "input.csv")
model.write("/path/to/updated_model.ifc")
Using the BlenderBIM Add-on
---------------------------
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.
1. Install the BlenderBIM Add-on by following the `BlenderBIM Add-on
installation documentation
<https://docs.blenderbim.org/users/installation.html>`_.
2. Launch Blender. Change to the **Scene Properties** tab in the **Properties
Panel**. Scroll down to the **IFC Collaboration > IFC CSV Import / Export**
panel.
3. Browse to your IFC file.
4. Type in a filter query, such as ``IfcDoor``.
5. Optionally add attributes you'd like to export.
6. Press **Export IFC to CSV**
TODO: add pictures and make this clearer for non-developers.
@@ -4,3 +4,10 @@ IfcTester
IfcTester lets you author and read Information Delivery Specification (IDS)
files. You can validate IFC models against IDS and generate reports in multiple
formats. It works from the command line, as a web app, or as a library.
PyPI
----
.. code-block::
pip install ifctester