| Name | panopti JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | Panopti: Interactive 3D visualization in Python. |
| upload_time | 2025-07-11 06:31:52 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
3d
visualization
geometry
interactive
web
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1>
Panopti:<br>
<sub>Interactive 3D Visualization in Python</sub>
</h1>
## [ [Documentation](https://armanmaesumi.github.io/panopti/) ] - [ [PyPI](https://pypi.org/project/panopti/) ]
Panopti is a Python package for interactive 3D visualization that seamlessly supports remote development setups (e.g. through SSH). It pairs a Flask server with a React+ThreeJS frontend and is designed such that users only need to write Python code, making it painless to setup interactive experiments and scenes. All code examples and demos throughout the documentation are achieved purely using Panopti in Python -- no JavaScript required!.
Panopti supports various geometric data structures (e.g. meshes, point clouds), UI control elements (e.g. buttons, sliders, color pickers, interactive plots) that are programmable in Python, and global event callbacks (e.g. for camera movement, clicking on geometry).
Install from pip:
```
pip install panopti
```
# Simple example
First start a Panopti server in a separate terminal:
```bash
python -m panopti.run_server --host localhost --port 8080
```
Then you can easily define your scene, for example:
```python
import panopti
import trimesh # just for io
# create panopti client that connects to server:
viewer = panopti.connect(server_url="http://localhost:8080", viewer_id='client')
# viewer at: http://localhost:8080/?viewer_id=client
mesh = trimesh.load('./examples/demosthenes.obj')
verts, faces = mesh.vertices, mesh.faces
# add a mesh to the scene:
viewer.add_mesh(
vertices=verts,
faces=faces,
name="Statue"
)
def callback_button(viewer):
# Update the mesh's vertices
statue = viewer.get('Statue')
new_verts = statue.vertices * 2.0
statue.update(vertices=new_verts)
viewer.button(callback=callback_button, name='Click Me!')
viewer.hold() # prevent script from terminating
```
For more examples see [Documentation](https://armanmaesumi.github.io/panopti/examples/importing_geometry/) or `/examples`
## Installation
To install from pip:
```bash
pip install panopti
```
To install from source:
```bash
git clone https://github.com/ArmanMaesumi/panopti
# build frontend viewer
cd panopti/frontend
npm install
npm run build
cd ..
# install python package
pip install .
```
### Dependencies
Core dependencies:
```bash
pip install numpy eventlet requests flask flask-socketio python-socketio[client] tomli msgpack trimesh
```
Optional dependencies:
```bash
pip install matplotlib # for colormap utilities
pip install plotly==5.22.0 # for plotly figure support
```
Doc-related dependencies:
```bash
pip install mkdocs mkdocs-material mkdocstrings mkdocstrings-python
```
---
### Development
Details for running the local development workflow can be found in: [`/frontend/README.md`](/frontend/README.md)
#### Cite as
```bibtex
@misc{panopti,
title = {Panopti},
author = {Arman Maesumi},
note = {https://github.com/ArmanMaesumi/panopti},
year = {2025}
}
```
Raw data
{
"_id": null,
"home_page": null,
"name": "panopti",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "3D, visualization, geometry, interactive, web",
"author": null,
"author_email": "Arman Maesumi <arman.maesumi@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/fb/95/e9c0a7b61c153658e32ad34bf817ca9510efe09aa36f08ab23b32a3ab97e/panopti-0.2.0.tar.gz",
"platform": null,
"description": "<h1>\n Panopti:<br>\n <sub>Interactive 3D Visualization in Python</sub>\n</h1>\n\n\n\n## [ [Documentation](https://armanmaesumi.github.io/panopti/) ] - [ [PyPI](https://pypi.org/project/panopti/) ]\n\nPanopti is a Python package for interactive 3D visualization that seamlessly supports remote development setups (e.g. through SSH). It pairs a Flask server with a React+ThreeJS frontend and is designed such that users only need to write Python code, making it painless to setup interactive experiments and scenes. All code examples and demos throughout the documentation are achieved purely using Panopti in Python -- no JavaScript required!.\n\nPanopti supports various geometric data structures (e.g. meshes, point clouds), UI control elements (e.g. buttons, sliders, color pickers, interactive plots) that are programmable in Python, and global event callbacks (e.g. for camera movement, clicking on geometry).\n\nInstall from pip:\n```\npip install panopti\n```\n\n# Simple example\nFirst start a Panopti server in a separate terminal:\n```bash\npython -m panopti.run_server --host localhost --port 8080\n```\n\nThen you can easily define your scene, for example:\n```python\nimport panopti\nimport trimesh # just for io\n\n# create panopti client that connects to server:\nviewer = panopti.connect(server_url=\"http://localhost:8080\", viewer_id='client') \n# viewer at: http://localhost:8080/?viewer_id=client\n\nmesh = trimesh.load('./examples/demosthenes.obj')\nverts, faces = mesh.vertices, mesh.faces\n\n# add a mesh to the scene:\nviewer.add_mesh(\n vertices=verts,\n faces=faces,\n name=\"Statue\"\n)\n\ndef callback_button(viewer):\n # Update the mesh's vertices\n statue = viewer.get('Statue')\n new_verts = statue.vertices * 2.0\n statue.update(vertices=new_verts)\n\nviewer.button(callback=callback_button, name='Click Me!')\n\nviewer.hold() # prevent script from terminating\n```\nFor more examples see [Documentation](https://armanmaesumi.github.io/panopti/examples/importing_geometry/) or `/examples`\n\n## Installation\n\nTo install from pip:\n```bash\npip install panopti\n```\n\nTo install from source:\n```bash\ngit clone https://github.com/ArmanMaesumi/panopti\n\n# build frontend viewer\ncd panopti/frontend \nnpm install\nnpm run build\ncd ..\n\n# install python package\npip install .\n```\n\n### Dependencies\n\nCore dependencies:\n```bash\npip install numpy eventlet requests flask flask-socketio python-socketio[client] tomli msgpack trimesh\n```\n\nOptional dependencies:\n```bash\npip install matplotlib # for colormap utilities\npip install plotly==5.22.0 # for plotly figure support\n```\n\nDoc-related dependencies:\n```bash\npip install mkdocs mkdocs-material mkdocstrings mkdocstrings-python\n```\n\n--- \n\n### Development\n\nDetails for running the local development workflow can be found in: [`/frontend/README.md`](/frontend/README.md)\n\n#### Cite as\n\n```bibtex\n@misc{panopti,\n title = {Panopti},\n author = {Arman Maesumi},\n note = {https://github.com/ArmanMaesumi/panopti},\n year = {2025}\n}\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Panopti: Interactive 3D visualization in Python.",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://armanmaesumi.github.io/panopti/",
"Homepage": "https://github.com/armanmaesumi/panopti",
"Repository": "https://github.com/armanmaesumi/panopti"
},
"split_keywords": [
"3d",
" visualization",
" geometry",
" interactive",
" web"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c0113d6b83c5a683848989c5cb83875ad421753cbc3f66b86a27fbb8f55eb340",
"md5": "3e9e79641307e173178a0389ab942506",
"sha256": "d5a1c78113e203dc21ff5f42d0f8044d27e3614097229b12cc5039444dda6779"
},
"downloads": -1,
"filename": "panopti-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3e9e79641307e173178a0389ab942506",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8384471,
"upload_time": "2025-07-11T06:31:45",
"upload_time_iso_8601": "2025-07-11T06:31:45.653666Z",
"url": "https://files.pythonhosted.org/packages/c0/11/3d6b83c5a683848989c5cb83875ad421753cbc3f66b86a27fbb8f55eb340/panopti-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "fb95e9c0a7b61c153658e32ad34bf817ca9510efe09aa36f08ab23b32a3ab97e",
"md5": "319738d6c85d56cedc62ab1e081baba4",
"sha256": "fffd60d88408acbe02b2c711da968f7543ad705da95a6e80b1eb78d1fcdd601a"
},
"downloads": -1,
"filename": "panopti-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "319738d6c85d56cedc62ab1e081baba4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8279223,
"upload_time": "2025-07-11T06:31:52",
"upload_time_iso_8601": "2025-07-11T06:31:52.674975Z",
"url": "https://files.pythonhosted.org/packages/fb/95/e9c0a7b61c153658e32ad34bf817ca9510efe09aa36f08ab23b32a3ab97e/panopti-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-11 06:31:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "armanmaesumi",
"github_project": "panopti",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "panopti"
}
