Metadata-Version: 2.1
Name: jupyter-trame-proxy
Version: 0.1.0
Summary: ParaView trame proxy for JupyterLab
Home-page: https://github.com/jwindgassen/jupyter-trame-proxy
Download-URL: https://github.com/jwindgassen/jupyter-trame-proxy/archive/v0.1.0.tar.gz
Author: Jonathan Windgassen
Author-email: j.windgassen@fz-juelich.de
Keywords: jupyter,trame,paraview,jupyterhub,jupyter-server-proxy
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Framework :: Jupyter
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jupyter-server-proxy (>=3.1.0)

# 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.  

### Security
In the current state, trame will launch an **unprotected, open website** on a local port. On multi-user machines, your data will be visible to anyone!!

### 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
