search

GeometryGym / GeometryGymIFC

C# classes to generate and parse OpenBIM IFC files
Other
282 stars 97 forks source link

No Documentation of API #70

Open RyanDaley opened 2 years ago

RyanDaley commented 2 years ago

Is there no documentation for the API? I guess I can just learn how to use this GeometryGymIFC namespace through the examples, but I'm surprised by the lack of technical documentation.

jmirtsch commented 2 years ago

Hi Ryan,

Thanks for posting, I hope you find the development helpful and interesting.
Can you clarify the technical documentation you're seeking?
buildingSMART document the classes, attributes and relationships, you can find this at https://technical.buildingsmart.org/standards/ifc/ifc-schema-specifications/?sfw=pass1661382182

The Geometry Gym toolkit is a c# implementation of this standard, for reading/writing IFC files. We have limited resources (ie time) to devote to documenting the toolkit, but of course we welcome external contributions from any others willing to help make the process easier for new developers.

If you have suggestions, we will certainly consider what we might do ourselves. Examples and sample code is certainly what we have focused on given that buildingSMART maintains the specification.

Look forward to discussing further,

Jon