/roundtrip

Primary LanguageJavaScriptMIT LicenseMIT

Roundtrip

A python/javascript library for loading and managing Javascript code and visualization in Jupyter notebook cells.

This library supports:

  • Loading HTML, CSS, and JavaScript Files
  • Loading Webpack-Generated Files
  • Passing Jupyter-scoped data into Javascript code
  • Returnng Javascript generated data back to the calling Jupyter Notebook
  • Binding data between a Jupyter notebook and embedded Javascript visualizations
  • Automatic updating of bound visualizations enabling:
    • fluid gui-scripting based workflows
    • linked views across cells

Important Links

Try It Out

  1. Install Jupyter notebook, Node.js & NPM
  2. Clone this repository:
git clone https://github.com/hdc-arizona/roundtrip.git
  1. Run the automatic installer:
cd roundtrip
pip3 install roundtrip-lib
chmod +x build_examples.sh
./build_examples.sh
  1. Start a jupyter server from the roundtrip base directory:
jupyter notebook
  1. From your web browser navigate to the docs/examples/ folder and open the Manual Workflow Example notebook.

On load, you may need to clean the output by running Restart & Clear Output from the Kernel menu in Jupyter.

Running the cells in the first example will demonstrate:

  1. The loading of a real pandas dataset into a javascript visualization
  2. Interaction with the visualization
  3. Returning data back from the visualization to the Jupyter notebook

Once you understand the functionality in this notebook please open the Advanced Workflow Example

Running the cells in this example will demonstrate:

  1. The ? operator and how it links python data with visualization data
  2. How the ? can provide linked-view functionality between cells
  3. How the linking of data and automatic updating of cells can be easily turned off by removing the ?
  4. How cells update when data is update inside the jupyter notebook as well as in the visualizations

License

Roundtrip is distributed under the terms of the MIT license.

All contributions must be made under the MIT license. Copyrights in the Roundtrip project are retained by contributors. No copyright assignment is required to contribute to Roundtrip.

See LICENSE and NOTICE for details.

SPDX-License-Identifier: MIT

Acknowledgements

This work has been supported by the Department of Energy under DE-SC0022044, the United States Department of Defense through DTIC Contract FA8075-14-D-0002-0007, the National Science Foundation under NSF III-1656958.