Skip to content
Robotic fabrication package for the COMPAS Framework
Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
docs Update cartesian example to reach 100% Oct 22, 2019
src/compas_fab merge_group_with_full_configuration typo Oct 22, 2019
temp Switch to sphinx_compas_theme for docs Aug 18, 2018
tests Update doctest and setup travis to run them Oct 20, 2019
.bumpversion.cfg Bump version to 0.7.0 Oct 20, 2019
.editorconfig Add/update boilerplate configuration Aug 2, 2018
.gitignore Switch to sphinx_compas_theme for docs Aug 18, 2018
.travis.yml Only generate docs on Linux builds Oct 21, 2019
AUTHORS.rst Update AUTHORS.rst Oct 14, 2019
CHANGELOG.rst Prepare CHANGELOG for next release Oct 20, 2019
CONTRIBUTING.rst Fixed external broken links Oct 2, 2019
ISSUE_TEMPLATE.md
LICENSE Update (c) Sep 8, 2018
MANIFEST.in Prune github files from manifest Oct 2, 2019
README.rst Add DOI badge Oct 2, 2019
pytest.ini Update doctest and setup travis to run them Oct 20, 2019
requirements-dev.txt Switch to bump2version (because bumpversion seems abandoned) Oct 2, 2019
setup.cfg Change isort setting to match main compas lib Aug 19, 2018
setup.py Bump compas & roslibpy requirements Oct 2, 2019
tasks.py Prepare pytest to run on CI Oct 20, 2019

README.rst

COMPAS FAB: Robotic Fabrication for COMPAS

Travis-CI Build Status License PyPI Package latest release Supported implementations

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, an open-source Python-based framework for collaboration and research in architecture, engineering and digital fabrication.

Main features

  • Multiple backends for simulation and execution (e.g. ROS: Robot Operating System)
  • Planning tools: kinematic solvers, path planning, etc.
  • Execution tools: feedback loops, robot control, etc.

COMPAS FAB runs on Python 2.x, 3.x and IronPython 2.7.

Getting Started

The recommended way to install COMPAS FAB is to use Anaconda/conda:

conda install -c conda-forge compas_fab

But it can also be installed using pip:

pip install compas_fab

Note

On Windows, you may need to install Microsoft Visual C++ 14.0.

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

Questions and feedback

We encourage the use of the COMPAS framework forum for questions and discussions.

Contributing

We love contributions!

Check the Contributor's Guide for more details.

Releasing this project

Ready to release a new version of COMPAS FAB? Here's how to do it:

  • We use semver, i.e. we bump versions as follows:
    • patch: bugfixes.
    • minor: backwards-compatible features added.
    • major: backwards-incompatible changes.
  • Update the CHANGELOG.rst 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 and a long list of contributors

You can’t perform that action at this time.