diff --git a/src/ifcopenshell-python/docs/ifc2ca.rst b/src/ifcopenshell-python/docs/ifc2ca.rst new file mode 100644 index 0000000000..419befb498 --- /dev/null +++ b/src/ifcopenshell-python/docs/ifc2ca.rst @@ -0,0 +1,5 @@ +Ifc2CA +====== + +Ifc2CA converts IFC models to FEM structural analytical models to be used in +Code_Aster. diff --git a/src/ifcopenshell-python/docs/ifc4d.rst b/src/ifcopenshell-python/docs/ifc4d.rst new file mode 100644 index 0000000000..f3474b7871 --- /dev/null +++ b/src/ifcopenshell-python/docs/ifc4d.rst @@ -0,0 +1,4 @@ +Ifc4D +===== + +Ifc4D contains a series of utilities for converting to and from various 4D software. diff --git a/src/ifcopenshell-python/docs/ifc5d.rst b/src/ifcopenshell-python/docs/ifc5d.rst new file mode 100644 index 0000000000..966c9262d6 --- /dev/null +++ b/src/ifcopenshell-python/docs/ifc5d.rst @@ -0,0 +1,5 @@ +Ifc5D +===== + +Ifc5D is a collection of utilities of manipulating cost-related data to and +from formats, reports, and optimisation engines. diff --git a/src/ifcopenshell-python/docs/ifccityjson.rst b/src/ifcopenshell-python/docs/ifccityjson.rst new file mode 100644 index 0000000000..df4c7a209b --- /dev/null +++ b/src/ifcopenshell-python/docs/ifccityjson.rst @@ -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. diff --git a/src/ifcopenshell-python/docs/ifcconvert.rst b/src/ifcopenshell-python/docs/ifcconvert.rst index c856124353..19c59c7b0f 100644 --- a/src/ifcopenshell-python/docs/ifcconvert.rst +++ b/src/ifcopenshell-python/docs/ifcconvert.rst @@ -1,8 +1,68 @@ IfcConvert ========== -IfcConvert is a command-line application for converting IFC geometry into -file formats such as OBJ, DAE, GLB, STP, IGS, XML, and SVG. +IfcConvert is a command-line application for converting IFC geometry into file +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:: :hidden: diff --git a/src/ifcopenshell-python/docs/ifccsv.rst b/src/ifcopenshell-python/docs/ifccsv.rst new file mode 100644 index 0000000000..3734dbfbf5 --- /dev/null +++ b/src/ifcopenshell-python/docs/ifccsv.rst @@ -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. diff --git a/src/ifcopenshell-python/docs/ifctester.rst b/src/ifcopenshell-python/docs/ifctester.rst new file mode 100644 index 0000000000..d384e3216d --- /dev/null +++ b/src/ifcopenshell-python/docs/ifctester.rst @@ -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. diff --git a/src/ifcopenshell-python/docs/index.rst b/src/ifcopenshell-python/docs/index.rst index a29a01941f..f5bd6086d0 100644 --- a/src/ifcopenshell-python/docs/index.rst +++ b/src/ifcopenshell-python/docs/index.rst @@ -10,18 +10,38 @@ IfcOpenShell is a suite of developer libraries and utilities to manipulate OpenB .. toctree:: :hidden: :maxdepth: 1 - :caption: Contents: + :caption: Main: ifcopenshell ifcopenshell-python ifcconvert + blenderbim + +.. toctree:: + :hidden: + :maxdepth: 1 + :caption: Utilities: + + bimserver-plugin bimtester - ifcdiff - ifcpatch + ifc2ca + ifc4d + ifc5d + ifccityjson ifcclash ifccobie + ifccsv + ifcdiff + ifcpatch ifcsverchok - bimserver-plugin + ifctester + other + +.. toctree:: + :hidden: + :maxdepth: 1 + :caption: API: + C++ API Reference Python API Reference diff --git a/src/ifcopenshell-python/docs/other.rst b/src/ifcopenshell-python/docs/other.rst new file mode 100644 index 0000000000..d7f30ef31f --- /dev/null +++ b/src/ifcopenshell-python/docs/other.rst @@ -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