eradiate.notebook#

Notebook support components.

eradiate.notebook.install(*extensions)[source]#

Install notebook helpers.

Parameters:

*extensions (str) – Extensions to activate. Available extensions (all are active if this parameter is unset):

  • kernel_logging: Route kernel logs through standard logging facilities. Progress display uses tqdm.

  • rich_pretty: Install rich.pretty with default configuration to the current Python REPL.

  • rich_traceback: Install rich.traceback with default configuration to the current Python REPL.

eradiate.notebook.load_ipython_extension(ipython)[source]#

The Eradiate notebook extension.

This extension simply calls the eradiate.notebook.install() function.

Notes

This extension should be loaded using the IPython magic:

%load_ext eradiate

eradiate.notebook.tutorials#

Extensions and helpers for tutorials.

eradiate.notebook.tutorials.load_ipython_extension(ipython)[source]#

IPython extension for Eradiate tutorials. Should be loaded at the top of the tutorial notebook.

It sets the Matplotlib style and prints the current date and Eradiate version as markdown.

Notes

This extension should be loaded using the IPython magic:

%load_ext eradiate.notebook.tutorials
eradiate.notebook.tutorials.plot_sigma_t(*atmospheres, labels=None, altitude_extent=None, si=None, show=True)[source]#

Display the extinction coefficient of one or several atmosphere objects for a single spectral context.

Parameters:
  • *atmospheres (AbstractHeterogeneousAtmosphere) – One or several atmosphere objects for which to plot the extinction coefficient.

  • labels (list of strings, optional) – Labels associated with the passed atmosphere objects. If unset, no legend will be added to the plot.

  • altitude_extent (tuple of float) – A (min, max) altitude pair (in km) to which the plot is restricted.

  • si (SpectralIndex, optional) – The spectral index at which the extinction coefficient is evaluated. If unset, a default spectral index is created using SpectralIndex.new().

  • show (bool, optional) – If True, return None and display the plot. Otherwise, return a (Figure, Axes) pair.