From 3a0622e9df64b12fc7b32b6922f6584bca9c699d Mon Sep 17 00:00:00 2001 From: daniel-augusto Date: Sun, 26 Oct 2025 06:29:30 -0300 Subject: [PATCH] Update introduction with hyperlinks for tools (#7290) --- src/ifcopenshell-python/docs/introduction.rst | 42 +++++++++---------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/src/ifcopenshell-python/docs/introduction.rst b/src/ifcopenshell-python/docs/introduction.rst index 76032d334d..58430b6da8 100644 --- a/src/ifcopenshell-python/docs/introduction.rst +++ b/src/ifcopenshell-python/docs/introduction.rst @@ -54,27 +54,27 @@ IfcOpenShell is a modular ecosystem of tools that work together, where each tool .. csv-table:: :header: "Name", "Description" - "**IfcOpenShell**", "The core library for C++ developers. The library includes the ability to parse schemas, tessellate and process implicit geometry." - "**IfcOpenShell-Python**", "Python bindings to the core IfcOpenShell C++ system, as well as high level analysis and authoring functions." - "**IfcConvert**", "A command-line application for converting IFC geometry into file formats such as OBJ, DAE, GLB, STP, IGS, XML, SVG, H5, and IFC itself." - "**Bonsai**", "A graphical add-on for Blender that lets you analyse, author, and modify IFC with Blender. Graphically create BIM models from scratch!" - "**BCF**", "BIM Collaboration Format (BCF) is a standard to manage and exchange coordination topics between disciplines collaborating on a project by changing XML files or querying an API." - "**BIMServer-Plugin**", "A plugin to the open source BIMServer CDE to allow you to use IfcOpenShell to parse, view, and audit models." - "**BIMTester**", "A utility that allows you to write Gherkin-based tests for models." - "**bSDD**", "A Python library to query the buildingSMART Data Dictionary API to search for standardised classifications and properties." - "**Ifc2CA**", "Converts IFC models to FEM structural analytical models to be used in Code_Aster." - "**Ifc4D**", "A series of utilities for converting to and from various 4D software like MS Project, PowerProject, and Oracle P6." - "**Ifc5D**", "A collection of utilities of manipulating cost-related data to and from formats, reports, and optimisation engines." - "**IfcCityJSON**", "A converter for CityJSON files and IFC. It currently only supports one-way conversion from CityJSON to IFC." - "**IfcClash**", "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." - "**IfcCSV**", "View and edit IFC data using spreadsheets or tabular datasets, such as CSV, ODS, XLSX, Pandas DataFrames, and regular Python lists." - "**IfcDiff**", "A CLI utility and library that lets you compare the changes between two IFC models." - "**IfcFM**", "A highly standards-compliant tool (e.g. COBie 2.4, COBie 3.0, AOH-BSEM) to convert FM data in IFC databases to spreadsheets and other machine readable formats, such as ODS, XLSX, CSV, Pandas, XML, and JSON." - "**IfcMax**", "A 3ds Max importer plugin able to import the IFC file format." - "**IfcPatch**", "A CLI utility and library that lets you run and distribute predetermined modifications on an IFC file, known as a patch recipe. Useful in deploying a data pipeline or batch-fixing external models." - "**IfcSverchok**", "A node based visual programming add-on for Blender to interact with IFC and Sverchok." - "**IfcTester**", "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." - "**VoxelisationToolkit**", "Converts .ifc geometry into voxels, and lets you perform voxel based geometric analysis." + "`IfcOpenShell `_", "The core library for C++ developers. The library includes the ability to parse schemas, tessellate and process implicit geometry." + "`IfcOpenShell-Python `_", "Python bindings to the core IfcOpenShell C++ system, as well as high level analysis and authoring functions." + "`IfcConvert `_", "A command-line application for converting IFC geometry into file formats such as OBJ, DAE, GLB, STP, IGS, XML, SVG, H5, and IFC itself." + "`Bonsai `_", "A graphical add-on for Blender that lets you analyse, author, and modify IFC with Blender. Graphically create BIM models from scratch!" + "`BCF `_", "BIM Collaboration Format (BCF) is a standard to manage and exchange coordination topics between disciplines collaborating on a project by changing XML files or querying an API." + "`BIMServer-Plugin `_", "A plugin to the open source BIMServer CDE to allow you to use IfcOpenShell to parse, view, and audit models." + "`BIMTester `_", "A utility that allows you to write Gherkin-based tests for models." + "`bSDD `_", "A Python library to query the buildingSMART Data Dictionary API to search for standardised classifications and properties." + "`Ifc2CA `_", "Converts IFC models to FEM structural analytical models to be used in Code_Aster." + "`Ifc4D `_", "A series of utilities for converting to and from various 4D software like MS Project, PowerProject, and Oracle P6." + "`Ifc5D `_", "A collection of utilities of manipulating cost-related data to and from formats, reports, and optimisation engines." + "`IfcCityJSON `_", "A converter for CityJSON files and IFC. It currently only supports one-way conversion from CityJSON to IFC." + "`IfcClash `_", "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." + "`IfcCSV `_", "View and edit IFC data using spreadsheets or tabular datasets, such as CSV, ODS, XLSX, Pandas DataFrames, and regular Python lists." + "`IfcDiff `_", "A CLI utility and library that lets you compare the changes between two IFC models." + "`IfcFM `_", "A highly standards-compliant tool (e.g. COBie 2.4, COBie 3.0, AOH-BSEM) to convert FM data in IFC databases to spreadsheets and other machine readable formats, such as ODS, XLSX, CSV, Pandas, XML, and JSON." + "`IfcMax `_", "A 3ds Max importer plugin able to import the IFC file format." + "`IfcPatch `_", "A CLI utility and library that lets you run and distribute predetermined modifications on an IFC file, known as a patch recipe. Useful in deploying a data pipeline or batch-fixing external models." + "`IfcSverchok `_", "A node based visual programming add-on for Blender to interact with IFC and Sverchok." + "`IfcTester `_", "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." + "`VoxelisationToolkit `_", "Converts .ifc geometry into voxels, and lets you perform voxel based geometric analysis." .. note::