Skip to content

Commit 24deb90

Browse files
authored
Update README.md
1 parent 4802c3e commit 24deb90

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,42 @@ conda install -c conda-forge ifcopenshell=v0.7.0
4848
conda install -c ifcopenshell voxelization_toolkit
4949
```
5050

51+
## Quick tutorial
52+
53+
0. Perform the installation steps above
54+
1. Create a new empty folder with:
55+
- `voxelfile.txt`; contents of https://github.com/opensourceBIM/voxelization_toolkit/blob/e9ce7e0c5569da67c9953bcd4e6496b5ce1c3699/tests/fixtures/voxelfile1.txt
56+
- `duplex.ifc`; contents of https://github.com/opensourceBIM/voxelization_toolkit/blob/e9ce7e0c5569da67c9953bcd4e6496b5ce1c3699/tests/fixtures/duplex.ifc
57+
2. `cd` to the directory in powershell/bash and run:
58+
`voxec voxelfile.txt`
59+
3. Observe an output is printed like below as the flow of the procedure defined in `voxelfile.txt` is executed.
60+
```
61+
[ ]
62+
severity: notice
63+
message: executing {statement}
64+
time: 2024:10:25 14:36:43.283
65+
statement:
66+
text: file = parse("duplex.ifc")
67+
[##### ]
68+
severity: notice
69+
message: executing {statement}
70+
time: 2024:10:25 14:36:43.392
71+
statement:
72+
text: surfaces = create_geometry(file)
73+
[########### ]
74+
severity: notice
75+
message: executing {statement}
76+
time: 2024:10:25 14:36:44.575
77+
statement:
78+
text: slabs = create_geometry(file,include={"IfcSlab"})
79+
```
80+
4. Now add a line:
81+
`export_point_cloud(outmost_voxels, "outmost_voxels.obj")`
82+
5. and rerun voxec.
83+
6. The exported file can now be visualized for example in Blender.
84+
85+
![](img/duplex_outer_voxel_pointcloud.png)
86+
5187
## Usage
5288

5389
Recommended usage is using the `voxec` runtime interpreter, which takes an input "voxelfile" which describes a series of commands. The grammar of such as voxelfile is:

0 commit comments

Comments
 (0)