agentlib_mpc package

Subpackages

• agentlib_mpc.data_structures package
  • Submodules
  • agentlib_mpc.data_structures.admm_datatypes module
    • ADMMParameters
      • ADMMParameters.penalty_factor
      • ADMMParameters.prediction_horizon
      • ADMMParameters.time_step
    • ADMMParticipation
      • ADMMParticipation.participating
      • ADMMParticipation.ready
      • ADMMParticipation.source
    • AgentDictEntry
      • AgentDictEntry.coup_vars
      • AgentDictEntry.exchange_vars
    • AgentToCoordinator
      • AgentToCoordinator.local_exchange_trajectory
      • AgentToCoordinator.local_trajectory
    • ConsensusVariable
      • ConsensusVariable.flat_multipliers()
      • ConsensusVariable.multipliers
      • ConsensusVariable.shift_values_by_one()
      • ConsensusVariable.update_mean_trajectory()
      • ConsensusVariable.update_multipliers()
    • CoordinatorToAgent
      • CoordinatorToAgent.exchange_multiplier
      • CoordinatorToAgent.mean_diff_trajectory
      • CoordinatorToAgent.mean_trajectory
      • CoordinatorToAgent.multiplier
      • CoordinatorToAgent.penalty_parameter
      • CoordinatorToAgent.target
    • CouplingEntry
      • CouplingEntry.admm_variables()
      • CouplingEntry.lagged
      • CouplingEntry.local
      • CouplingEntry.mean
      • CouplingEntry.multiplier
      • CouplingEntry.name
    • CouplingVariable
      • CouplingVariable.delta_mean
      • CouplingVariable.flat_locals()
      • CouplingVariable.get_residual()
      • CouplingVariable.local_trajectories
      • CouplingVariable.mean_trajectory
      • CouplingVariable.participants
      • CouplingVariable.primal_residual
    • ExchangeEntry
      • ExchangeEntry.admm_variables()
      • ExchangeEntry.lagged
      • ExchangeEntry.local
      • ExchangeEntry.mean_diff
      • ExchangeEntry.multiplier
      • ExchangeEntry.name
    • ExchangeVariable
      • ExchangeVariable.diff_trajectories
      • ExchangeVariable.multiplier
      • ExchangeVariable.shift_values_by_one()
      • ExchangeVariable.update_diff_trajectories()
      • ExchangeVariable.update_multiplier()
    • StructuredValue
      • StructuredValue.from_json()
      • StructuredValue.to_json()
    • VariableReference
      • VariableReference.all_variables()
      • VariableReference.couplings
      • VariableReference.exchange
      • VariableReference.from_config()
    • coupling_alias()
    • exchange_alias()
  • agentlib_mpc.data_structures.casadi_utils module
    • CasadiDiscretizationOptions
      • CasadiDiscretizationOptions.collocation_method
      • CasadiDiscretizationOptions.collocation_order
      • CasadiDiscretizationOptions.integrator
      • CasadiDiscretizationOptions.method
    • CollocationMethod
      • CollocationMethod.legendre
      • CollocationMethod.radau
    • Constraint
      • Constraint.function
      • Constraint.lb
      • Constraint.ub
    • DiscretizationMethod
      • DiscretizationMethod.collocation
      • DiscretizationMethod.multiple_shooting
    • Integrators
      • Integrators.cvodes
      • Integrators.euler
      • Integrators.rk
    • ModelConstraint
      • ModelConstraint.function
      • ModelConstraint.lb
      • ModelConstraint.ub
    • OptParMXContainer
      • OptParMXContainer.grid
      • OptParMXContainer.var
    • OptVarMXContainer
      • OptVarMXContainer.guess
      • OptVarMXContainer.lb
      • OptVarMXContainer.opt
      • OptVarMXContainer.ub
    • SolverFactory
      • SolverFactory.bat_file
      • SolverFactory.create_solver()
      • SolverFactory.do_jit
      • SolverFactory.logger
      • SolverFactory.make_casadi_nlp()
      • SolverFactory.name
      • SolverFactory.options
    • SolverOptions
      • SolverOptions.name
      • SolverOptions.options
    • Solvers
      • Solvers.bonmin
      • Solvers.fatrop
      • Solvers.gurobi
      • Solvers.ipopt
      • Solvers.osqp
      • Solvers.proxqp
      • Solvers.qpoases
      • Solvers.sqpmethod
    • compile_solver()
    • temporary_directory()
  • agentlib_mpc.data_structures.coordinator_datatypes module
    • AgentDictEntry
      • AgentDictEntry.name
      • AgentDictEntry.optimization_data
      • AgentDictEntry.status
    • AgentStatus
      • AgentStatus.busy
      • AgentStatus.pending
      • AgentStatus.ready
      • AgentStatus.standby
    • CoordinatorStatus
      • CoordinatorStatus.init_iterations
      • CoordinatorStatus.optimization
      • CoordinatorStatus.sleeping
      • CoordinatorStatus.updating
    • OptimizationData
      • OptimizationData.from_dict()
      • OptimizationData.to_dict()
      • OptimizationData.u
      • OptimizationData.x
    • RegistrationMessage
      • RegistrationMessage.agent_id
      • RegistrationMessage.coupling
      • RegistrationMessage.opts
      • RegistrationMessage.status
  • agentlib_mpc.data_structures.mpc_datamodels module
    • BaseVariableReference
      • BaseVariableReference.all_variables()
      • BaseVariableReference.from_config()
    • DiscretizationOptions
      • DiscretizationOptions.prediction_horizon
      • DiscretizationOptions.time_step
    • InitStatus
      • InitStatus.during_update
      • InitStatus.pre_module_init
      • InitStatus.ready
    • MHEVariableReference
      • MHEVariableReference.all_variables()
      • MHEVariableReference.estimated_inputs
      • MHEVariableReference.estimated_parameters
      • MHEVariableReference.known_inputs
      • MHEVariableReference.known_parameters
      • MHEVariableReference.measured_states
      • MHEVariableReference.outputs
      • MHEVariableReference.states
      • MHEVariableReference.weights_states
    • MINLPVariableReference
      • MINLPVariableReference.binary_controls
    • MPCVariable
      • MPCVariable.interpolation_method
    • Results
      • Results.df
    • VariableReference
      • VariableReference.controls
      • VariableReference.inputs
      • VariableReference.outputs
      • VariableReference.parameters
      • VariableReference.states
    • cia_relaxed_results_path()
    • stats_path()
  • Module contents
• agentlib_mpc.models package
  • Submodules
  • agentlib_mpc.models.ann_model module
  • agentlib_mpc.models.casadi_model module
    • CasadiInput
      • CasadiInput.alg
    • CasadiModel
      • CasadiModel.auxiliaries
      • CasadiModel.create_change_penalty()
      • CasadiModel.create_combined_objective()
      • CasadiModel.create_conditional_objective()
      • CasadiModel.create_sub_objective()
      • CasadiModel.differentials
      • CasadiModel.do_step()
      • CasadiModel.get()
      • CasadiModel.get_constraints()
      • CasadiModel.get_differential_values()
      • CasadiModel.get_initial_guess_outputs()
      • CasadiModel.get_input_values()
      • CasadiModel.initialize()
      • CasadiModel.inputs
      • CasadiModel.output_equations
      • CasadiModel.outputs
      • CasadiModel.parameters
      • CasadiModel.set_differential_values()
      • CasadiModel.set_output_values()
      • CasadiModel.setup_system()
      • CasadiModel.states
    • CasadiModelConfig
      • CasadiModelConfig.inputs
      • CasadiModelConfig.objective
      • CasadiModelConfig.outputs
      • CasadiModelConfig.parameters
      • CasadiModelConfig.states
      • CasadiModelConfig.system
      • CasadiModelConfig.model_post_init()
    • CasadiOutput
      • CasadiOutput.alg
      • CasadiOutput.json()
    • CasadiParameter
    • CasadiState
      • CasadiState.alg
      • CasadiState.json()
      • CasadiState.ode
    • CasadiVariable
      • CasadiVariable.create_sym()
      • CasadiVariable.sym
    • get_symbolic()
  • agentlib_mpc.models.casadi_model_ann module
  • agentlib_mpc.models.casadi_neural_network module
  • agentlib_mpc.models.serialized_ann module
  • Module contents
• agentlib_mpc.optimization_backends package
  • Subpackages
    • agentlib_mpc.optimization_backends.casadi_ package
      • Subpackages
      • Submodules
      • agentlib_mpc.optimization_backends.casadi_.admm module
      • agentlib_mpc.optimization_backends.casadi_.basic module
      • agentlib_mpc.optimization_backends.casadi_.casadi_admm_nn module
      • agentlib_mpc.optimization_backends.casadi_.casadi_nn module
      • agentlib_mpc.optimization_backends.casadi_.full module
      • agentlib_mpc.optimization_backends.casadi_.minlp module
      • Module contents
  • Submodules
  • agentlib_mpc.optimization_backends.backend module
    • ADMMBackend
      • ADMMBackend.coupling_grid
    • BackendConfig
      • BackendConfig.discretization_options
      • BackendConfig.model
      • BackendConfig.name
      • BackendConfig.overwrite_result_file
      • BackendConfig.results_file
      • BackendConfig.save_results
      • BackendConfig.check_csv
      • BackendConfig.check_overwrite
      • BackendConfig.disable_results_if_no_file
    • OptimizationBackend
      • OptimizationBackend.config_type
      • OptimizationBackend.get_lags_per_variable()
      • OptimizationBackend.model_from_config()
      • OptimizationBackend.mpc_backend_parameters
      • OptimizationBackend.register_logger()
      • OptimizationBackend.results_file_exists()
      • OptimizationBackend.results_folder_exists()
      • OptimizationBackend.setup_optimization()
      • OptimizationBackend.solve()
      • OptimizationBackend.update_discretization_options()
      • OptimizationBackend.update_model_variables()
  • Module contents
    • BackendImport
      • BackendImport.class_name
      • BackendImport.import_path
• agentlib_mpc.utils package
  • Subpackages
    • agentlib_mpc.utils.plotting package
      • Submodules
      • agentlib_mpc.utils.plotting.admm_animation module
      • agentlib_mpc.utils.plotting.admm_residuals module
      • agentlib_mpc.utils.plotting.basic module
      • Module contents
  • Submodules
  • agentlib_mpc.utils.analysis module
    • admm_at_time_step()
    • convert_index()
    • convert_multi_index()
    • first_vals_at_trajectory_index()
    • get_number_of_iterations()
    • get_time_steps()
    • last_vals_at_trajectory_index()
    • load_admm()
    • load_mpc()
    • load_mpc_stats()
    • load_sim()
    • mpc_at_time_step()
    • perform_index_update()
  • agentlib_mpc.utils.debug module
  • Module contents
    • is_time_in_intervals()

Module contents

Plugin for the AgentLib which contains modules for MPC, distributed MPC with ADMM and data-driven modeling.