EPyT-Control
User Guide
Installation
Basic Usage
Custom Environments
PID Controller
Jupyter notebooks
Basic Usage
PID Control of Chlorine Injection
Pump Control
Event Detection Example
API Reference
epyt_control
EPyT-Control
Index
Index
A
|
C
|
D
|
E
|
F
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
accuracy_score() (in module epyt_control.evaluation.metrics)
Action (class in epyt_control.envs.actions.actions)
action_lower_bound (epyt_control.controllers.pid.PidController property)
action_space (epyt_control.envs.actions.actuator_state_actions.ActuatorStateAction property)
(epyt_control.envs.rl_env.RlEnv property)
action_upper_bound (epyt_control.controllers.pid.PidController property)
ActuatorStateAction (class in epyt_control.envs.actions.actuator_state_actions)
AdvancedQualityControlEnv (in module epyt_control.envs.advanced_quality_control_env)
apply() (epyt_control.envs.actions.actions.Action method)
(epyt_control.envs.actions.actuator_state_actions.PumpStateAction method)
(epyt_control.envs.actions.actuator_state_actions.ValveStateAction method)
(epyt_control.envs.actions.pump_speed_actions.PumpSpeedAction method)
(epyt_control.envs.actions.quality_actions.ChemicalInjectionAction method)
(epyt_control.envs.actions.quality_actions.SpeciesInjectionAction method)
(epyt_control.signal_processing.event_detection.event_detector.EventDetector method)
(epyt_control.signal_processing.event_detection.sensor_interpolation_detector.SensorInterpolationDetector method)
C
ChemicalInjectionAction (class in epyt_control.envs.actions.quality_actions)
compute_jacobian() (epyt_control.signal_processing.state_forecasting.mlp_surrogate.DnnStateTransitionModel method)
D
derivative_gain (epyt_control.controllers.pid.PidController property)
DnnStateTransitionModel (class in epyt_control.signal_processing.state_forecasting.mlp_surrogate)
E
EpanetControlEnv (class in epyt_control.envs.hydraulic_control_env)
EpanetMsxControlEnv (class in epyt_control.envs.advanced_quality_control_env)
epyt_control.controllers.lqr
module
epyt_control.controllers.pid
module
epyt_control.envs.actions.actions
module
epyt_control.envs.actions.actuator_state_actions
module
epyt_control.envs.actions.pump_speed_actions
module
epyt_control.envs.actions.quality_actions
module
epyt_control.envs.advanced_quality_control_env
module
epyt_control.envs.hydraulic_control_env
module
epyt_control.envs.rl_env
module
epyt_control.evaluation.evaluation
module
epyt_control.evaluation.metrics
module
epyt_control.signal_processing.event_detection.event_detector
module
epyt_control.signal_processing.event_detection.sensor_interpolation_detector
module
epyt_control.signal_processing.state_estimation.kalman_filters
module
epyt_control.signal_processing.state_estimation.smoothers
module
epyt_control.signal_processing.state_forecasting.mlp_surrogate
module
epyt_control.signal_processing.state_forecasting.surrogates
module
evaluate_policy() (in module epyt_control.evaluation.evaluation)
EventDetector (class in epyt_control.signal_processing.event_detection.event_detector)
ExtendedKalmanFilter (class in epyt_control.signal_processing.state_estimation.kalman_filters)
F
f1_micro_score() (in module epyt_control.evaluation.metrics)
f1_score() (in module epyt_control.evaluation.metrics)
fit() (epyt_control.signal_processing.event_detection.sensor_interpolation_detector.SensorInterpolationDetector method)
(epyt_control.signal_processing.state_forecasting.mlp_surrogate.DnnStateTransitionModel method)
(epyt_control.signal_processing.state_forecasting.mlp_surrogate.SimpleMlpStateTransitionModel method)
(epyt_control.signal_processing.state_forecasting.surrogates.StateTransitionModel method)
fit_to_env() (epyt_control.signal_processing.state_forecasting.surrogates.StateTransitionSurrogate method)
fit_to_scada() (epyt_control.signal_processing.state_forecasting.surrogates.HydraulicStateTransitionSurrogate method)
(epyt_control.signal_processing.state_forecasting.surrogates.StateTransitionSurrogate method)
(epyt_control.signal_processing.state_forecasting.surrogates.WaterQualityStateTransitionSurrogate method)
H
HydraulicControlEnv (in module epyt_control.envs.hydraulic_control_env)
HydraulicStateTransitionSurrogate (class in epyt_control.signal_processing.state_forecasting.surrogates)
I
init() (epyt_control.signal_processing.state_forecasting.mlp_surrogate.DnnStateTransitionModel method)
(epyt_control.signal_processing.state_forecasting.mlp_surrogate.SimpleMlpStateTransitionModel method)
(epyt_control.signal_processing.state_forecasting.surrogates.StateTransitionModel method)
init_state (epyt_control.signal_processing.state_estimation.kalman_filters.KalmanFilterBase property)
init_state_uncertainty_cov (epyt_control.signal_processing.state_estimation.kalman_filters.ExtendedKalmanFilter property)
(epyt_control.signal_processing.state_estimation.kalman_filters.KalmanFilter property)
integral_gain (epyt_control.controllers.pid.PidController property)
invert_output_scaling() (epyt_control.signal_processing.state_forecasting.mlp_surrogate.DnnStateTransitionModel method)
K
KalmanFilter (class in epyt_control.signal_processing.state_estimation.kalman_filters)
KalmanFilterBase (class in epyt_control.signal_processing.state_estimation.kalman_filters)
L
linear_quadratic_regulator() (in module epyt_control.controllers.lqr)
load_from_file() (epyt_control.signal_processing.state_forecasting.mlp_surrogate.DnnStateTransitionModel method)
M
mape() (in module epyt_control.evaluation.metrics)
mase() (in module epyt_control.evaluation.metrics)
mean_squared_error() (in module epyt_control.evaluation.metrics)
measurement_func (epyt_control.signal_processing.state_estimation.kalman_filters.ExtendedKalmanFilter property)
(epyt_control.signal_processing.state_estimation.kalman_filters.KalmanFilter property)
measurement_func_grad (epyt_control.signal_processing.state_estimation.kalman_filters.ExtendedKalmanFilter property)
measurement_uncertainty_cov (epyt_control.signal_processing.state_estimation.kalman_filters.ExtendedKalmanFilter property)
(epyt_control.signal_processing.state_estimation.kalman_filters.KalmanFilter property)
module
epyt_control.controllers.lqr
epyt_control.controllers.pid
epyt_control.envs.actions.actions
epyt_control.envs.actions.actuator_state_actions
epyt_control.envs.actions.pump_speed_actions
epyt_control.envs.actions.quality_actions
epyt_control.envs.advanced_quality_control_env
epyt_control.envs.hydraulic_control_env
epyt_control.envs.rl_env
epyt_control.evaluation.evaluation
epyt_control.evaluation.metrics
epyt_control.signal_processing.event_detection.event_detector
epyt_control.signal_processing.event_detection.sensor_interpolation_detector
epyt_control.signal_processing.state_estimation.kalman_filters
epyt_control.signal_processing.state_estimation.smoothers
epyt_control.signal_processing.state_forecasting.mlp_surrogate
epyt_control.signal_processing.state_forecasting.surrogates
MultiConfigAdvancedQualityControlEnv (in module epyt_control.envs.advanced_quality_control_env)
MultiConfigEpanetControlEnv (class in epyt_control.envs.hydraulic_control_env)
MultiConfigEpanetMsxControlEnv (class in epyt_control.envs.advanced_quality_control_env)
MultiConfigHydraulicControlEnv (in module epyt_control.envs.hydraulic_control_env)
N
node_id (epyt_control.envs.actions.quality_actions.ChemicalInjectionAction property)
O
obs_dim (epyt_control.signal_processing.state_estimation.kalman_filters.KalmanFilterBase property)
observation_space (epyt_control.envs.rl_env.RlEnv property)
P
partial_fit() (epyt_control.signal_processing.state_forecasting.mlp_surrogate.DnnStateTransitionModel method)
(epyt_control.signal_processing.state_forecasting.mlp_surrogate.SimpleMlpStateTransitionModel method)
(epyt_control.signal_processing.state_forecasting.surrogates.StateTransitionModel method)
pattern_id (epyt_control.envs.actions.quality_actions.ChemicalInjectionAction property)
PidController (class in epyt_control.controllers.pid)
precision_score() (in module epyt_control.evaluation.metrics)
predict() (epyt_control.signal_processing.state_forecasting.mlp_surrogate.DnnStateTransitionModel method)
(epyt_control.signal_processing.state_forecasting.mlp_surrogate.SimpleMlpStateTransitionModel method)
(epyt_control.signal_processing.state_forecasting.surrogates.HydraulicStateTransitionSurrogate method)
(epyt_control.signal_processing.state_forecasting.surrogates.StateTransitionModel method)
(epyt_control.signal_processing.state_forecasting.surrogates.WaterQualityStateTransitionSurrogate method)
proportional_gain (epyt_control.controllers.pid.PidController property)
pump_id (epyt_control.envs.actions.actuator_state_actions.PumpStateAction property)
(epyt_control.envs.actions.pump_speed_actions.PumpSpeedAction property)
PumpSpeedAction (class in epyt_control.envs.actions.pump_speed_actions)
PumpStateAction (class in epyt_control.envs.actions.actuator_state_actions)
R
r2_score() (in module epyt_control.evaluation.metrics)
RauchTungStriebelSmoother (class in epyt_control.signal_processing.state_estimation.smoothers)
regressor_type (epyt_control.signal_processing.event_detection.sensor_interpolation_detector.SensorInterpolationDetector property)
regressors (epyt_control.signal_processing.event_detection.sensor_interpolation_detector.SensorInterpolationDetector property)
reset() (epyt_control.envs.advanced_quality_control_env.EpanetMsxControlEnv method)
(epyt_control.envs.advanced_quality_control_env.MultiConfigEpanetMsxControlEnv method)
(epyt_control.envs.hydraulic_control_env.MultiConfigEpanetControlEnv method)
(epyt_control.envs.rl_env.RlEnv method)
(epyt_control.signal_processing.state_estimation.kalman_filters.ExtendedKalmanFilter method)
(epyt_control.signal_processing.state_estimation.kalman_filters.KalmanFilter method)
(epyt_control.signal_processing.state_estimation.kalman_filters.KalmanFilterBase method)
(epyt_control.signal_processing.state_estimation.kalman_filters.TimeVaryingExtendedKalmanFilter method)
(epyt_control.signal_processing.state_estimation.kalman_filters.TimeVaryingKalmanFilter method)
RlEnv (class in epyt_control.envs.rl_env)
roc_auc_score() (in module epyt_control.evaluation.metrics)
running_mse() (in module epyt_control.evaluation.metrics)
running_r2_score() (in module epyt_control.evaluation.metrics)
S
save_to_file() (epyt_control.signal_processing.state_forecasting.mlp_surrogate.DnnStateTransitionModel method)
SensorInterpolationDetector (class in epyt_control.signal_processing.event_detection.sensor_interpolation_detector)
SimpleMlpStateTransitionModel (class in epyt_control.signal_processing.state_forecasting.mlp_surrogate)
smape() (in module epyt_control.evaluation.metrics)
source_type_id (epyt_control.envs.actions.quality_actions.ChemicalInjectionAction property)
species_id (epyt_control.envs.actions.quality_actions.SpeciesInjectionAction property)
SpeciesInjectionAction (class in epyt_control.envs.actions.quality_actions)
speed_lower_bound (epyt_control.envs.actions.pump_speed_actions.PumpSpeedAction property)
speed_upper_bound (epyt_control.envs.actions.pump_speed_actions.PumpSpeedAction property)
state_dim (epyt_control.signal_processing.state_estimation.kalman_filters.KalmanFilterBase property)
state_transition_func (epyt_control.signal_processing.state_estimation.kalman_filters.ExtendedKalmanFilter property)
(epyt_control.signal_processing.state_estimation.kalman_filters.KalmanFilter property)
state_transition_func_grad (epyt_control.signal_processing.state_estimation.kalman_filters.ExtendedKalmanFilter property)
StateTransitionModel (class in epyt_control.signal_processing.state_forecasting.surrogates)
StateTransitionSurrogate (class in epyt_control.signal_processing.state_forecasting.surrogates)
step() (epyt_control.controllers.pid.PidController method)
(epyt_control.envs.rl_env.RlEnv method)
(epyt_control.signal_processing.state_estimation.kalman_filters.ExtendedKalmanFilter method)
(epyt_control.signal_processing.state_estimation.kalman_filters.KalmanFilter method)
(epyt_control.signal_processing.state_estimation.kalman_filters.KalmanFilterBase method)
(epyt_control.signal_processing.state_estimation.kalman_filters.TimeVaryingExtendedKalmanFilter method)
(epyt_control.signal_processing.state_estimation.kalman_filters.TimeVaryingKalmanFilter method)
(epyt_control.signal_processing.state_estimation.smoothers.RauchTungStriebelSmoother method)
(epyt_control.signal_processing.state_estimation.smoothers.TimeVaryingRauchTungStriebelSmoother method)
system_uncertainty_cov (epyt_control.signal_processing.state_estimation.kalman_filters.ExtendedKalmanFilter property)
(epyt_control.signal_processing.state_estimation.kalman_filters.KalmanFilter property)
T
target_value (epyt_control.controllers.pid.PidController property)
time_varying_lqr() (in module epyt_control.controllers.lqr)
time_window_length (epyt_control.signal_processing.state_estimation.smoothers.RauchTungStriebelSmoother property)
(epyt_control.signal_processing.state_estimation.smoothers.TimeVaryingRauchTungStriebelSmoother property)
TimeVaryingExtendedKalmanFilter (class in epyt_control.signal_processing.state_estimation.kalman_filters)
TimeVaryingKalmanFilter (class in epyt_control.signal_processing.state_estimation.kalman_filters)
TimeVaryingRauchTungStriebelSmoother (class in epyt_control.signal_processing.state_estimation.smoothers)
to_gym_action_space() (epyt_control.envs.actions.actions.Action method)
(epyt_control.envs.actions.actuator_state_actions.ActuatorStateAction method)
(epyt_control.envs.actions.pump_speed_actions.PumpSpeedAction method)
(epyt_control.envs.actions.quality_actions.ChemicalInjectionAction method)
true_negative_rate() (in module epyt_control.evaluation.metrics)
true_positive_rate() (in module epyt_control.evaluation.metrics)
U
upper_bound (epyt_control.envs.actions.quality_actions.ChemicalInjectionAction property)
V
valve_id (epyt_control.envs.actions.actuator_state_actions.ValveStateAction property)
ValveStateAction (class in epyt_control.envs.actions.actuator_state_actions)
W
WaterQualityStateTransitionSurrogate (class in epyt_control.signal_processing.state_forecasting.surrogates)