From ae91c2b9f04ca4e934b83baff4295eeff9b3c8eb Mon Sep 17 00:00:00 2001 From: Dion Moult Date: Wed, 26 Jun 2024 09:16:15 +1000 Subject: [PATCH] See #4919. Include pip install instructions for utils in docs. --- src/ifcopenshell-python/docs/bcf.rst | 7 +++ src/ifcopenshell-python/docs/bsdd.rst | 7 +++ src/ifcopenshell-python/docs/ifcclash.rst | 10 +++- src/ifcopenshell-python/docs/ifccsv.rst | 68 ++++++++++++---------- src/ifcopenshell-python/docs/ifctester.rst | 7 +++ 5 files changed, 67 insertions(+), 32 deletions(-) diff --git a/src/ifcopenshell-python/docs/bcf.rst b/src/ifcopenshell-python/docs/bcf.rst index 6e09d19de6..fe33bcb2e5 100644 --- a/src/ifcopenshell-python/docs/bcf.rst +++ b/src/ifcopenshell-python/docs/bcf.rst @@ -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 ------- diff --git a/src/ifcopenshell-python/docs/bsdd.rst b/src/ifcopenshell-python/docs/bsdd.rst index d8f53b4f0f..a196a4d843 100644 --- a/src/ifcopenshell-python/docs/bsdd.rst +++ b/src/ifcopenshell-python/docs/bsdd.rst @@ -30,6 +30,13 @@ More reading: 1. `Swagger API docs `_ 2. `bSDD Github Repository `_ +PyPI +---- + +.. code-block:: + + pip install bsdd + Examples -------- diff --git a/src/ifcopenshell-python/docs/ifcclash.rst b/src/ifcopenshell-python/docs/ifcclash.rst index 5a6ee7c4d4..e3284519a0 100644 --- a/src/ifcopenshell-python/docs/ifcclash.rst +++ b/src/ifcopenshell-python/docs/ifcclash.rst @@ -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 ` -2. `Install hppfcl `_ 3. Optionally `install bcf `_ (needed for BCF reports of results) 4. `Clone the source code `_. 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" } ] diff --git a/src/ifcopenshell-python/docs/ifccsv.rst b/src/ifcopenshell-python/docs/ifccsv.rst index 5a53be8705..a566d8430a 100644 --- a/src/ifcopenshell-python/docs/ifccsv.rst +++ b/src/ifcopenshell-python/docs/ifccsv.rst @@ -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 + `_. + +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 - `_. - -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. diff --git a/src/ifcopenshell-python/docs/ifctester.rst b/src/ifcopenshell-python/docs/ifctester.rst index d384e3216d..0682bff803 100644 --- a/src/ifcopenshell-python/docs/ifctester.rst +++ b/src/ifcopenshell-python/docs/ifctester.rst @@ -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