Commit Graph

1044 Commits

Author SHA1 Message Date
Dion Moult aed3bdf72a Write docs for project API module 2023-01-05 16:59:48 +11:00
Dion Moult 968f56a189 Revert detailed SPF comments in code example
Sorry I find these really hard to read an intimidating for new users.
2023-01-05 16:59:48 +11:00
Dion Moult 90d92e70b2 Write docs for profile API module 2023-01-05 16:59:48 +11:00
Dion Moult efacef1789 Write docs for owner API module 2023-01-05 16:59:48 +11:00
Dion Moult 28d9e435d1 Write documentation for the nest API module. 2023-01-05 16:59:48 +11:00
Dion Moult fe5e35bae4 Add API documentation for the material module 2023-01-05 16:59:48 +11:00
Dion Moult 1dc5b8cd33 Add docs for library API module 2023-01-05 16:59:48 +11:00
Dion Moult 8e04847310 Add docs to layer API 2023-01-05 16:59:48 +11:00
Dion Moult b37d8d3e7f Add API documentation for group module 2023-01-05 16:59:48 +11:00
Dion Moult 7d08360808 Add documentation for grid API module 2023-01-05 16:59:48 +11:00
Ryan Schultz 5ac0e92250 Added more examples to the Code Examples page 2023-01-05 16:59:48 +11:00
Dion Moult 1313cb34bb Add API docs for georeferencing module 2023-01-05 16:59:48 +11:00
CyrilWaechter 78f03c8544 Allow to write .ifcZIP | .ifcXML #2350
Transparently write any .ifc | .ifcXML | .ifcZIP formatted file
 with any extension :
- by guessing format from its extension
(eg. .zip | .ifczip | .ifcZIP | .ifcXML | .ifcxml | .IFC | .ifc)
zipped file can file can be of any supported format
- by specifying a format
- by specifying if it should be zipped
2023-01-05 16:59:47 +11:00
Ryan Schultz 6ba56fdf35 misspellings with outer_boundary 2023-01-05 16:59:47 +11:00
CyrilWaechter 386205cde7 Fix IfcSystem assignment bug introduced in f0b1935
Fixing my own bug…
Note : always run all test before pushing not only the one which used to fail…
2023-01-05 16:59:47 +11:00
CyrilWaechter ba4f8886e9 Add system assignment check
@aothms Is there a way to check against IFC formal propositions ?
Example for [IfcZone](http://ifc43-docs.standards.buildingsmart.org/IFC/RELEASE/IFC4x3/HTML/lexical/IfcZone.htm#5.4.3.82.4-Formal-propositions)
@Moult Should I move is_assignable to an util ?
2023-01-05 16:59:47 +11:00
Thomas Krijnen 28261491d0 Test cases for #2586 2023-01-05 16:59:47 +11:00
Thomas Krijnen f10646ad35 Distinguish between nil and derived in validate.py 2023-01-05 16:59:47 +11:00
Dion Moult 267bb65b5e Add API docs for drawing module 2023-01-05 16:59:47 +11:00
Dion Moult 0968687bc3 Add API documentation for document module 2023-01-05 16:59:47 +11:00
CyrilWaechter 71f1236252 Fix path for ci (root at src/ifcopenshell-python) 2023-01-05 16:59:47 +11:00
CyrilWaechter edee74cb31 Fix type hints #2350 for python <3.10 2023-01-05 16:59:47 +11:00
CyrilWaechter 2007047ae2 Add test suite for ifcopenshell.open #2350
Fix open function: format argument was unused
2023-01-05 16:59:47 +11:00
Dion Moult d10325f69d Add documentation for cost module 2023-01-05 16:59:47 +11:00
CyrilWaechter 1ed379e466 Allow to open .ifcZIP | .ifcXML #2350
Transparently open any .ifc | .ifcXML | .ifcZIP formatted file
 with any extension :
- by guessing format from its extension
(eg. .zip | .ifczip | .ifcZIP | .ifcXML | .ifcxml | .IFC | .ifc)
zipped file can file can be of any supported format
-  by specifying a format
2023-01-05 16:59:47 +11:00
CyrilWaechter fcb6971d4d IfcZone: Allow to remove an object from an IfcZone 2023-01-05 16:59:47 +11:00
Thomas Krijnen b161681ffa Fix test case 2023-01-05 16:59:47 +11:00
Vukas Pajic fffb5ab6a3 #2602 get_properties no longer throws error when EnumerationValues = None 2023-01-05 16:59:47 +11:00
Dion Moult f43e6069ec Write API documentation for control module 2023-01-05 16:59:47 +11:00
Dion Moult c6fc048fc3 Add API documentation for context module 2023-01-05 16:59:47 +11:00
Dion Moult 8bb940c851 Add API docs for constraint module 2023-01-05 16:59:47 +11:00
Dion Moult 522d3a8367 Add API documentation for classification module 2023-01-05 16:59:47 +11:00
Dion Moult 37954e35e7 Add API docs for boundary module 2023-01-05 16:59:47 +11:00
Dion Moult 2f39490fda Add docs for attribute API 2023-01-05 16:59:47 +11:00
Dion Moult f322ab6c51 Add docs for aggregate api 2023-01-05 16:59:47 +11:00
Dion Moult 3a8df68710 Minor fix 2023-01-05 16:59:47 +11:00
Dion Moult e9a4b06f2b Minor documentation tweaks 2023-01-05 16:59:47 +11:00
Thomas Krijnen bf8771c586 draw.include_projection setting 2023-01-05 16:59:47 +11:00
Dion Moult 57917f89e5 Document how you can get the matrix of elements from IfcOpenShell Python. 2023-01-05 16:59:46 +11:00
Dion Moult ff90728a22 New unassign container API function 2022-11-07 18:47:15 +11:00
Dion Moult 516bd37518 Fix #2550. Bug where material styles weren't included when appending from a library 2022-11-07 16:20:23 +11:00
Dion Moult adc59de2bf Minor fix to accommodate null descriptions and parents with no attributes
# Conflicts:
#	src/ifcopenshell-python/ifcopenshell/util/doc.py
2022-11-03 17:13:56 +11:00
Andrej730 c0909dace0 black.py formatting 2022-11-02 17:35:51 +06:00
Dion Moult 2043a629c7 Material profile sets UI cleanup and now lets you choose from a profile in your library instead of creating new profiles on the fly all the time 2022-11-01 23:39:07 +11:00
Dion Moult f0e4397ef9 Change PyPI package readme. See #2531. 2022-11-01 09:08:13 +11:00
Andrej730 d9f8aa4e7b Added ifc types schema for Ifc2x3 and Ifc4
Types schema located in separate json file, it's structure:
{ ifc_type_name: {"description": type_description, "spec_url": type_spec_url} }

I've also added new API function to get type data - `get_type_doc(version, ifc_type)`
2022-10-30 11:33:20 +06:00
Andrej730 9a25db6584 get_attribute_doc get_entity_doc now use recursive method by default 2022-10-29 18:31:40 +06:00
Andrej730 17ccd0adf7 Simplified getting entity parent information for schema api
Removed unnecssary parent information from json schema - now API is getting it from ifcopenshell schema.
2022-10-29 18:27:51 +06:00
Andrej730 937f39c898 Added information about parent entity to schema
Added information about parent entity to schema (it's located in "parent_entity" entity parameter inside schema), both for Ifc2x3 and Ifc4.

Modified get_entity_doc and get_attribute_doc - now you can use additional optional parameter `recursive=True` with those functions - then parent entities attributes will be included to the list of entity's attributes. For example IfcWindow will also have attributes from IfcBuildingElement, IfcElement, IfcProduct etc...
2022-10-29 17:35:43 +06:00
Andrej730 0b5ccd88a5 Added descriptions for psets and qsets to ifc2x3, ifc4 schema
Example of getting pset description: `get_property_set_doc("IFC4", "Pset_ZoneCommon")['description']`
2022-10-29 16:31:54 +06:00