Introduction

PyProBE Structure

Below is a flowchart of how a PyProBE Cell object is structured and how the stored data can be filtered:

All data is stored in a Cell object, which contains an info attribute for storing metadata and a procedure dictionary for storing data for the experimental procedures run on the cell. These can be further filtered as described in the Filtering section of the user guide.

Once the data is filtered, it can be processed further with a method in the analysis module or displayed using the built-in plot module. All filters produce objects that are compatible with the plotting module, making it easy to visualise the data at any stage of the analysis. Additionally, all methods in the analysis module produce a Result which can be an input to further methods. This is summarised in the flowchart below:

This documentation

These docs are generated from the continuous development branch (main) of the PyProBE repository. If you are using a particular release of PyProBE, you can generate the docs specific to your release locally by running the following commands:

cd PyProBE/docs
make html

Then navigate to PyProBE/docs/build/html/ and open index.html in your web browser.