compas-ifc


Namecompas-ifc JSON
Version 0.6.0 PyPI version JSON
download
home_pageNone
SummaryHigh-level IFC interface for COMPAS.
upload_time2024-06-26 15:35:14
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT License ETH Zurich Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords compas ifc bim interoperability
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # COMPAS IFC

![compas_ifc](compas_ifc.png)

Industry Foundation Classes (IFC) is a data model that describes building and construction industry data. It is a platform neutral, open file format specification that is not controlled by a single vendor or group of vendors. It is an object-based file format with a data model developed by buildingSMART (formerly the International Alliance for Interoperability, IAI) to facilitate interoperability in the architecture, engineering and construction (AEC) industry, and is a commonly used collaboration format in Building information modeling (BIM) based projects. The latest IFC documentation and specification can be found at https://ifc43-docs.standards.buildingsmart.org/.

IFC is now widely adopted by industry and often the required format for BIM data exchange and project delivery. However Working direcly with IFC content is a highly complicated task, due to its multi-layered class inheritances and complex spatial heirarchies.

COMPAS IFC is a COMPAS extension developed to make our lives easier. It allows us to work with IFC files in an accessible, developer-friendly and pythonic way. By creating a two-way bridge between IFC files and COMPAS data structures, we can immediately benifit from wide range of tools for geometric processing and analysing from COMPAS ecosystem. COMPAS IFC also allows us to export processed data back to valid IFC files.

COMPAS IFC relies on [IfcOpenShell](https://ifcopenshell.org/) for lower-level entity parsing, schema retriving and file manipulations, On top of that we additionally simplify the workflow to interact with IFC contents. 

Some of the core features of COMPAS IFC are:

- Prase IFC files and inspect its entities
- Traverse IFC spatial heirarchies in a user-friendly way
- View and edit IFC entity attributes and properties
- Extract geometric representations from IFC entities as COMPAS geometry and data structures
- Export selected IFC entities while maintaining minimal valid spatial structure
- Insert new IFC entities into existing IFC files.
- Create entirely new IFC files from scratch with valid spatial structure (in progress)


This package is still early stage of development. The repo structure is subject to change. If you have questions please do not hesitate create a new issue on github repo or contanct me directly at li.chen@arch.ethz.ch .



Please see documentation at: http://compas.dev/compas_ifc/

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "compas-ifc",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "compas, ifc, bim, interoperability",
    "author": null,
    "author_email": "Tom Van Mele <van.mele@arch.ethz.ch>, Li Chen <li.chen@arch.ethz.ch>",
    "download_url": "https://files.pythonhosted.org/packages/c6/a1/5408a252e9b7f445c207665a97890b9e447bec8baa634eddcbff34d8e088/compas_ifc-0.6.0.tar.gz",
    "platform": null,
    "description": "# COMPAS IFC\r\n\r\n![compas_ifc](compas_ifc.png)\r\n\r\nIndustry Foundation Classes (IFC) is a data model that describes building and construction industry data. It is a platform neutral, open file format specification that is not controlled by a single vendor or group of vendors. It is an object-based file format with a data model developed by buildingSMART (formerly the International Alliance for Interoperability, IAI) to facilitate interoperability in the architecture, engineering and construction (AEC) industry, and is a commonly used collaboration format in Building information modeling (BIM) based projects. The latest IFC documentation and specification can be found at https://ifc43-docs.standards.buildingsmart.org/.\r\n\r\nIFC is now widely adopted by industry and often the required format for BIM data exchange and project delivery. However Working direcly with IFC content is a highly complicated task, due to its multi-layered class inheritances and complex spatial heirarchies.\r\n\r\nCOMPAS IFC is a COMPAS extension developed to make our lives easier. It allows us to work with IFC files in an accessible, developer-friendly and pythonic way. By creating a two-way bridge between IFC files and COMPAS data structures, we can immediately benifit from wide range of tools for geometric processing and analysing from COMPAS ecosystem. COMPAS IFC also allows us to export processed data back to valid IFC files.\r\n\r\nCOMPAS IFC relies on [IfcOpenShell](https://ifcopenshell.org/) for lower-level entity parsing, schema retriving and file manipulations, On top of that we additionally simplify the workflow to interact with IFC contents. \r\n\r\nSome of the core features of COMPAS IFC are:\r\n\r\n- Prase IFC files and inspect its entities\r\n- Traverse IFC spatial heirarchies in a user-friendly way\r\n- View and edit IFC entity attributes and properties\r\n- Extract geometric representations from IFC entities as COMPAS geometry and data structures\r\n- Export selected IFC entities while maintaining minimal valid spatial structure\r\n- Insert new IFC entities into existing IFC files.\r\n- Create entirely new IFC files from scratch with valid spatial structure (in progress)\r\n\r\n\r\nThis package is still early stage of development. The repo structure is subject to change. If you have questions please do not hesitate create a new issue on github repo or contanct me directly at li.chen@arch.ethz.ch .\r\n\r\n\r\n\r\nPlease see documentation at: http://compas.dev/compas_ifc/\r\n",
    "bugtrack_url": null,
    "license": "MIT License  ETH Zurich  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "High-level IFC interface for COMPAS.",
    "version": "0.6.0",
    "project_urls": {
        "Changelog": "https://github.com/compas-dev/compas_ifc/blob/main/CHANGELOG.md",
        "Documentation": "https://compas.dev/compas_ifc/",
        "Forum": "https://forum.compas-framework.org/",
        "Homepage": "https://github.com/compas-dev/compas_ifc",
        "Issues": "https://github.com/compas-dev/compas_ifc/issues",
        "Repository": "https://github.com/compas-dev/compas_ifc.git"
    },
    "split_keywords": [
        "compas",
        " ifc",
        " bim",
        " interoperability"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "74816bf026dbef15c17878b3969072e1011486e412de8a9cd013ca02d0195dd7",
                "md5": "aeba67bab8fd8486562e37dc7a0f7203",
                "sha256": "7d1d4221a79e41708f423a317d86bab7d2b4c19578f488a74aad371ebfe0f5cb"
            },
            "downloads": -1,
            "filename": "compas_ifc-0.6.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "aeba67bab8fd8486562e37dc7a0f7203",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 51369,
            "upload_time": "2024-06-26T15:35:12",
            "upload_time_iso_8601": "2024-06-26T15:35:12.036331Z",
            "url": "https://files.pythonhosted.org/packages/74/81/6bf026dbef15c17878b3969072e1011486e412de8a9cd013ca02d0195dd7/compas_ifc-0.6.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c6a15408a252e9b7f445c207665a97890b9e447bec8baa634eddcbff34d8e088",
                "md5": "f94c106f0876565f6f0ed32b12b9ba4b",
                "sha256": "a843d758b828a8c1f7782118bfb812c79fa9f16dc327fbd0fab800ec4a7cbf95"
            },
            "downloads": -1,
            "filename": "compas_ifc-0.6.0.tar.gz",
            "has_sig": false,
            "md5_digest": "f94c106f0876565f6f0ed32b12b9ba4b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 41342,
            "upload_time": "2024-06-26T15:35:14",
            "upload_time_iso_8601": "2024-06-26T15:35:14.300257Z",
            "url": "https://files.pythonhosted.org/packages/c6/a1/5408a252e9b7f445c207665a97890b9e447bec8baa634eddcbff34d8e088/compas_ifc-0.6.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-26 15:35:14",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "compas-dev",
    "github_project": "compas_ifc",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "compas-ifc"
}
        
Elapsed time: 0.59999s