Metadata-Version: 2.1
Name: compas_notebook
Version: 0.8.1
Summary: A COMPAS viewer for Jupyter notebooks based on PyThreeJS.
Author-email: tom van mele <tom.v.mele@gmail.com>
License: MIT License
        
        ETH Zurich - Block Research Group
        
        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.github.io/compas_notebook
Project-URL: Repository, https://github.com/compas-dev/compas_notebook
Keywords: compas,viewer,jupyter,notebook,pythreejs
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
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: compas >=2.4
Requires-Dist: jupyter
Requires-Dist: pythreejs
Provides-Extra: dev
Requires-Dist: attrs >=17.4 ; extra == 'dev'
Requires-Dist: black >=22.12.0 ; extra == 'dev'
Requires-Dist: bump-my-version ; extra == 'dev'
Requires-Dist: compas-invocations2 ; extra == 'dev'
Requires-Dist: invoke >=0.14 ; extra == 'dev'
Requires-Dist: ruff ; extra == 'dev'
Requires-Dist: sphinx-compas2-theme ; extra == 'dev'
Requires-Dist: twine ; extra == 'dev'
Requires-Dist: wheel ; extra == 'dev'
Provides-Extra: hpc

# COMPAS Notebook

[![GitHub - License](https://img.shields.io/github/license/compas-dev/compas_notebook.svg)](https://github.com/compas-dev/compas_notebook)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/compas-notebook.svg)](https://pypi.python.org/project/compas-notebook)
[![PyPI - Latest Release](https://img.shields.io/pypi/v/compas-notebook.svg)](https://pypi.python.org/project/compas-notebook)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/compas-dev/compas_notebook/main?urlpath/lab/tree/notebooks)

Notebook visualization backend for COMPAS using pythreejs.

## Documentation

To get started with `compas_notebook` have a look at [the documentation](https://compas.dev/compas_notebook).

## Questions and Feedback

For questions and feedback, have a look at the [COMPAS Forum](https://forum.compas-framework.org).

## Issues

If you run into problems, please file an issue on the [issue tracker](https://github.com/compas-dev/compas_notebook/issues). If we don't know it is broken, we can't fix it...

## Contributing

Guidelines for developers are under construction. However, we always accept contributions in the form of Pull Requests.

## License

`compas_notebook` is licensed under the MIT License. See [LICENSE](https://github.com/compas-dev/compas_notebook/blob/master/LICENSE), for more information.
