experiment_prototype package

The experiment_prototype package contains the building blocks of experiments, which includes the ExperimentPrototype base class, the scan_classes subpackage including the ScanClassBase classes, and the ExperimentException. There is also a list_tests module which is used by the ExperimentPrototype class.

Submodules

experiment_exception

This is the exception that is raised when there are problems with the experiment that cannot be remedied using experiment_prototype methods.

copyright

2018 SuperDARN Canada

author

Marci Detwiller

exception experiment_prototype.experiment_exception.ExperimentException(message, *args)[source]

Bases: Exception

Is raised for the exception where an experiment cannot be run due to setup errors.

list_tests

Basic tests for use in checking slices.

copyright

2018 SuperDARN Canada

author

Marci Detwiller

experiment_prototype.list_tests.has_duplicates(list_to_check)[source]

Check if the list has duplicate values.

Parameters

list_to_check – A list to check.

Returns

boolean True if duplicates exist, False if not.

experiment_prototype.list_tests.is_increasing(list_to_check)[source]

Check if list is increasing.

Parameters

list_to_check – a list of numbers

Returns

boolean True if is increasing, False if not.

Subpackages