API reference

This page provides an auto-generated summary of linopy’s API.

Creating a model

model.Model([solver_dir, chunk, ...])	Linear optimization model.
model.Model.add_variables([lower, upper, ...])	Assign a new, possibly multi-dimensional array of variables to the model.
model.Model.add_constraints(lhs[, sign, ...])	Assign a new, possibly multi-dimensional array of constraints to the model.
model.Model.add_objective(expr[, overwrite, ...])	Add an objective function to the model.
model.Model.add_piecewise_formulation(*pairs)	Add piecewise linear constraints.
piecewise.breakpoints([values, slopes, ...])	Create a breakpoint DataArray for piecewise linear constraints.
piecewise.segments(values, *[, dim])	Create a segmented breakpoint DataArray for disjunctive piecewise constraints.
piecewise.tangent_lines(x, x_points, y_points)	Compute tangent-line (chord) expressions for a piecewise linear function.
model.Model.linexpr(*args)	Create a linopy.LinearExpression from argument list.
model.Model.remove_constraints(name)	Remove all constraints stored under reference name 'name' from the model.
model.Model.copy([include_solution, deep])	Return a copy of this model.

Classes under the hook

Variable

Variable is a subclass of xarray.DataArray and contains all labels referring to a multi-dimensional variable.

variables.Variable(data, model, name[, ...])	Variable container for storing variable labels.
variables.Variable.lower	Get the lower bounds of the variables.
variables.Variable.upper	Get the upper bounds of the variables.
variables.Variable.sum([dim])	Sum the variables over all or a subset of dimensions.
variables.Variable.where(cond[, other])	Filter variables based on a condition.
variables.Variable.sanitize()	Sanitize variable by ensuring int dtype with fill value of -1.
variables.Variables(data, model[, ...])	A variables container used for storing multiple variable arrays.
variables.ScalarVariable(label, model)	A scalar variable container.

Variables

Variables is a container for multiple N-D labeled variables. It is automatically added to a Model instance when initialized.

variables.Variables(data, model[, ...])	A variables container used for storing multiple variable arrays.
variables.Variables.add(variable)	Add a variable to the variables container.
variables.Variables.remove(name)	Remove variable name from the variables.
variables.Variables.continuous	Get all continuous variables.
variables.Variables.integers	Get all integers variables.
variables.Variables.binaries	Get all binary variables.
variables.Variables.integers	Get all integers variables.
variables.Variables.flat	Convert all variables to a single pandas Dataframe.

LinearExpressions

expressions.LinearExpression(data, model)	A linear expression consisting of terms of coefficients and variables.
expressions.LinearExpression.sum([dim, ...])	Sum the expression over all or a subset of dimensions.
expressions.LinearExpression.where(cond[, other])	Filter variables based on a condition.
expressions.LinearExpression.groupby(group)	Returns a LinearExpressionGroupBy object for performing grouped operations.
expressions.LinearExpression.rolling([dim, ...])	Rolling window object.
expressions.LinearExpression.from_tuples(*tuples)	Create a linear expression by using tuples of coefficients and variables.
expressions.merge(exprs, *add_exprs[, dim, ...])	Merge multiple expression together.
expressions.ScalarLinearExpression(coeffs, ...)	A scalar linear expression container.

Constraint

Constraint is a subclass of xarray.DataArray and contains all labels referring to a multi-dimensional constraint.

constraints.Constraint(data, model[, name, ...])	Projection to a single constraint in a model.
constraints.Constraint.coeffs	Get the left-hand-side coefficients of the constraint.
constraints.Constraint.vars	Get the left-hand-side variables of the constraint.
constraints.Constraint.lhs	Get the left-hand-side linear expression of the constraint.
constraints.Constraint.sign	Get the signs of the constraint.
constraints.Constraint.rhs	Get the right hand side constants of the constraint.
constraints.Constraint.flat	Convert the constraint to a pandas DataFrame.

Constraints

constraints.Constraints(data, model[, ...])	A constraint container used for storing multiple constraint arrays.
constraints.Constraints.add(constraint)	Add a constraint to the constraints constrainer.
constraints.Constraints.remove(name)	Remove constraint name from the constraints.
constraints.Constraints.coefficientrange	Coefficient range of the constraint.
constraints.Constraints.inequalities	Get the subset of constraints which are purely inequalities.
constraints.Constraints.equalities	Get the subset of constraints which are purely equalities.
constraints.Constraints.sanitize_missings()	Set constraints labels to -1 where all variables in the lhs are missing.
constraints.Constraints.flat	Convert all constraint to a single pandas Dataframe.
constraints.Constraints.to_matrix([...])	Construct a constraint matrix in sparse format.

IO functions

model.Model.get_problem_file([io_api])	Get a fresh created problem file if problem file is None.
model.Model.get_solution_file()	Get a fresh created solution file if solution file is None.
model.Model.to_file(fn[, io_api, ...])	Write out a model to a lp or mps file.
model.Model.to_netcdf(*args, **kwargs)	Write out the model to a netcdf file.
io.read_netcdf(path, **kwargs)	Read in a model from a netcdf file.

Solver utilities

solvers.available_solvers	Built-in mutable sequence.
solvers.quadratic_solvers	Built-in mutable sequence.
solvers.Solver(**solver_options)	Abstract base class for solving a given linear problem.

Solvers

solvers.CBC(**solver_options)	Solver subclass for the CBC solver.
solvers.Cplex(**solver_options)	Solver subclass for the Cplex solver.
solvers.GLPK(**solver_options)	Solver subclass for the GLPK solver.
solvers.Gurobi(**solver_options)	Solver subclass for the gurobi solver.
solvers.Highs(**solver_options)	Solver subclass for the HiGHS solver.
solvers.Mosek(**solver_options)	Solver subclass for the Mosek solver.
solvers.SCIP(**solver_options)	Solver subclass for the SCIP solver.
solvers.Xpress(**solver_options)	Solver subclass for the xpress solver.

Solving

model.Model.solve([solver_name, io_api, ...])	Solve the model with possibly different solvers.
constants.SolverStatus(value[, names, ...])	Solver status.
constants.TerminationCondition(value[, ...])	Termination condition of the solver.
constants.Status(status, termination_condition)	Status and termination condition of the solver.
constants.Solution([primal, dual, objective])	Solution returned by the solver.
constants.Result(status[, solution, ...])	Result of the optimization.