Reference

Here is the summary of decogo modules grouped by packages. There are six packages: model, problem, pyomo_problem, solver, utility and pyomo_input_model.

Model

decogo.model.block_model	Main module for storing model data.
decogo.model.constraints	This module stores constraint data.
decogo.model.model_decomposer	This module performs automatic reformulation of the Pyomo model.
decogo.model.input_model_base	This modules implement abstract base classes of user-defined input models.

Problem

decogo.problem.approx_data	This module stores approximation data generated during the solution process.
decogo.problem.decomposed_problem	This module manages block model, approximation data and all problems.
decogo.problem.inner_master_problem	This module implements inner master problem.
decogo.problem.master_problem	This module manages inner master problems.

Pyomo MINLP input model

decogo.pyomo_input_model.input_model	This modules construct user-defined Pyomo minlp input model for refactory CG algorithm.
decogo.pyomo_input_model.subproblem	This module implements and manages all sub-problems
decogo.pyomo_input_model.master_problem_base	This module implements base class for Pyomo master problems used in MINLP primal heuristics.
decogo.pyomo_input_model.nlp_master_problem	This modules implements NLP master problem
decogo.pyomo_input_model.projection_master_problem	Implements projection master problems

Solver

decogo.solver.decogo	Main module for running the solution process
decogo.solver.colgen	This module implements Column Generation
decogo.solver.refactory_colgen	Implements Column Generation with user-defined input model
decogo.solver.oa	Implements OA algorithm for convex problems
decogo.solver.results	Stores the results obtained by the solver
decogo.solver.settings	Manages and stores solver settings

Utility

decogo.util.block_vector

Implements sparse and dense block vector data structures

Pyomo problem

decogo.pyomo_problem.master_problem_base	This module implements base class for master problems.
decogo.pyomo_problem.oa_master_problem	This module implements OA master problems
decogo.pyomo_problem.nlp_master_problem	THis module implements NLP master problem
decogo.pyomo_problem.projection_master_problem	This module implements projection master problems
decogo.pyomo_problem.pyomo_master_problem	This module manages all Pyomo master problems
decogo.pyomo_problem.pyomo_decomposed_problem	Main module for managing block model and approximation data for Pyomo models.
decogo.pyomo_problem.subproblem	This module implements and manages all sub-problems of Pyomo models