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

def

plotly

cauldron.display.plotly()

Creates a Plotly plot in the display with the specified data and layout.

data

dict, list, typing.Any

The Plotly trace data to be plotted.

Default Value:

None

layout

dict, typing.Any

The layout data used for the plot.

Default Value:

None

scale

float

The display scale with units of fractional screen height. A value of 0.5 constrains the output to a maximum height equal to half the height of browser window when viewed. Values below 1.0 are usually recommended so the entire output can be viewed without scrolling.

Default Value:

0.5

figure

dict, typing.Any

In cases where you need to create a figure instead of separate data and layout information, you can pass the figure here and leave the data and layout values as None.

Default Value:

None

static

bool

If true, the plot will be created without interactivity. This is useful if you have a lot of plots in your notebook.

Default Value:

False

Basic Usage

01
02
03
04
05
06
07
08
09
10
11
12
13
14
15
16
import cauldron as cd
import plotly.graph_objs as go

# Create a scatter plot
scatter = go.Scatter(
  x=[1, 2, 3, 4, 5]
  y=[1, 4, 9, 16, 25]
)

# Create a layout for the scatter plot
layout = go.Layout(
  title='Quadratic Function y = x ** 2'
)

# Add the plot to the notebook display
cd.display.plotly(scatter, layout)

Examples

Basic plotting with Plotly inside Cauldron. Uses the Auto MPG dataset to create histogram, bar and scatter plots.

Copyright © 2016-2020 Scott Ernst