Tutorial 1 - Models available in PyBEAM#

In this tutorial, we introduce the models available in PyBEAM. In the following Tutorial 1x’s, we disucss their usage in detail.

If you have not done so already, install pybeam. To do this, follow the directions on the PyBEAM github. Once you have done this, import PyBEAM’s precoded submodule.

[1]:

# import PyBEAM's precoded submodule
import pybeam.precoded as pbp

Currently, six model types are implemented in PyBEAM: simpleDDM, DDM, leakage, moving_threholds, UGM, and UGM_flip. These are described in detail in the PyBEAM publication and the following Tutorial 1x notebooks. More model types will be added in the future to increase PyBEAM’s functionality. Models are implemented in classes, which can be called from the PyBEAM precoded submodule. This is accomplished as follows:

[2]:

# call simpleDDM model
model_simpleDDM = pbp.simpleDDM()

# call fullDDM model
model_fullDDM = pbp.fullDDM()

# call leakage model
model_leakage = pbp.leakage()

# call changing_thresholds model
model_changing_thresholds = pbp.changing_thresholds()

# call UGM model
model_UGM = pbp.UGM()

# call UGM_flip model
model_UGM_flip = pbp.UGM_flip()

See the remaining Tutorial 1 notebooks to learn how to use these models.