cloudpendulumclient.data

Functions

`actuator_from_list`(lst)	Convert from a list of data to an Actuator.
`actuator_to_list`(actuator)	Convert from an Actuator to a list of data.
`actuator_types`()
`clamp_limits`(limits, clamp)
`progress_info_from_list`(lst)
`progress_info_to_list`(pi)
`safety_limits_from_list`(lst)	Convert from a list of data to a SafetyLimits.
`safety_limits_to_list`(limits)	Convert from a SafetyLimits to a list of data.
`safety_limits_types`()
`user_info_from_list`(lst)	Convert from a list of data to a UserInfo.
`user_info_to_list`(user_info)	Convert from a UserInfo to a list of data.
`user_info_types`()

Classes

`Actuator`(name, active, limits)	Information about an actuator, specific to a certain experiment type.
`CellType`(value[, names, module, qualname, ...])	The type of hardware in a cell.
`ProgressInfo`(queue_position, cells_booked, ...)	Information about the progress of an operation
`SafetyLimits`(pos_max, vel_max, torque_max, ...)
`UserInfo`(user_name, max_experiment_length, ...)	Information about a user token.

class cloudpendulumclient.data.CellType(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

The type of hardware in a cell. Each experiment type can only run on one specific CellType, but each CellType can support multiple types of experiments.

SINGLE = 1

DOUBLE = 2

MOTOR = 3

COUPLEDOSCILATOR = 4

class cloudpendulumclient.data.UserInfo(user_name: str, max_experiment_length: int, number_of_attempts: int, max_bucket_size: int, bucket_size: int, refill_interval: int, max_gym_length: int, gym_max_bucket_size: int, gym_bucket_size: int, gym_refill_interval: int, valid_from: str, valid_until: str, experiment_types: [<class 'str'>])

Information about a user token. Used for querying the permissions for the user on the Cloud Pendulum Server.

user_name: str

max_experiment_length: int

number_of_attempts: int

max_bucket_size: int

bucket_size: int

refill_interval: int

max_gym_length: int

gym_max_bucket_size: int

gym_bucket_size: int

gym_refill_interval: int

valid_from: str

valid_until: str

experiment_types: [<class 'str'>]

__init__(user_name: str, max_experiment_length: int, number_of_attempts: int, max_bucket_size: int, bucket_size: int, refill_interval: int, max_gym_length: int, gym_max_bucket_size: int, gym_bucket_size: int, gym_refill_interval: int, valid_from: str, valid_until: str, experiment_types: [<class 'str'>]) → None

cloudpendulumclient.data.user_info_from_list(lst: list[Any]) → UserInfo: Convert from a list of data to a UserInfo. Used to convert from the data received from the CloudPendulum server.

cloudpendulumclient.data.user_info_to_list(user_info: UserInfo) → list[Any]: Convert from a UserInfo to a list of data. Used to serialize a UserInfo before sending it to a client.

cloudpendulumclient.data.user_info_types() → list[type]

class cloudpendulumclient.data.SafetyLimits(pos_max: float, vel_max: float, torque_max: float, kp_max: float, kd_max: float, vel_avg_max: float, torque_avg_max: float)

pos_max: float

vel_max: float

torque_max: float

kp_max: float

kd_max: float

vel_avg_max: float

torque_avg_max: float

__init__(pos_max: float, vel_max: float, torque_max: float, kp_max: float, kd_max: float, vel_avg_max: float, torque_avg_max: float) → None

cloudpendulumclient.data.safety_limits_from_list(lst: list[Any]) → SafetyLimits: Convert from a list of data to a SafetyLimits. Used to convert from the data received from the CloudPendulum server.

cloudpendulumclient.data.safety_limits_to_list(limits: SafetyLimits) → list[Any]: Convert from a SafetyLimits to a list of data. Used to serialize before sending it to a client.

cloudpendulumclient.data.safety_limits_types() → list[type]

cloudpendulumclient.data.clamp_limits(limits: SafetyLimits, clamp: SafetyLimits) → SafetyLimits

class cloudpendulumclient.data.Actuator(name: str, active: bool, limits: SafetyLimits)

Information about an actuator, specific to a certain experiment type.

name: str

active: bool

limits: SafetyLimits

__init__(name: str, active: bool, limits: SafetyLimits) → None

cloudpendulumclient.data.actuator_from_list(lst: list[Any]) → Actuator: Convert from a list of data to an Actuator. Used to convert from the data received from the CloudPendulum server.

cloudpendulumclient.data.actuator_to_list(actuator: Actuator) → list[Any]: Convert from an Actuator to a list of data. Used to serialize before sending it to a client.

cloudpendulumclient.data.actuator_types() → list[type]

class cloudpendulumclient.data.ProgressInfo(queue_position: int, cells_booked: int, wait_time: int)

Information about the progress of an operation

queue_position: int

cells_booked: int

wait_time: int

__init__(queue_position: int, cells_booked: int, wait_time: int) → None

cloudpendulumclient.data.progress_info_from_list(lst: list[Any]) → ProgressInfo

cloudpendulumclient.data.progress_info_to_list(pi: ProgressInfo) → list[Any]