|
1 |
| -Jupyter ThreeJS Widget |
2 |
| -====================== |
| 1 | +# Jupyter ThreeJS Widget |
3 | 2 |
|
4 |
| -Interactive Threejs widget for the Jupyter notebook |
| 3 | +[![Interactive demo on Binder][binder-badge]][binder] |
| 4 | +[![Install from PyPI][pypi-badge]][pypi] |
| 5 | +[![Install from conda-forge][cf-badge]][cf] |
| 6 | +[![Reuse from npm][npm-badge]][npm] |
| 7 | +[![Documentation Status][docs-badge]][docs] |
| 8 | +[![Build Status][ci-badge]][ci] |
| 9 | + |
| 10 | +Interactive ThreeJS widgets for the Jupyter Notebook Classic and JupyterLab |
| 11 | + |
| 12 | +![Screencast] |
| 13 | + |
| 14 | +[binder-badge]: https://mybinder.org/badge_logo.svg |
| 15 | +[binder]: https://mybinder.org/v2/gh/jupyter-widgets/pythreejs/HEAD?urlpath=lab%2Ftree%2Fexamples%2FExamples.ipynb |
| 16 | +[pypi-badge]: https://img.shields.io/pypi/v/pythreejs?logo=pypi |
| 17 | +[pypi]: https://pypi.org/project/pythreejs |
| 18 | +[cf-badge]: https://img.shields.io/conda/vn/conda-forge/pythreejs?logo=conda-forge |
| 19 | +[cf]: https://anaconda.org/conda-forge/pythreejs |
| 20 | +[npm-badge]: https://img.shields.io/npm/v/jupyter-threejs?logo=npm |
| 21 | +[npm]: https://www.npmjs.com/package/jupyter-threejs |
| 22 | +[docs-badge]: https://readthedocs.org/projects/pythreejs/badge/?version=stable |
| 23 | +[docs]: https://pythreejs.readthedocs.io/en/stable |
| 24 | +[ci-badge]: https://github.com/jupyter-widgets/pythreejs/actions/workflows/ci.yml/badge.svg |
| 25 | +[ci]: https://github.com/jupyter-widgets/pythreejs/actions/workflows/ci.yml?query=branch%3Amaster |
| 26 | +[widgets]: https://jupyter.org/widgets |
| 27 | +[screencast]: https://raw.githubusercontent.com/jupyter-widgets/pythreejs/master/screencast.gif |
5 | 28 |
|
6 | 29 | The reference Python backend, `pythreejs` is available
|
7 |
| -[here](https://github.com/jupyter-widgets/pythreejs), with examples. |
| 30 | +[here](https://github.com/jupyter-widgets/pythreejs), with examples. Install it |
| 31 | +with: |
8 | 32 |
|
9 |
| -Package Install |
10 |
| ---------------- |
| 33 | +```bash |
| 34 | +pip install pythreejs |
| 35 | +``` |
11 | 36 |
|
12 |
| -**Prerequisites** |
13 |
| -- [node](http://nodejs.org/) |
| 37 | +or |
| 38 | + |
| 39 | +```bash |
| 40 | +conda install -c conda-forge pythreejs |
| 41 | +``` |
| 42 | + |
| 43 | +## Development Install |
| 44 | + |
| 45 | +### Prerequisites |
| 46 | + |
| 47 | +- [nodejs](http://nodejs.org/) |
14 | 48 |
|
15 | 49 | ```bash
|
16 | 50 | npm install --save jupyter-threejs
|
17 | 51 | ```
|
| 52 | + |
| 53 | +`yarn`, or the JupyterLab-bundled version `jlpm`, may be also be used. |
| 54 | + |
| 55 | +```bash |
| 56 | +yarn add jupyter-threejs |
| 57 | +jlpm add jupyter-threejs |
| 58 | +``` |
| 59 | + |
| 60 | +For more information, see the [contributing guide][contributing]. |
| 61 | + |
| 62 | +[contributing]: https://github.com/jupyter-widgets/pythreejs/blob/master/CONTRIBUTING.md |
0 commit comments