Cauldron: Documentation

Gallery Documentation

Gallery Documentation

Browse Topics

Hide Topics

Documentation

Documentation

Introduction Notebook Display Shared Variables

Introduction Notebook Display Shared Variables

Introduction UI Containers Kernel Containers UI + Kernel Containers

Introduction UI Containers Kernel Containers UI + Kernel Containers

Step Tests with unittest Step Tests with pytest

Step Tests with unittest Step Tests with pytest

Introduction Parallelism (SIMD)

Introduction Parallelism (SIMD)

API Reference

API Reference

get_environment_info refresh run_project run_server run_shell shared

get_environment_info refresh run_project run_server run_shell shared

bokeh code_block elapsed head header html image inspect jinja json latex listing list_grid markdown plotly pyplot status svg table tail text whitespace

bokeh code_block elapsed head header html image inspect jinja json latex listing list_grid markdown plotly pyplot status svg table tail text whitespace

breathe render_to_console stop visible write_to_console

breathe render_to_console stop visible write_to_console

create_test_fixture StepTestRunResult StepTestCase CauldronTest

create_test_fixture StepTestRunResult StepTestCase CauldronTest

Cauldron Documentation

Before you dig into the documentation make you have Cauldron installed and ready to use:

Install Package

Cauldron is distributed as a Python package that can be installed with pip:

$ pip install cauldron-notebook

or with conda:

$ conda install -c sernst cauldron

Cauldron requires Python 3.5.3+ and recommends Python 3.7.5+ for the best experience.

Launch Cauldron

Start the Cauldron user interface from the command line with:

$ cauldron ui

Cauldron can also be run as an interactive command-line shell without the user interface. More information about that can be found in the Cauldron Github README.

Copyright © 2016-2020 Scott Ernst