OpenSHA-Jupyter

OpenSHA Problem

During workshop code presentations, we would like to demonstrate the capabilities of the OpenSHA framework and want the flexibility to run specific workflows in an interactive environment.

Current Solution

There are main classes scattered throughout the OpenSHA codebase, often demonstrating the core functionality of a particular class. This requires finding the corresponding class file and execution in an IDE.

Proposed Solution

The OpenSHA-Jupyter project provides a portable dockerized solution for an interactive Jupyterlab instance where Java code can be executed with the OpenSHA framework preloaded. Demonstrations are stored directly in an external volume, making navigation of demo code easy and providing REPL flexibility. This can additionally be useful for debugging and verifying behavior in specific workflows.

Docs and Code

The Dockerfile, notebooks, Docker image, and related resources: https://github.com/abhatthal/opensha-jupyter