EMToolKit.examples package

Submodules

EMToolKit.examples.examples module

EMToolKit.examples.examples.example_dir()

Opens the example gallery in the web browser.

EMToolKit.examples.examples.example_run()

Main function to start the example notebook and keep it running.

EMToolKit.examples.examples.get_notebook_path(filename='EMToolKit_top_example_07252010.ipynb')

Retrieves the path to a specified Jupyter Notebook located in the package.

Parameters:

filename (str) – Name of the notebook file.

Returns:

Absolute path to the notebook.

Return type:

str

EMToolKit.examples.examples.start_jupyter_notebook(notebook_path, open_browser=True)

Launches a Jupyter Notebook using subprocess.

Parameters:

• notebook_path (str) – Path to the Jupyter Notebook file.

• open_browser (bool) – Whether to open the notebook in the browser.

Returns:

The Jupyter server process, if started successfully.

Return type:

subprocess.Popen

EMToolKit.examples.examples.stop_jupyter_notebook(process)

Stops the Jupyter server process.

Parameters:

process (subprocess.Popen) – The server process to terminate.

Module contents