Interface

Interface gives API access to all subpackages and submodules in ISF:

The recommended way to use ISF is to import Interface in a jupyter notebook in the following manner:

import Interface as I

You then have access to all important builtins and top-level pipelines via Interface:

I.get_client()              # returns a dask client
I.get_db_by_unique_id()     # returns a DataBase object
I.simrun_run_new_simulations()  # runs new simulations
...

Take a look at the Tutorials for examples on how to use the Interface API.

Functions

print_module_versions()

Print the version of each module in ISF.

get_client(ip, client_port, timeout)

Gets the distributed.client object if dask has been setup