Glassvision/IfcOpenShell
1
0
Fork 0
mirror of https://github.com/IfcOpenShell/IfcOpenShell.git synced 2026-08-10 01:41:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Distribute IfcDiff on PyPI

Browse Source
This commit is contained in:
Dion Moult
2024-06-26 11:44:19 +10:00
parent e670a7ca71
commit 4976074b18
5 changed files with 142 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ifcopenshell-python/docs/ifcdiff.rst
+37 -29
View File
@@ -18,10 +18,45 @@ Changes will be sorted into three lists:
There are different methods of installation, depending on your situation.
1. **Source installation** is recommended for users 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 users wanting to use the latest
code as a library or a CLI utility.
PyPI
----
.. code-block::
pip install ifcdiff
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 Quality Control > IFC Diff** panel.
3. Browse to your old IFC file, new IFC file.
4. Optionally add any relationships you want to check.
5. Optionally type in a filter query.
6. Press **Execute IFC Diff**
TODO: add pictures and make this clearer for non-developers.
Source installation
-------------------
@@ -76,33 +111,6 @@ You can also alias it to a command:
alias ifcdiff='python -m ifcdiff'
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 Quality Control > IFC Diff** panel.
3. Browse to your old IFC file, new IFC file.
4. Optionally add any relationships you want to check.
5. Optionally type in a filter query.
6. Press **Execute IFC Diff**
TODO: add pictures and make this clearer for non-developers.
Geometry changes
----------------