# jupyter-trame-proxy
Integrates [trame](https://github.com/Kitware/trame) in your Jupyter environment using [ParaView Visualizer](https://github.com/Kitware/paraview-visualizer).
## Requirements
- Python **3.9+**
- ParaView **5.10+**
- Jupyter Notebook 6.0+
- JupyterLab 2.1+
This extension will start the `pv_visualizer` package. You must make sure it is on the PYTHONPATH! Adjust [launch_trame.sh](jupyter_trame_proxy/share/launch_trame.sh) to ensure this.
## Install
#### Create and Activate Environment
```
virtualenv -p python3 venv
source venv/bin/activate
```
#### Install jupyter-trame-proxy
```
pip install git+https://github.com/jwindgassen/jupyter-trame-proxy.git
```
#### Enable jupyter-trame-proxy Extensions
For Jupyter Classic, activate the jupyter-server-proxy extension:
```
jupyter serverextension enable --sys-prefix jupyter_server_proxy
```
For Jupyter Lab, install the @jupyterlab/server-proxy extension:
```
jupyter labextension install @jupyterlab/server-proxy
jupyter lab build
```
## Starting
Click on the *ParaView trame* icon from the Jupyter Lab Launcher or the *ParaView trame* item from the new dropdown in Jupyter Classic.
### Jupyter-Server-Proxy
[Jupyter-Server-Proxy](https://jupyter-server-proxy.readthedocs.io) lets you run arbitrary external processes alongside your notebook and provide web access to them. After installing this proxy, you can start trame using the *ParaView trame* entry in the launcher. It will start the server (which might take a few seconds) and open the website in a new tab.
## License
This software is provided under the BSD 3-Clause
Raw data
{
"_id": null,
"home_page": "https://github.com/jwindgassen/jupyter-trame-proxy",
"name": "jupyter-trame-proxy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "jupyter,trame,paraview,jupyterhub,jupyter-server-proxy",
"author": "Jonathan Windgassen",
"author_email": "j.windgassen@fz-juelich.de",
"download_url": "https://files.pythonhosted.org/packages/a7/0b/ba7358214dc3f9f6f65b94bc1fbd566bd38b3a4139bee28ef3c8358ca45c/jupyter-trame-proxy-0.2.0.tar.gz",
"platform": null,
"description": "# jupyter-trame-proxy\nIntegrates [trame](https://github.com/Kitware/trame) in your Jupyter environment using [ParaView Visualizer](https://github.com/Kitware/paraview-visualizer). \n\n## Requirements\n- Python **3.9+**\n- ParaView **5.10+**\n- Jupyter Notebook 6.0+\n- JupyterLab 2.1+\n\nThis extension will start the `pv_visualizer` package. You must make sure it is on the PYTHONPATH! Adjust [launch_trame.sh](jupyter_trame_proxy/share/launch_trame.sh) to ensure this.\n\n## Install \n\n#### Create and Activate Environment\n```\nvirtualenv -p python3 venv\nsource venv/bin/activate\n```\n\n#### Install jupyter-trame-proxy\n```\npip install git+https://github.com/jwindgassen/jupyter-trame-proxy.git\n```\n\n#### Enable jupyter-trame-proxy Extensions\nFor Jupyter Classic, activate the jupyter-server-proxy extension:\n```\njupyter serverextension enable --sys-prefix jupyter_server_proxy\n```\n\nFor Jupyter Lab, install the @jupyterlab/server-proxy extension:\n```\njupyter labextension install @jupyterlab/server-proxy\njupyter lab build\n```\n\n## Starting\nClick on the *ParaView trame* icon from the Jupyter Lab Launcher or the *ParaView trame* item from the new dropdown in Jupyter Classic. \n\n### Jupyter-Server-Proxy\n[Jupyter-Server-Proxy](https://jupyter-server-proxy.readthedocs.io) lets you run arbitrary external processes alongside your notebook and provide web access to them. After installing this proxy, you can start trame using the *ParaView trame* entry in the launcher. It will start the server (which might take a few seconds) and open the website in a new tab.\n\n## License\nThis software is provided under the BSD 3-Clause\n",
"bugtrack_url": null,
"license": "",
"summary": "ParaView trame proxy for JupyterLab",
"version": "0.2.0",
"split_keywords": [
"jupyter",
"trame",
"paraview",
"jupyterhub",
"jupyter-server-proxy"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "28a1d2486abad4d7143c6cecf6e50829",
"sha256": "c2aa54b8a8af88d921d15d3947ff46c08929a924492b6141c939f3af5a345687"
},
"downloads": -1,
"filename": "jupyter_trame_proxy-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "28a1d2486abad4d7143c6cecf6e50829",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 6747,
"upload_time": "2022-12-06T17:37:59",
"upload_time_iso_8601": "2022-12-06T17:37:59.806086Z",
"url": "https://files.pythonhosted.org/packages/12/9c/9dc749091ae9ff12a506548b19f11f1e3a97ffd36a33cc70c30da6e9a0aa/jupyter_trame_proxy-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "c556ce8c435459312328a7f70fb2395a",
"sha256": "6037ee3929427a5e4a907a28c2faf53797df31a90ca780676a0f7c3447d12170"
},
"downloads": -1,
"filename": "jupyter-trame-proxy-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "c556ce8c435459312328a7f70fb2395a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 6201,
"upload_time": "2022-12-06T17:38:01",
"upload_time_iso_8601": "2022-12-06T17:38:01.285295Z",
"url": "https://files.pythonhosted.org/packages/a7/0b/ba7358214dc3f9f6f65b94bc1fbd566bd38b3a4139bee28ef3c8358ca45c/jupyter-trame-proxy-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-06 17:38:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "jwindgassen",
"github_project": "jupyter-trame-proxy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "jupyter-trame-proxy"
}
JSON
