# IfcTruss
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
<div>
> **Note**
>
> IfcTruss is currently in the beta stage and is subject to a feature
> freeze until the end of February. Its main goals are stabilizing the
> API and improving documentation based on user feedback.
</div>
## Purpose
IfcTruss is an open source
([LGPL-3.0-or-later](https://github.com/IfcTruss/IfcTruss/blob/main/COPYING.LESSER))
software library for creating and calculating trusses in the [Industry
Foundation Classes
(IFC)](https://www.buildingsmart.org/standards/bsi-standards/industry-foundation-classes/)
standard. More precisely, the IFC 4.3 version is supported. This version
is an [ISO
standard](https://www.buildingsmart.org/ifc-4-3-approved-as-a-final-standard/).
The following main functions are provided for building, viewing and
solving a truss model in IFC:
ifctruss.build
ifctruss.view
ifctruss.solve
There are also a few additional side functions that can be used:
ifctruss.save_ods_template
ifctruss.save_xlsx_template
ifctruss.build_from_ods
ifctruss.build_from_xlsx
ifctruss.save_result
Two solvers are available for calculating the trusses. These solvers can
also be used below without IFC:
ifctruss.solver.direct_stiffness_method
ifctruss.solver.calfem
Go to the [Getting
Started](https://ifctruss.github.io/IfcTruss/00_General/getting_started.html)
page to learn more about using this library.
## Feedback
If you have any bugs, improvements, or feature requests, please submit
an issue. Use the [OSArch forum](https://community.osarch.org/) to share
anything else. When you share something in the [OSArch
forum](https://community.osarch.org/), put the library name in the tag.
So that someone else has it easier, if they are looking for a post in
the [OSArch forum](https://community.osarch.org/) regarding this
library.
If you have nothing to share, however, like this library, just
[star](https://docs.github.com/en/get-started/exploring-projects-on-github/saving-repositories-with-stars)
it! This is a great encouragement for the contributors.
## Code of conduct
This project adheres to the Code of Conduct adapted from the
[Contributor Covenant](https://www.contributor-covenant.org), version
2.1, available at
<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
## Changelog
All notable changes to this project will be documented [in this
file](https://ifctruss.github.io/IfcTruss/04_History_and_Changelog/changelog.html).
The format is based on [Keep a
Changelog](https://keepachangelog.com/en/1.0.0/), and this project
adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## Licence
Copyright © 2023-2024 IfcTruss Contributors
This program is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Raw data
{
"_id": null,
"home_page": "https://github.com/IfcTruss/IfcTruss",
"name": "ifctruss",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "ifc truss python",
"author": "IfcTruss Contributors",
"author_email": "ifctruss@mailbox.org",
"download_url": "https://files.pythonhosted.org/packages/f7/01/4af7d2dc1f894a6ecd92abf149cdfa661f8b3565ed4bec64ebdf15caf0f5/ifctruss-0.1.4.tar.gz",
"platform": null,
"description": "# IfcTruss\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n<div>\n\n> **Note**\n>\n> IfcTruss is currently in the beta stage and is subject to a feature\n> freeze until the end of February. Its main goals are stabilizing the\n> API and improving documentation based on user feedback.\n\n</div>\n\n## Purpose\n\nIfcTruss is an open source\n([LGPL-3.0-or-later](https://github.com/IfcTruss/IfcTruss/blob/main/COPYING.LESSER))\nsoftware library for creating and calculating trusses in the [Industry\nFoundation Classes\n(IFC)](https://www.buildingsmart.org/standards/bsi-standards/industry-foundation-classes/)\nstandard. More precisely, the IFC 4.3 version is supported. This version\nis an [ISO\nstandard](https://www.buildingsmart.org/ifc-4-3-approved-as-a-final-standard/).\n\nThe following main functions are provided for building, viewing and\nsolving a truss model in IFC:\n\n ifctruss.build\n ifctruss.view\n ifctruss.solve\n\nThere are also a few additional side functions that can be used:\n\n ifctruss.save_ods_template\n ifctruss.save_xlsx_template\n ifctruss.build_from_ods\n ifctruss.build_from_xlsx\n ifctruss.save_result\n\nTwo solvers are available for calculating the trusses. These solvers can\nalso be used below without IFC:\n\n ifctruss.solver.direct_stiffness_method\n ifctruss.solver.calfem\n\nGo to the [Getting\nStarted](https://ifctruss.github.io/IfcTruss/00_General/getting_started.html)\npage to learn more about using this library.\n\n## Feedback\n\nIf you have any bugs, improvements, or feature requests, please submit\nan issue. Use the [OSArch forum](https://community.osarch.org/) to share\nanything else. When you share something in the [OSArch\nforum](https://community.osarch.org/), put the library name in the tag.\nSo that someone else has it easier, if they are looking for a post in\nthe [OSArch forum](https://community.osarch.org/) regarding this\nlibrary.\n\nIf you have nothing to share, however, like this library, just\n[star](https://docs.github.com/en/get-started/exploring-projects-on-github/saving-repositories-with-stars)\nit! This is a great encouragement for the contributors.\n\n## Code of conduct\n\nThis project adheres to the Code of Conduct adapted from the\n[Contributor Covenant](https://www.contributor-covenant.org), version\n2.1, available at\n<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.\n\n## Changelog\n\nAll notable changes to this project will be documented [in this\nfile](https://ifctruss.github.io/IfcTruss/04_History_and_Changelog/changelog.html).\n\nThe format is based on [Keep a\nChangelog](https://keepachangelog.com/en/1.0.0/), and this project\nadheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n## Licence\n\nCopyright \u00a9 2023-2024 IfcTruss Contributors\n\nThis program is free software: you can redistribute it and/or modify it\nunder the terms of the GNU Lesser General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or (at\nyour option) any later version.\n\nThis program is distributed in the hope that it will be useful, but\nWITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser\nGeneral Public License for more details.\n\nYou should have received a copy of the GNU Lesser General Public License\nalong with this program. If not, see <https://www.gnu.org/licenses/>.\n",
"bugtrack_url": null,
"license": "GNU Lesser General Public License v3",
"summary": "Create and calculate trusses in IFC's",
"version": "0.1.4",
"project_urls": {
"Homepage": "https://github.com/IfcTruss/IfcTruss"
},
"split_keywords": [
"ifc",
"truss",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fa01ffce1aa0d37f6f88abdd941a248e8a0772a5854332885a819134ec9f003f",
"md5": "d1844d6ed6ebd42beca96679568f9c78",
"sha256": "005c41468a57bda57200805669d048f4b6067b00af07f0580d96ae1a2ce27597"
},
"downloads": -1,
"filename": "ifctruss-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d1844d6ed6ebd42beca96679568f9c78",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 39850,
"upload_time": "2024-01-27T17:20:05",
"upload_time_iso_8601": "2024-01-27T17:20:05.204120Z",
"url": "https://files.pythonhosted.org/packages/fa/01/ffce1aa0d37f6f88abdd941a248e8a0772a5854332885a819134ec9f003f/ifctruss-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f7014af7d2dc1f894a6ecd92abf149cdfa661f8b3565ed4bec64ebdf15caf0f5",
"md5": "7a679987989543f0eee70534db41e75d",
"sha256": "bbb3cda826adc7f2d47b807d63cb92817ef4fb78d13ff5fcda727aa4e3d9ec04"
},
"downloads": -1,
"filename": "ifctruss-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "7a679987989543f0eee70534db41e75d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 32968,
"upload_time": "2024-01-27T17:20:06",
"upload_time_iso_8601": "2024-01-27T17:20:06.905016Z",
"url": "https://files.pythonhosted.org/packages/f7/01/4af7d2dc1f894a6ecd92abf149cdfa661f8b3565ed4bec64ebdf15caf0f5/ifctruss-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-27 17:20:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "IfcTruss",
"github_project": "IfcTruss",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ifctruss"
}
JSON
