module __init__

Short summary

module pyenbc

Module pyense. Recurrent needs for teachings turned into functions.

source on GitHub

Functions

function

truncated documentation

_setup_hook

if this function is added to the module, the help automation and unit tests call it first before anything goes on …

check

Checks the library is working. It raises an exception.

load_ipython_extension

to allow the call %load_ext pyenbc

Documentation

Module pyense. Recurrent needs for teachings turned into functions.

source on GitHub

pyenbc._setup_hook(add_print=False, unit_test=False)

if this function is added to the module, the help automation and unit tests call it first before anything goes on as an initialization step. It should be run in a separate process.

Parameters:

  • add_print – print Success: _setup_hook

  • unit_test – used only for unit testing purpose

source on GitHub

pyenbc.check(log=False)

Checks the library is working. It raises an exception.

Parameters:

log – if True, display information, otherwise

Returns:

0 or exception

source on GitHub

pyenbc.load_ipython_extension(ip)

to allow the call %load_ext pyenbc

Parameters:

ip – from get_ipython()

source on GitHub