API reference

Core classes

• Experiment: A single computational experiment
  • Creating the results dict
  • Standard metadata elements
  • Configuring the experiment
  • Running the experiment
  • Accessing results
• ResultSet: A homogeneous collection of results from experiments
  • Adding results
  • Retrieving results
  • Parameter ranges
  • Managing pending results
  • Metadata access
  • Locking
  • Dirtiness
  • Type mapping and inference
• LabNotebook: A persistent store for results
  • Metadata access
  • Persistence
  • With blocks
  • Result sets
  • Conditional creation of result sets
  • Result storage and access
  • Pending results
  • Locking the notebook
• Lab: An environment for running experiments
  • Lab creation and management
  • Parameter management
  • Building the parameter space
  • Running experiments
  • Conditional experiments
  • Accessing results

Persistent storage

• JSONLabNotebook: A persistent store in JSON format
  • Persistence
  • JSON file access
  • Structure of the JSON file
• HDF5LabNotebook: Results stored in a standard format
  • Managing result sets
  • Persistence
  • HDF5 file access
  • Remote notebooks
  • Structure of the HDF5 file
  • HDF5 type management
  • Tuning parameters
  • Low-level protocol

Extended functionality

• ExperimentCombinator: Building experiments from experiments
  • Accessing the underlying experiment
• RepeatedExperiment: Repeating an experiment experiment
  • Performing repetitions
  • Extra metadata elements in the results dict
  • Running the experiment
• SummaryExperiment: Statistical summaries of experiments
  • Extra metadata elements in the results dict
  • Running the experiment
  • Creating and changing the summary statistics

Parallel experiments

• ParallelLab: Running experiments locally in parallel
  • Running experiments
• ClusterLab: Flexible, parallel, asynchronous experiments
  • Interacting with the cluster
  • Running experiments
  • Results management
  • Connection management
  • Tuning parameters

Experimental designs

• Design: Experimental designs
  • Creating experiments
• Standard experimental designs
  • FactorialDesign: All combinations of of parameters
  • PointwiseDesign: Corresponding parameters combined

Exceptions

• CancelledException: A result was cancelled
• ResultSetLockedException: Trying to change a locked result set
• LabNotebookLockedException: Trying to change a locked lab notebook
• PendingResultException: Unrecognised pending result job identifier
• ResultsStructureException: Badly-structured results dict (or dicts)
• NotebookVersionException: Unexpected version of a notebook file
• DesignException: Impossible design