# 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/compas-dev/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": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Gramazio Kohler Research",
"author_email": "gramaziokohler@arch.ethz.ch",
"download_url": "https://files.pythonhosted.org/packages/e6/27/64a43dd74a005f20277ffec4c625d6cabaebc4dfc7a9481be9546c8105c8/compas_timber-0.7.0.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/compas-dev/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.7.0",
"project_urls": {
"Homepage": "https://github.com/gramaziokohler/compas_timber"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1cea52086af260eb868a652ef994c5b5fc24760bbf43cd1baac4543b0bf8534b",
"md5": "379455cf306b58f4d0f12f2a5586bc0c",
"sha256": "4624f85cb5f2d79c8e01a9ecc9026396f7a42854d9cc1431d4d2ba022d97a4e3"
},
"downloads": -1,
"filename": "compas_timber-0.7.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "379455cf306b58f4d0f12f2a5586bc0c",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 205136,
"upload_time": "2024-02-15T11:33:22",
"upload_time_iso_8601": "2024-02-15T11:33:22.855068Z",
"url": "https://files.pythonhosted.org/packages/1c/ea/52086af260eb868a652ef994c5b5fc24760bbf43cd1baac4543b0bf8534b/compas_timber-0.7.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e62764a43dd74a005f20277ffec4c625d6cabaebc4dfc7a9481be9546c8105c8",
"md5": "b465c6fb6d16d5ac4f17fe74ce77f5f5",
"sha256": "61d6813e1e3d07902b5a706011b5c0395404095a51a82881ba58f857729fb802"
},
"downloads": -1,
"filename": "compas_timber-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "b465c6fb6d16d5ac4f17fe74ce77f5f5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 143596,
"upload_time": "2024-02-15T11:33:25",
"upload_time_iso_8601": "2024-02-15T11:33:25.371471Z",
"url": "https://files.pythonhosted.org/packages/e6/27/64a43dd74a005f20277ffec4c625d6cabaebc4dfc7a9481be9546c8105c8/compas_timber-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-15 11:33:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gramaziokohler",
"github_project": "compas_timber",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "compas-timber"
}
JSON
