# COMPAS FAB: Robotic Fabrication for COMPAS
[](https://github.com/compas-dev/compas_fab/actions)
[](https://github.com/compas-dev/compas_fab/actions)
[](https://pypi.python.org/pypi/compas_fab)
[](https://anaconda.org/conda-forge/compas_fab)
[](https://pypi.python.org/project/compas_fab)
[](https://pypi.python.org/pypi/compas_fab)
[](https://anaconda.org/conda-forge/compas_fab)
[](https://pypi.python.org/pypi/compas_fab)
[](https://zenodo.org/badge/latestdoi/107952684)
[](https://twitter.com/compas_dev)
*Robotic fabrication package for the COMPAS Framework** that facilitates the
planning and execution of robotic fabrication processes. It provides interfaces
to existing software libraries and tools available in the field of robotics
(e.g. OMPL, ROS) and makes them accessible from within the parametric design
environment. The package builds upon [COMPAS](https://compas.dev/),
an open-source Python-based framework for collaboration and research in
architecture, engineering and digital fabrication.
## Main features
* Multiple backends for simulation and execution (eg. [ROS: Robot Operating System](https://ros.org))
* Planning tools: kinematic solvers, path planning, etc.
* Execution tools: feedback loops, robot control, etc.
**COMPAS FAB** runs on Python 3.x and IronPython 2.7.
## Getting Started
The recommended way to install **COMPAS FAB** is to use [anaconda/conda](https://conda.io/docs/):
conda install -c conda-forge compas_fab
It can also be installed using `pip`:
pip install compas_fab
> On Windows, you may need to install [Microsoft Visual C++ 14.0](https://www.scivision.co/python-windows-visual-c++-14-required/).
Once the installation is completed, you can verify your setup.
Start Python from the command prompt and run the following:
>>> import compas_fab
## First Steps
* [Documentation](https://compas.dev/compas_fab/latest/)
* [COMPAS FAB Examples](https://compas.dev/compas_fab/latest/examples.html)
* [COMPAS FAB API Reference](https://compas.dev/compas_fab/latest/api.html)
* [COMPAS User Guide](https://compas.dev/compas/latest/userguide)
* [COMPAS API Reference](https://compas.dev/compas/latest/api)
## Questions and feedback
We encourage the use of the [COMPAS framework forum](https://forum.compas-framework.org/)
for questions and discussions.
## Contributing
We love contributions!
Check the [Contributor's Guide](https://github.com/compas-dev/compas_fab/blob/main/CONTRIBUTING.rst)
for more details.
## Releasing this project
Ready to release a new version of **COMPAS FAB**? Here's how to do it:
* We use [semver][https://semver.org/], ie. we bump versions as follows:
* `patch`: bugfixes.
* `minor`: backwards-compatible features added.
* `major`: backwards-incompatible changes.
* Update the `CHANGELOG.md` with all novelty!
* Ready? Release everything in one command:
invoke release [patch|minor|major]
* Celebrate! 💃
## Credits
This package is maintained by Gramazio Kohler Research [`@gramaziokohler`](https://github.com/gramaziokohler)
and a long list of [contributors](https://github.com/compas-dev/compas_fab/blob/main/AUTHORS.rst).
Raw data
{
"_id": null,
"home_page": "https://github.com/compas-dev/compas_fab",
"name": "compas-fab",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "robotic fabrication,digital fabrication,architecture,robotics,ros",
"author": "Gramazio Kohler Research",
"author_email": "gramaziokohler@arch.ethz.ch",
"download_url": "https://files.pythonhosted.org/packages/c6/78/80ed24b0b2fc597de03bbbf3668b8d698a69ee619e8dcd2587470dcf13f9/compas_fab-1.0.2.tar.gz",
"platform": null,
"description": "# COMPAS FAB: Robotic Fabrication for COMPAS\r\n\r\n[](https://github.com/compas-dev/compas_fab/actions)\r\n[](https://github.com/compas-dev/compas_fab/actions)\r\n[](https://pypi.python.org/pypi/compas_fab)\r\n[](https://anaconda.org/conda-forge/compas_fab)\r\n[](https://pypi.python.org/project/compas_fab)\r\n[](https://pypi.python.org/pypi/compas_fab)\r\n[](https://anaconda.org/conda-forge/compas_fab)\r\n[](https://pypi.python.org/pypi/compas_fab)\r\n[](https://zenodo.org/badge/latestdoi/107952684)\r\n[](https://twitter.com/compas_dev)\r\n\r\n*Robotic fabrication package for the COMPAS Framework** that facilitates the\r\nplanning and execution of robotic fabrication processes. It provides interfaces\r\nto existing software libraries and tools available in the field of robotics\r\n(e.g. OMPL, ROS) and makes them accessible from within the parametric design\r\nenvironment. The package builds upon [COMPAS](https://compas.dev/),\r\nan open-source Python-based framework for collaboration and research in\r\narchitecture, engineering and digital fabrication.\r\n\r\n\r\n## Main features\r\n\r\n* Multiple backends for simulation and execution (eg. [ROS: Robot Operating System](https://ros.org))\r\n* Planning tools: kinematic solvers, path planning, etc.\r\n* Execution tools: feedback loops, robot control, etc.\r\n\r\n**COMPAS FAB** runs on Python 3.x and IronPython 2.7.\r\n\r\n\r\n## Getting Started\r\n\r\nThe recommended way to install **COMPAS FAB** is to use [anaconda/conda](https://conda.io/docs/):\r\n\r\n conda install -c conda-forge compas_fab\r\n\r\nIt can also be installed using `pip`:\r\n\r\n pip install compas_fab\r\n\r\n\r\n> On Windows, you may need to install [Microsoft Visual C++ 14.0](https://www.scivision.co/python-windows-visual-c++-14-required/).\r\n\r\n\r\nOnce the installation is completed, you can verify your setup.\r\nStart Python from the command prompt and run the following:\r\n\r\n >>> import compas_fab\r\n\r\n\r\n## First Steps\r\n\r\n* [Documentation](https://compas.dev/compas_fab/latest/)\r\n* [COMPAS FAB Examples](https://compas.dev/compas_fab/latest/examples.html)\r\n* [COMPAS FAB API Reference](https://compas.dev/compas_fab/latest/api.html)\r\n* [COMPAS User Guide](https://compas.dev/compas/latest/userguide)\r\n* [COMPAS API Reference](https://compas.dev/compas/latest/api)\r\n\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\r\n## Contributing\r\n\r\nWe love contributions!\r\n\r\nCheck the [Contributor's Guide](https://github.com/compas-dev/compas_fab/blob/main/CONTRIBUTING.rst)\r\nfor more details.\r\n\r\n\r\n## Releasing this project\r\n\r\nReady to release a new version of **COMPAS FAB**? Here's how to do it:\r\n\r\n* We use [semver][https://semver.org/], ie. we bump versions as follows:\r\n\r\n * `patch`: bugfixes.\r\n * `minor`: backwards-compatible features added.\r\n * `major`: backwards-incompatible changes.\r\n\r\n* Update the `CHANGELOG.md` with all novelty!\r\n* Ready? Release everything in one command:\r\n\r\n invoke release [patch|minor|major]\r\n\r\n* Celebrate! \ud83d\udc83\r\n\r\n## Credits\r\n\r\nThis package is maintained by Gramazio Kohler Research [`@gramaziokohler`](https://github.com/gramaziokohler)\r\nand a long list of [contributors](https://github.com/compas-dev/compas_fab/blob/main/AUTHORS.rst).\r\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "Robotic fabrication package for the COMPAS Framework",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/compas-dev/compas_fab"
},
"split_keywords": [
"robotic fabrication",
"digital fabrication",
"architecture",
"robotics",
"ros"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5ddccdb546c2b040b1281a24a83b268e7e62774ca33e5074f450949f84359884",
"md5": "048ea2bafa065b688d3625c8d597bbab",
"sha256": "9ed08372e6e8b39c5e64b4fd000c77bb3d68b05944ca69cc792931bc7fddf12d"
},
"downloads": -1,
"filename": "compas_fab-1.0.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "048ea2bafa065b688d3625c8d597bbab",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 5035380,
"upload_time": "2024-02-22T03:28:54",
"upload_time_iso_8601": "2024-02-22T03:28:54.141347Z",
"url": "https://files.pythonhosted.org/packages/5d/dc/cdb546c2b040b1281a24a83b268e7e62774ca33e5074f450949f84359884/compas_fab-1.0.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c67880ed24b0b2fc597de03bbbf3668b8d698a69ee619e8dcd2587470dcf13f9",
"md5": "91053879f39eb95d9deadc1a720659a1",
"sha256": "73825df139a606d3b3084e99daca20838706ea352483389f3a64b84bd2fffd3f"
},
"downloads": -1,
"filename": "compas_fab-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "91053879f39eb95d9deadc1a720659a1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4939482,
"upload_time": "2024-02-22T03:28:56",
"upload_time_iso_8601": "2024-02-22T03:28:56.747488Z",
"url": "https://files.pythonhosted.org/packages/c6/78/80ed24b0b2fc597de03bbbf3668b8d698a69ee619e8dcd2587470dcf13f9/compas_fab-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-22 03:28:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "compas-dev",
"github_project": "compas_fab",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "compas-fab"
}
JSON
