README.md

jupyter-fireworks-proxy

Note: This package has depricated/archived because the of the lack of interest to approve the necessary changes for to the fireworks package.

This package provides an easy way to launch the webgui interface of Fireworks in a Jupyter notebook environment. Please note that the Fireworks python must be fully configured.

Requirements

• Python 3+
• Jupyter Notebook
• Fireworks

This package also contains a fireworks_luancher command which is also used internally to initialise a single-threaded interface for the webgui implementation of Fireworks.

Quick Starts

1. Use pip to install jupyter-fireworks-proxy:

pip install jupyter-fireworks-proxy

2. Start Jupyter Classic or Jupyter Lab

3. Click on the Fireworks (webgui) icon from the Jupyter Lab Launcher or the Fireworks (webgui) item from the New dropdown in Jupyter Classic.

Install jupyter-fireworks-proxy from gihub source

Note: These steps might be optional, depending on the python environment that you use.

1. Use pip to install jupyter-fireworks-proxy:

pip install git+https://github.com/modl-uclouvain/jupyter-fireworks-proxy.git

2. For Jupyter Classic, activate the jupyter-server-proxy extension:

jupyter serverextension enable --sys-prefix jupyter_server_proxy

3. For Jupyter Lab, install the @jupyterlab/server-proxy extension:

jupyter labextension install @jupyterlab/server-proxy
jupyter lab build

4. Start Jupyter Classic or Jupyter Lab

5. Click on the Fireworks (webgui) icon from the Jupyter Lab Launcher or the Fireworks (webgui) item from the New dropdown in Jupyter Classic.

Useful links:

• jupyter-server-proxy
• jupyter-server-proxy cookiecutter template.