❭ API reference ❭ Interface ❭

Interface¶

Interface provides top-level API access to the In Silico Framework (ISF). It is the main entry point for users to interact with ISF, providing access to various pacakges, modules and workflows.

The primary purpose of providing these workflows, subpackages, and external dependencies through Interface is to:

1. keep the API stable

2. give the user convenient top-level access to all major workflows

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.simrun_run_new_simulations()  # runs new simulations
>>> I.db_init_simrun_general()      # initialize a database with simrun results
>>> I.scp                           # access the single_cell_parser package
...

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

Functions¶

Attributes¶