# compas_timber
[](https://github.com/gramaziokohler/compas_timber/actions)
[](https://pypi.python.org/pypi/compas_timber)
[](https://pypi.python.org/project/compas_timber)
[](https://pypi.python.org/pypi/compas_timber)
[](https://pypi.python.org/pypi/compas_timber)
[](https://doi.org/10.5281/zenodo.7934267)
[](https://twitter.com/compas_dev)
`compas_timber` is a user-friendly open-source software toolkit to streamline the design of timber frame structures. Despite its advances in digitalization compared to other building techniques, timber construction is often perceived as a challenging field, involving intricate processes in design, planning, coordination, and fabrication. We aim to increase the use of timber in architecture by lowering the threshold of creating versatile and resource-aware designs.
## Installation
> It is recomended you install `compas_timber` inside a virtual environment.
```bash
pip install compas_timber
```
To install `compas_timber` to Rhino run
```bash
python -m compas_rhino.install
```
## First Steps
* [Documentation](https://gramaziokohler.github.io/compas_timber/)
* [COMPAS TIMBER Grasshopper Tutorial](https://gramaziokohler.github.io/compas_timber/latest/tutorials.html)
* [COMPAS TIMBER API Reference](https://gramaziokohler.github.io/compas_timber/latest/api.html)
## Questions and feedback
We encourage the use of the [COMPAS framework forum](https://forum.compas-framework.org/)
for questions and discussions.
## Issue tracker
If you found an issue or have a suggestion for a dandy new feature, please file a new issue in our [issue tracker](https://github.com/gramaziokohler/compas_timber/issues).
## Contributing
We love contributions!
Check the [Contributor's Guide](https://github.com/gramaziokohler/compas_timber/blob/main/CONTRIBUTING.md)
for more details.
## Credits
`compas_timber` is currently developed by Gramazio Kohler Research. See the [list of authors](https://github.com/gramaziokohler/compas_timber/blob/main/AUTHORS.md) for a complete overview.
Raw data
{
"_id": null,
"home_page": "https://github.com/gramaziokohler/compas_timber",
"name": "compas-timber",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Gramazio Kohler Research",
"author_email": "gramaziokohler@arch.ethz.ch",
"download_url": "https://files.pythonhosted.org/packages/b1/cb/f2e7142cd43a3ac85bfaa15a66b5b674e14a4ad1beb6733f54b41945ce15/compas_timber-0.14.2.tar.gz",
"platform": null,
"description": "# compas_timber\r\n\r\n[](https://github.com/gramaziokohler/compas_timber/actions)\r\n[](https://pypi.python.org/pypi/compas_timber)\r\n[](https://pypi.python.org/project/compas_timber)\r\n[](https://pypi.python.org/pypi/compas_timber)\r\n[](https://pypi.python.org/pypi/compas_timber)\r\n[](https://doi.org/10.5281/zenodo.7934267)\r\n[](https://twitter.com/compas_dev)\r\n\r\n\r\n\r\n`compas_timber` is a user-friendly open-source software toolkit to streamline the design of timber frame structures. Despite its advances in digitalization compared to other building techniques, timber construction is often perceived as a challenging field, involving intricate processes in design, planning, coordination, and fabrication. We aim to increase the use of timber in architecture by lowering the threshold of creating versatile and resource-aware designs.\r\n\r\n## Installation\r\n\r\n> It is recomended you install `compas_timber` inside a virtual environment.\r\n\r\n```bash\r\npip install compas_timber\r\n```\r\n\r\nTo install `compas_timber` to Rhino run\r\n\r\n```bash\r\npython -m compas_rhino.install\r\n```\r\n\r\n## First Steps\r\n\r\n* [Documentation](https://gramaziokohler.github.io/compas_timber/)\r\n* [COMPAS TIMBER Grasshopper Tutorial](https://gramaziokohler.github.io/compas_timber/latest/tutorials.html)\r\n* [COMPAS TIMBER API Reference](https://gramaziokohler.github.io/compas_timber/latest/api.html)\r\n\r\n## Questions and feedback\r\n\r\nWe encourage the use of the [COMPAS framework forum](https://forum.compas-framework.org/)\r\nfor questions and discussions.\r\n\r\n## Issue tracker\r\n\r\nIf you found an issue or have a suggestion for a dandy new feature, please file a new issue in our [issue tracker](https://github.com/gramaziokohler/compas_timber/issues).\r\n\r\n## Contributing\r\n\r\nWe love contributions!\r\n\r\nCheck the [Contributor's Guide](https://github.com/gramaziokohler/compas_timber/blob/main/CONTRIBUTING.md)\r\nfor more details.\r\n\r\n## Credits\r\n\r\n`compas_timber` is currently developed by Gramazio Kohler Research. See the [list of authors](https://github.com/gramaziokohler/compas_timber/blob/main/AUTHORS.md) for a complete overview.\r\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "COMPAS package for modeling, designing and fabricating timber assemblies.",
"version": "0.14.2",
"project_urls": {
"Homepage": "https://github.com/gramaziokohler/compas_timber"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9bec58c8606091795dcd7fb4e811e5efac2022950a9b5f79dd220455bfde93ce",
"md5": "ac47297f926cde1f01c24fc37f0a933a",
"sha256": "a51ac594cba5c5b7694a5fcbbc8ee40f103617cf2172360af855879e76b1bb26"
},
"downloads": -1,
"filename": "compas_timber-0.14.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "ac47297f926cde1f01c24fc37f0a933a",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 387612,
"upload_time": "2025-02-17T17:01:01",
"upload_time_iso_8601": "2025-02-17T17:01:01.085347Z",
"url": "https://files.pythonhosted.org/packages/9b/ec/58c8606091795dcd7fb4e811e5efac2022950a9b5f79dd220455bfde93ce/compas_timber-0.14.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b1cbf2e7142cd43a3ac85bfaa15a66b5b674e14a4ad1beb6733f54b41945ce15",
"md5": "500743903d2fb30f2b70cba46ad11f4e",
"sha256": "06df5e1ab8631531fe6c9efd1924ee41e6c1dc4a138df8c2cf749ee9f1a2ed4d"
},
"downloads": -1,
"filename": "compas_timber-0.14.2.tar.gz",
"has_sig": false,
"md5_digest": "500743903d2fb30f2b70cba46ad11f4e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 292925,
"upload_time": "2025-02-17T17:01:02",
"upload_time_iso_8601": "2025-02-17T17:01:02.388605Z",
"url": "https://files.pythonhosted.org/packages/b1/cb/f2e7142cd43a3ac85bfaa15a66b5b674e14a4ad1beb6733f54b41945ce15/compas_timber-0.14.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-17 17:01:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gramaziokohler",
"github_project": "compas_timber",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "rtree",
"specs": []
},
{
"name": "compas",
"specs": [
[
">=",
"2.0"
],
[
"<",
"3.0"
]
]
},
{
"name": "compas_model",
"specs": [
[
"==",
"0.4.4"
]
]
}
],
"lcname": "compas-timber"
}
JSON
