Skip to content

Commit ad62c75

Browse files
brunopostlebrunopostle
committed
ifcclash ifccsv ifcdiff ifcpatch: README.md stubs
The pyproject.toml files were referencing these missing files
1 parent 7a5bd03 commit ad62c75

File tree

6 files changed

+103
-2
lines changed

6 files changed

+103
-2
lines changed

‎src/ifcclash/README.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# IfcClash
2+
3+
IFC clash detection library to handle intersections, collisions, and clearance checks between building elements in IFC models.
4+
5+
## Features
6+
7+
- **Multiple detection modes**: intersection, collision, and clearance checking
8+
- **Flexible clash sets**: Compare elements within a single model or between multiple IFC files
9+
- **Smart grouping**: Automatically group related clashes
10+
- **Export options**: Export clash results to BCF-XML or JSON formats
11+
- **Element filtering**: Use selectors to specify which elements to check for clashes

‎src/ifccsv/README.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# IfcCSV
2+
3+
A utility to interact with IFC data through CSV. Export and import IFC data from and to CSV, ODS, XLSX formats, and pandas DataFrames. Enables bulk editing of IFC properties and schedules using spreadsheet tools.
4+
5+
## Features
6+
7+
- **Export IFC data**: Extract element properties and attributes to spreadsheet formats
8+
- **Import changes**: Update IFC models from modified spreadsheets
9+
- **Multiple formats**: Support for CSV, ODS (OpenDocument Spreadsheet), XLSX (Excel), and pandas DataFrames
10+
- **Flexible queries**: Use selectors to specify which elements and attributes to export
11+
- **Data transformations**: Group, summarize, format, and sort results
12+
- **Preserve existing data**: Update existing spreadsheets while preserving formatting

‎src/ifcdiff/README.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# IfcDiff
2+
3+
Compare IFC models for changes to geometry, properties, and structure. Compares the differences between two IFC models, including changes to geometry, properties, relationships, and spatial structure. Outputs differences in JSON format for further processing or reporting.
4+
5+
## Features
6+
7+
- **Element tracking**: Identify added and deleted elements between models
8+
- **Relationship comparison**: Track changes in multiple relationship types:
9+
- Geometry
10+
- Attributes
11+
- Type assignments
12+
- Properties
13+
- Spatial containers
14+
- Aggregations
15+
- Classifications
16+
- **Flexible filtering**: Compare only specific element types using IFC selectors
17+
- **Configurable depth**: Choose between shallow (first difference only) or deep (all differences) comparison
18+
- **JSON export**: Export comparison results in JSON format for further processing
19+
- **Precision control**: Configure geometric comparison precision

‎src/ifcdiff/pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ version = "0.0.0"
88
authors = [
99
{ name="Dion Moult", email="dion@thinkmoult.com" },
1010
]
11-
description = "Compares the differences between two IFC models"
11+
description = "Compare IFC models for changes to geometry, properties, and structure"
1212
readme = "README.md"
1313
keywords = ["IFC", "Diff"]
1414
classifiers = [

‎src/ifcpatch/README.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# IfcPatch
2+
3+
Utility for applying modification recipes to IFC files. IfcPatch enables programmatic editing and correction of IFC models through a collection of patches that can fix common issues, migrate data, or transform models.
4+
5+
## Available Recipes
6+
7+
### Alignment and Linear Placement
8+
- **AddGeometricRepresentationToAlignment** - Add geometric representations to alignment elements
9+
- **AddLinearPlacementFallbackPosition** - Add fallback positions for linear placements
10+
- **AddZeroLengthSegmentToAlignment** - Add zero-length segments to alignments
11+
- **PatchStationReferentPosition** - Patch station referent positions
12+
13+
### Data Conversion and Migration
14+
- **AGS2IFC** - Convert AGS (geotechnical) data to IFC
15+
- **ConvertLengthUnit** - Convert between length units
16+
- **ConvertNestToAggregate** - Convert nesting relationships to aggregations
17+
- **ConvertPropertiesToQuantities** - Convert properties to quantities
18+
- **Migrate** - Migrate between IFC schema versions
19+
20+
### Element Extraction and Manipulation
21+
- **ExtractElements** - Extract specific elements into a new model
22+
- **ExtractPropertiesToSQLite** - Export properties to SQLite database
23+
- **Ifc2Sql** - Convert IFC to SQL database
24+
- **TessellateElements** - Tessellate elements into triangulated geometry
25+
26+
### Fixing Software-Specific Issues
27+
- **FixArchiCADToRevitDoorSwings** - Fix door swing orientation from ArchiCAD for Revit
28+
- **FixArchiCADToRevitSpaces** - Fix space data from ArchiCAD for Revit
29+
- **FixRevit2025TINs** - Fix TIN (Triangulated Irregular Network) issues from Revit 2025
30+
- **FixRevitClassificationCodeTypes** - Fix classification code data types from Revit
31+
- **FixRevitTINs** - Fix TIN issues from Revit
32+
33+
### Geometry and Representation
34+
- **AssignConstituentFractions** - Assign fractions to material constituents
35+
- **DowngradeIndexedPolyCurve** - Convert indexed poly curves to simpler representations
36+
- **RemoveSiteRepresentation** - Remove geometric representation from site elements
37+
38+
### Merging and Optimization
39+
- **MergeDuplicateTypes** - Merge duplicate element types
40+
- **MergeProjects** - Merge multiple IFC projects
41+
- **MergeStyles** - Merge duplicate styles
42+
- **Optimise** - Optimize file size and structure
43+
- **PurgeData** - Remove unused data from model
44+
45+
### Spatial and Coordinate Systems
46+
- **OffsetObjectPlacements** - Offset object placement coordinates
47+
- **OffsetStoreyElevations** - Offset storey elevations
48+
- **ResetAbsoluteCoordinates** - Reset absolute coordinates to origin
49+
- **ResetSpatialElementLocations** - Reset spatial element locations
50+
- **SetFalseOrigin** - Set a false origin for coordinates
51+
- **SetRefElevation** - Set reference elevation
52+
- **SetWorldCoordinateSystem** - Set world coordinate system
53+
- **SplitByBuildingStorey** - Split model by building storeys
54+
55+
### Utilities
56+
- **RecycleNonRootedElements** - Remove or recycle non-rooted elements
57+
- **RegenerateGlobalIds** - Regenerate GlobalId values for elements
58+
- **RemoveRevitUniformatClassification** - Remove Revit Uniformat classification
59+
- **UnsharePsets** - Unshare property sets between elements

‎src/ifcpatch/pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ version = "0.0.0"
88
authors = [
99
{ name="Dion Moult", email="dion@thinkmoult.com" },
1010
]
11-
description = "IFC patching utility"
11+
description = "Utility for applying modification recipes to IFC files"
1212
readme = "README.md"
1313
keywords = ["IFC", "BIM"]
1414
classifiers = [

0 commit comments

Comments
 (0)