compas-xr


Namecompas-xr JSON
Version 0.9.4 PyPI version JSON
download
home_pageNone
SummaryCOMPAS XR streamlines extended reality workflows to ease the implementation of human-machine collaborative applications in architectural research and educational environments.
upload_time2024-06-24 12:12:26
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT License Copyright (c) 2023-2024 ETH Zurich, Princeton University 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.
keywords compas xr aec robotic human-machine
VCS
bugtrack_url
requirements numpy compas compas_timber compas_eve compas_fab pyrebase4
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # COMPAS XR

[![Github Actions Build Status](https://github.com/gramaziokohler/compas_xr/workflows/build/badge.svg)](https://github.com/gramaziokohler/compas_xr/actions)
[![License](https://img.shields.io/github/license/gramaziokohler/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/gramaziokohler/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://gramaziokohler.github.io/compas_xr/)
* [User guide](https://gramaziokohler.github.io/compas_xr/latest/userguide.html)
* [API Reference](https://gramaziokohler.github.io/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/gramaziokohler/compas_xr/issues).

## Contributing

We love contributions!

Check the [Contributor's Guide](https://github.com/gramaziokohler/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/gramaziokohler/compas_xr/blob/main/AUTHORS.md) for a complete overview.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "compas-xr",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "compas, xr, aec, robotic, human-machine",
    "author": null,
    "author_email": "Joseph Kenny <kenny@arch.ethz.ch>, Daniela Mitterberger <mitterberger@princeton.edu>",
    "download_url": "https://files.pythonhosted.org/packages/e2/e5/e39120b6565c4bea2712c61119043b5716cb80e6185152c73b2ed5ba9355/compas_xr-0.9.4.tar.gz",
    "platform": null,
    "description": "# COMPAS XR\r\n\r\n[![Github Actions Build Status](https://github.com/gramaziokohler/compas_xr/workflows/build/badge.svg)](https://github.com/gramaziokohler/compas_xr/actions)\r\n[![License](https://img.shields.io/github/license/gramaziokohler/compas_xr.svg)](https://pypi.python.org/pypi/compas_xr)\r\n[![pip downloads](https://img.shields.io/pypi/dm/compas_xr)](https://pypi.python.org/project/compas_xr)\r\n[![PyPI Package latest release](https://img.shields.io/pypi/v/compas_xr.svg)](https://pypi.python.org/pypi/compas_xr)\r\n[![Supported implementations](https://img.shields.io/pypi/implementation/compas_xr.svg)](https://pypi.python.org/pypi/compas_xr)\r\n[![DOI](https://zenodo.org/badge/247674503.svg)](https://zenodo.org/doi/10.5281/zenodo.12514526)\r\n[![Twitter Follow](https://img.shields.io/twitter/follow/compas_dev?style=social)](https://twitter.com/compas_dev)\r\n\r\n![COMPAS XR](https://raw.githubusercontent.com/gramaziokohler/compas_xr/main/docs/_images/compas_xr_lead_image.png)\r\n\r\n`COMPAS XR` streamlines extended reality workflows to ease the implementation of human-machine collaborative applications in architectural research and educational environments.\r\n\r\n## Installation\r\n\r\n> It is recomended you install `compas_xr` inside a virtual environment.\r\n\r\n```bash\r\npip install compas_xr\r\n```\r\n\r\nTo install `compas_xr` 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_xr/)\r\n* [User guide](https://gramaziokohler.github.io/compas_xr/latest/userguide.html)\r\n* [API Reference](https://gramaziokohler.github.io/compas_xr/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_xr/issues).\r\n\r\n## Contributing\r\n\r\nWe love contributions!\r\n\r\nCheck the [Contributor's Guide](https://github.com/gramaziokohler/compas_xr/blob/main/CONTRIBUTING.md)\r\nfor more details.\r\n\r\n## Credits\r\n\r\n`compas_xr` is currently developed by ETH Zurich (Gramazio Kohler Research) and Princeton University. See the [list of authors](https://github.com/gramaziokohler/compas_xr/blob/main/AUTHORS.md) for a complete overview.\r\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023-2024 ETH Zurich, Princeton University  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. ",
    "summary": "COMPAS XR streamlines extended reality workflows to ease the implementation of human-machine collaborative applications in architectural research and educational environments.",
    "version": "0.9.4",
    "project_urls": {
        "Changelog": "https://github.com/gramaziokohler/compas_xr/blob/main/CHANGELOG.md",
        "Documentation": "https://gramaziokohler.github.io/compas_xr/",
        "Forum": "https://forum.compas-framework.org/",
        "Homepage": "https://github.com/gramaziokohler/compas_xr",
        "Issues": "https://github.com/gramaziokohler/compas_xr/issues",
        "Repository": "https://github.com/gramaziokohler/compas_xr.git"
    },
    "split_keywords": [
        "compas",
        " xr",
        " aec",
        " robotic",
        " human-machine"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "882374655c4817b45ab3512984fe561fbf0c5804f7202c3acf10b97cd622acad",
                "md5": "5384410c1a78111818a15c8f8da97865",
                "sha256": "4d21985abda65241a1c582c125693fd3242558a274fbe5511ffa69af604da11e"
            },
            "downloads": -1,
            "filename": "compas_xr-0.9.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5384410c1a78111818a15c8f8da97865",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 1172871,
            "upload_time": "2024-06-24T12:12:24",
            "upload_time_iso_8601": "2024-06-24T12:12:24.611941Z",
            "url": "https://files.pythonhosted.org/packages/88/23/74655c4817b45ab3512984fe561fbf0c5804f7202c3acf10b97cd622acad/compas_xr-0.9.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e2e5e39120b6565c4bea2712c61119043b5716cb80e6185152c73b2ed5ba9355",
                "md5": "bb970132189e2d7e4b332bb4b750b61c",
                "sha256": "e71757a7eb9e1fd0d34f2051dfc6e6122dc9ae29f8b3b0bb167afc7ad7c1096d"
            },
            "downloads": -1,
            "filename": "compas_xr-0.9.4.tar.gz",
            "has_sig": false,
            "md5_digest": "bb970132189e2d7e4b332bb4b750b61c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 1152989,
            "upload_time": "2024-06-24T12:12:26",
            "upload_time_iso_8601": "2024-06-24T12:12:26.821626Z",
            "url": "https://files.pythonhosted.org/packages/e2/e5/e39120b6565c4bea2712c61119043b5716cb80e6185152c73b2ed5ba9355/compas_xr-0.9.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-24 12:12:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "gramaziokohler",
    "github_project": "compas_xr",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "numpy",
            "specs": [
                [
                    "<",
                    "2"
                ],
                [
                    ">=",
                    "1.15.4"
                ]
            ]
        },
        {
            "name": "compas",
            "specs": [
                [
                    ">=",
                    "2.0.4"
                ],
                [
                    "<",
                    "3"
                ]
            ]
        },
        {
            "name": "compas_timber",
            "specs": [
                [
                    "~=",
                    "0.7.0"
                ]
            ]
        },
        {
            "name": "compas_eve",
            "specs": [
                [
                    "<",
                    "2"
                ],
                [
                    ">=",
                    "1"
                ]
            ]
        },
        {
            "name": "compas_fab",
            "specs": [
                [
                    "<",
                    "2"
                ],
                [
                    ">=",
                    "1.0.2"
                ]
            ]
        },
        {
            "name": "pyrebase4",
            "specs": [
                [
                    ">=",
                    "4.7.1"
                ]
            ]
        }
    ],
    "lcname": "compas-xr"
}
        
Elapsed time: 0.49039s