Fix #3264. Describe IFC to JSON conversion (and other formats) in documentation.

This commit is contained in:
Dion Moult
2023-06-07 14:30:37 +10:00
parent 482f97961d
commit 02462c1209
9 changed files with 134 additions and 6 deletions
+5
View File
@@ -0,0 +1,5 @@
Ifc2CA
======
Ifc2CA converts IFC models to FEM structural analytical models to be used in
Code_Aster.
+4
View File
@@ -0,0 +1,4 @@
Ifc4D
=====
Ifc4D contains a series of utilities for converting to and from various 4D software.
+5
View File
@@ -0,0 +1,5 @@
Ifc5D
=====
Ifc5D is a collection of utilities of manipulating cost-related data to and
from formats, reports, and optimisation engines.
@@ -0,0 +1,5 @@
IfcCityJSON
===========
IfcCityJSON is a converter for CityJSON files and IFC. It currently only
supports one-way conversion from CityJSON to IFC.
+62 -2
View File
@@ -1,8 +1,68 @@
IfcConvert IfcConvert
========== ==========
IfcConvert is a command-line application for converting IFC geometry into IfcConvert is a command-line application for converting IFC geometry into file
file formats such as OBJ, DAE, GLB, STP, IGS, XML, and SVG. formats such as OBJ, DAE, GLB, STP, IGS, XML, SVG, H5, and IFC itself.
For other conversions, other software is available as other utilities within
IfcOpenShell.
+-------------------------+-------------------------+----------------------+
| From Format | To Format | Tool |
+=========================+=========================+======================+
| .ifc | .obj, .dae, .glb, .stp, | IfcConvert |
| | .igs, .xml, .svg, .h5, | |
| | .ifc | |
+-------------------------+-------------------------+----------------------+
| .ifc | .dae, .abc, .usd, .obj, | `BlenderBIM Add-on`_ |
| | .ply, .stl, .fbx, .glb, | |
| | .gltf, .x3d, .dxf | |
+-------------------------+-------------------------+----------------------+
| .ifc | .ifcZIP, .ifcXML, .ifc | IfcOpenShell-Python_ |
+-------------------------+-------------------------+----------------------+
| .ifc | .ifcJSON | Ifc2JSON_ |
+-------------------------+-------------------------+----------------------+
| .ifc | .ifc | IfcPatch_ |
| | (IFC2X3, IFC4, IFC4X3) | |
+-------------------------+-------------------------+----------------------+
| .ifc | .json (Code_Aster), | Ifc2CA_ |
| | .comm (Code_Aster) | |
+-------------------------+-------------------------+----------------------+
| .ifc | .xml (Oracle P6), | Ifc4D_ |
| | .xml (MS Project) | |
+-------------------------+-------------------------+----------------------+
| .ifc | .csv, .ods, .xlsx | Ifc5D_ |
+-------------------------+-------------------------+----------------------+
| .ifc | .csv, .ods, .xlsx | IfcCSV_ |
+-------------------------+-------------------------+----------------------+
| .csv | .ifc | Ifc5D_ |
+-------------------------+-------------------------+----------------------+
| .csv | .ifc | IfcCSV_ |
+-------------------------+-------------------------+----------------------+
| .dxf | .ifc | `BlenderBIM Add-on`_ |
+-------------------------+-------------------------+----------------------+
| .obj | .ifc | `BlenderBIM Add-on`_ |
+-------------------------+-------------------------+----------------------+
| .json (CityJSON) | .ifc | IfcCityJSON_ |
+-------------------------+-------------------------+----------------------+
| .xer (Oracle P6) | .ifc | Ifc4D_ |
+-------------------------+-------------------------+----------------------+
| .xml (Oracle P6) | .ifc | Ifc4D_ |
+-------------------------+-------------------------+----------------------+
| .xml (MS Project) | .ifc | Ifc4D_ |
+-------------------------+-------------------------+----------------------+
| .xml (Powerproject) | .ifc | Ifc4D_ |
+-------------------------+-------------------------+----------------------+
.. _IfcOpenShell-Python: ifcopenshell-python.html
.. _IfcPatch: ifcpatch.html
.. _Ifc2CA: ifc2ca.html
.. _IfcCSV: ifccsv.html
.. _Ifc4D: ifc4d.html
.. _Ifc5D: ifc5d.html
.. _IfcCityJSON: ifccityjson.html
.. _Ifc2JSON: other.html
.. _BlenderBIM Add-on: https://blenderbim.org
.. toctree:: .. toctree::
:hidden: :hidden:
+5
View File
@@ -0,0 +1,5 @@
IfcCSV
======
IfcCSV exports and imports data from spreadsheet or tabular datasets. This lets
you view and edit IFC data using CSV, ODS, XLSX, and more.
@@ -0,0 +1,6 @@
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.
+24 -4
View File
@@ -10,18 +10,38 @@ IfcOpenShell is a suite of developer libraries and utilities to manipulate OpenB
.. toctree:: .. toctree::
:hidden: :hidden:
:maxdepth: 1 :maxdepth: 1
:caption: Contents: :caption: Main:
ifcopenshell ifcopenshell
ifcopenshell-python ifcopenshell-python
ifcconvert ifcconvert
blenderbim
.. toctree::
:hidden:
:maxdepth: 1
:caption: Utilities:
bimserver-plugin
bimtester bimtester
ifcdiff ifc2ca
ifcpatch ifc4d
ifc5d
ifccityjson
ifcclash ifcclash
ifccobie ifccobie
ifccsv
ifcdiff
ifcpatch
ifcsverchok ifcsverchok
bimserver-plugin ifctester
other
.. toctree::
:hidden:
:maxdepth: 1
:caption: API:
C++ API Reference <https://ifcopenshell.github.io/docs/rst_files/library_root.html> C++ API Reference <https://ifcopenshell.github.io/docs/rst_files/library_root.html>
Python API Reference <autoapi/index> Python API Reference <autoapi/index>
+18
View File
@@ -0,0 +1,18 @@
Other utilities
===============
There are other notable utilites that are built with, or integrate with
IfcOpenShell, but are not officially part of the IfcOpenShell umbrella.
+----------------------+---------------------------------------------------+
| Utility | Description |
+======================+===================================================+
| Ifc2JSON_ | Converts .ifc to .ifcJSON, including support for |
| | stripping geometry, and IfcJSON version 4 and 5a. |
+----------------------+---------------------------------------------------+
| VoxelisationToolkit_ | Converts .ifc geometry into voxels, and lets you |
| | perform voxel based geometric analysis. |
+----------------------+---------------------------------------------------+
.. _Ifc2JSON: https://github.com/buildingSMART/ifcJSON/tree/master/file_converters
.. _VoxelisationToolkit: https://github.com/opensourceBIM/voxelization_toolkit