Metadata-Version: 2.4
Name: compas_fab
Version: 1.1.4
Summary: Robotic fabrication package for the COMPAS Framework that facilitates the planning and execution of robotic fabrication processes.
Home-page: https://github.com/compas-dev/compas_fab
Author: Gramazio Kohler Research
Author-email: Romana Rust <rust@arch.ethz.ch>, Gonzalo Casas <casas@arch.ethz.ch>, Stefana Parascho <parascho@arch.ethz.ch>, David Jenny <jenny@arch.ethz.ch>, Kathrin Dörfler <doerfler@arch.ethz.ch>, Matthias Helmreich <helmreich@arch.ethz.ch>, Augusto Gandia <gandia@arch.ethz.ch>, Zhao Ma <ma@arch.ethz.ch>, Inés Ariza <ariza@arch.ethz.ch>, Matteo Pacher <pacher@arch.ethz.ch>, Beverly Lytle <lytle@arch.ethz.ch>, Yijiang Huang <yijiangh@mit.edu>, Chen Kasirer <kasirer@arch.ethz.ch>, Edvard Bruun <ebruun@princeton.edu>, Victor Pok <leung@arch.ethz.ch>
License: MIT License
        
        Copyright (c) 2018 Gramazio Kohler Research
        
        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.
        
Project-URL: Homepage, https://compas.dev/compas_fab/latest
Project-URL: Repository, https://github.com/compas-dev/compas_fab
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: compas<3,>=2.0.4
Requires-Dist: compas_robots<1,>=0.3
Requires-Dist: roslibpy<2,>=1.1
Requires-Dist: pyserial
Provides-Extra: dev
Requires-Dist: pybullet; extra == "dev"
Requires-Dist: attrs>=19.3.0; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: bump2version>=1.0.1; extra == "dev"
Requires-Dist: check-manifest>=0.36; extra == "dev"
Requires-Dist: compas-invocations2; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: importlib_metadata<5.0; extra == "dev"
Requires-Dist: invoke>=0.14; extra == "dev"
Requires-Dist: pythonnet; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest_mock; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: sphinx_compas2_theme; extra == "dev"
Requires-Dist: sybil~=8.0.1; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: tomlkit; extra == "dev"
Dynamic: author
Dynamic: home-page
Dynamic: license-file

# COMPAS FAB: Robotic Fabrication for COMPAS

[![Github Actions Build Status](https://github.com/compas-dev/compas_fab/workflows/build/badge.svg)](https://github.com/compas-dev/compas_fab/actions)
[![Github Actions Integration Status](https://github.com/compas-dev/compas_fab/workflows/integration/badge.svg)](https://github.com/compas-dev/compas_fab/actions)
[![License](https://img.shields.io/github/license/compas-dev/compas_fab.svg)](https://pypi.python.org/pypi/compas_fab)
[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/compas_fab)](https://anaconda.org/conda-forge/compas_fab)
[![pip downloads](https://img.shields.io/pypi/dm/compas_fab)](https://pypi.python.org/project/compas_fab)
[![PyPI Package latest release](https://img.shields.io/pypi/v/compas_fab.svg)](https://pypi.python.org/pypi/compas_fab)
[![Anaconda](https://img.shields.io/conda/vn/conda-forge/compas_fab.svg)](https://anaconda.org/conda-forge/compas_fab)
[![Supported implementations](https://img.shields.io/pypi/implementation/compas_fab.svg)](https://pypi.python.org/pypi/compas_fab)
[![DOI](https://zenodo.org/badge/107952684.svg)](https://zenodo.org/badge/latestdoi/107952684)
[![Twitter Follow](https://img.shields.io/twitter/follow/compas_dev?style=social)](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).
