https://github.com/compas-dev/compas_xr

COMPAS XR streamlines extended reality workflows to ease the implementation of human-machine collaborative applications in architectural research and educational environments.
https://github.com/compas-dev/compas_xr

aec assembly compas human-computer-interaction human-machine-interface robotics xr

Last synced: 3 months ago
JSON representation

COMPAS XR streamlines extended reality workflows to ease the implementation of human-machine collaborative applications in architectural research and educational environments.

• Host: GitHub
• URL: https://github.com/compas-dev/compas_xr
• Owner: compas-dev
• License: mit
• Created: 2020-03-16T10:33:45.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2025-06-13T16:24:34.000Z (4 months ago)
• Last Synced: 2025-06-29T04:47:47.660Z (3 months ago)
• Topics: aec, assembly, compas, human-computer-interaction, human-machine-interface, robotics, xr
• Language: Python
• Homepage: https://compas.dev/compas_xr
• Size: 109 MB
• Stars: 11
• Watchers: 15
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Authors: AUTHORS.md

Awesome Lists containing this project

README

          
# COMPAS XR

[![Github Actions Build Status](https://github.com/compas-dev/compas_xr/workflows/build/badge.svg)](https://github.com/compas-dev/compas_xr/actions)

[![License](https://img.shields.io/github/license/compas-dev/compas_xr.svg)](https://pypi.python.org/pypi/compas_xr)

[![pip downloads](https://img.shields.io/pypi/dm/compas_xr)](https://pypi.python.org/project/compas_xr)

[![PyPI Package latest release](https://img.shields.io/pypi/v/compas_xr.svg)](https://pypi.python.org/pypi/compas_xr)

[![Supported implementations](https://img.shields.io/pypi/implementation/compas_xr.svg)](https://pypi.python.org/pypi/compas_xr)

[![DOI](https://zenodo.org/badge/247674503.svg)](https://zenodo.org/doi/10.5281/zenodo.12514526)

[![Twitter Follow](https://img.shields.io/twitter/follow/compas_dev?style=social)](https://twitter.com/compas_dev)

![COMPAS XR](https://raw.githubusercontent.com/compas-dev/compas_xr/main/docs/_images/compas_xr_lead_image.png)

`COMPAS XR` streamlines extended reality workflows to ease the implementation of human-machine collaborative applications in architectural research and educational environments.

## Installation

> It is recomended you install `compas_xr` inside a virtual environment.

```bash

pip install compas_xr

```

To install `compas_xr` to Rhino run

```bash

python -m compas_rhino.install

```

## First Steps

* [Documentation](https://compas.dev/compas_xr/)

* [User guide](https://compas.dev/compas_xr/latest/userguide.html)

* [API Reference](https://compas.dev/compas_xr/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/compas-dev/compas_xr/issues).

## Contributing

We love contributions!

Check the [Contributor's Guide](https://github.com/compas-dev/compas_xr/blob/main/CONTRIBUTING.md)

for more details.

## Credits

`compas_xr` is currently developed by ETH Zurich (Gramazio Kohler Research) and Princeton University. See the [list of authors](https://github.com/compas-dev/compas_xr/blob/main/AUTHORS.md) for a complete overview.