swernst/cauldron repository overview

Cauldron supports running in docker containers for both local and remote workflows. There are 6 officially supported docker images:

• standard: Runs the Cauldron remote kernel (no user-interface) from a Python 3.x distribution in an Ubuntu environment.
• ui-standard: Runs the Cauldron Web-based UI and local kernel (or connect to a remote kernel) from a Python 3.x distribution in an Ubuntu environment
• conda: Runs the Cauldron remote kernel (no user-interface) from a full Anaconda distribution of Python 3.x built upon Anaconda's official docker image.
• ui-conda: Runs the Cauldron Web-based UI and local kernel (or connect to a remote kernel) from a full Anaconda distribution of Python 3.x built upon Anaconda's official docker image.
• miniconda: Runs the Cauldron remote kernel (no user-interface) from a slimmed-down mini Anaconda distribution of Python 3.x built upon Anaconda's official docker image.
• ui-miniconda: Runs the Cauldron Web-based UI and local kernel (or connect to a remote kernel) from a slimmed-down mini Anaconda distribution of Python 3.x built upon Anaconda's official docker image.

In all three cases, Cauldron is pre-installed with dependencies and the default command for each container is to start the Cauldron kernel or UI on a default exposed port (that can be overridden by the --port flag). By default the kernel containers will start on port 5010 and the UI containers web-interface will start on port 8899. A Cauldron kernel can be started with the command:

$ docker run -d --rm -p 5010:5010 swernst/cauldron:latest-standard

After the container starts, you can access the kernel through the exposed 5010 port. And a Cauldron UI can be started with the command:

$ docker run -d --rm -p 8899:8899 swernst/cauldron:latest-ui-standard

After the UI container starts, you can access the web-based UI in a browser from your http://localhost:8899⁠ localhost.

The Cauldron command shell also allows you drive the kernel without a UI by connecting to it from a locally running Cauldron shell. To do this, you use the connect command:

<>: connect http://127.0.0.1:5010

Once connected, all shell commands you issue, e.g. opening a project, will be relayed to the kernel. All project files will be synchronized between the local environment and the kernel's environment. This means you can interact with a local project exactly like you normally would, but all of the execution will happen in the kernel's environment, not your local one.

For more information visit:

• Official site http://www.unnotebook.com⁠
• Github: https://www.github.com/sernst/cauldron⁠