https://github.com/ottokokstein/ifc-buildingelementproxy-data-extractor
A tool for extracting BuildingElementProxy data from an IFC file into a spreadsheet
https://github.com/ottokokstein/ifc-buildingelementproxy-data-extractor
buildingelementproxy extractor flask html ifc ifc-files ifcopenshell python spreadsheet-data xlsx xlsx-files
Last synced: 2 months ago
JSON representation
A tool for extracting BuildingElementProxy data from an IFC file into a spreadsheet
- Host: GitHub
- URL: https://github.com/ottokokstein/ifc-buildingelementproxy-data-extractor
- Owner: ottokokstein
- License: mit
- Created: 2024-09-14T14:34:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-14T16:34:38.000Z (over 1 year ago)
- Last Synced: 2025-09-03T12:50:09.161Z (8 months ago)
- Topics: buildingelementproxy, extractor, flask, html, ifc, ifc-files, ifcopenshell, python, spreadsheet-data, xlsx, xlsx-files
- Language: Python
- Homepage:
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ifc-buildingelementproxy-data-extractor
[](https://github.com/psf/black)
A tool for extracting BuildingElementProxy data from an IFC file into an XLSX file.
This tool uses a webpage interface because it was meant to be used as an online tool with the server hosted on [pythonanywhere](https://www.eu.pythonanywhere.com/).
## Requirements
This tool requires several external Python modules, which are listed below together with the version I tested.
Required modules can be installed with `pip install -r /path/to/requirements.txt`.
The tool was tested with Python **3.10.8**.
| Module | Tested version | Link |
| -------- | ------- | ------- |
| Flask | 3.0.3 | |
| ifcopenshell | 0.8.0 | |
| openpyxl | 3.1.5 | |
| pandas | 2.2.2 | |
## Example
An example input IFC file and output XLSX file can be found in the **example** directory.
## How to extract
### 1. Run the tool
Run the tool with `python -3.10 app.py`.
### 2. Access the interface
When the tool announces a successful start, access the webpage in your browser with **localhost:5000**.
### 3. Choose input
When the webpage interface loads, use the **Choose File** button to select the IFC file from which you would like to extract the BuildingElementProxy data.
### 4. Extract data
Click the **Extract** button to begin extraction. The process can take a while to complete. When the extraction finishes successfully, it will be announced by a message below the **Extract** button. The same area will also display a message if the extraction fails. If that happens, refresh the webpage and try again. If the issue persists, feel free to submit a bug report.
### 5. Download output
The output XLSX file can be downloaded using the **Download** button.
### 6. Terminate the tool
The tool can be terminated by pressing **Ctrl + C** in the command prompt window.
## Footnote
Thank you for using my tool.
If you find a bug, feel free to create a pull request or a bug report. If you'd like help, feel free to contact me.