Package Documentation

Subpackages

Submodules

hynet.config module

hynet package configuration.

param GENERAL:

General settings.

parallelize: (bool)

Enable or disable parallel processing in hynet. If True, certain procedures (e.g., the construction of constraint matrices for the OPF formulation) are parallelized if the system features more than one CPU.
type GENERAL:

dict
param OPF:

Optimal power flow settings.

pathological_price_profile_info: (bool)

Enable or disable the output of information about pathological price profiles under the hybrid architecture in the OPF summary. See also OPFResult and Scenario.verify_hybrid_architecture_conditions.
type OPF:

dict
param DISTRIBUTED:
 

Settings for distributed computation.

default_port: (int)

Default optimization server TCP port.

default_authkey: (str)

Default optimization server authentication key.

default_num_workers: (int)

Default number of worker processes on an optimization client.

ssh_command: (str)

Command to run SSH on the local machine.

python_command: (str)

Command to run Python on client machines.
type DISTRIBUTED:
 

dict

hynet.types_ module

Numeric types and enumerations in hynet.

class hynet.types_.BranchType[source]

Bases: enum.Enum

Type of entity modeled by the branch.

LINE = 'line'
TRANSFORMER = 'transformer'
class hynet.types_.BusType[source]

Bases: enum.Enum

Type of voltage waveform experienced at the bus.

AC = 'ac'
DC = 'dc'
class hynet.types_.ConstraintType[source]

Bases: enum.Enum

Type of constraint for the QCQP specification.

EQUALITY = 'equality'
INEQUALITY = 'inequality'
class hynet.types_.DBInfoKey[source]

Bases: enum.Enum

Valid keys for the db_info table in a hynet grid database.

BASE_MVA = 'base_mva'
DESCRIPTION = 'description'
GRID_NAME = 'grid_name'
VERSION = 'version'
class hynet.types_.EntityType[source]

Bases: enum.Enum

Type of entity that is deactivated in a scenario.

BRANCH = 'branch'
BUS = 'bus'
CONVERTER = 'converter'
INJECTOR = 'injector'
SHUNT = 'shunt'
class hynet.types_.InjectorType[source]

Bases: enum.Enum

Type of entity modeled by the injector.

BIOMASS = 'renewable:biomass'
COAL = 'conventional:coal'
COMPENSATION = 'compensation'
CONVENTIONAL = 'conventional'
GAS = 'conventional:gas'
GEOTHERMAL = 'renewable:geothermal'
HYDRO = 'renewable:hydro'
LOAD = 'load'
NUCLEAR = 'conventional:nuclear'
PROSUMER = 'prosumer'
PV = 'renewable:pv'
RENEWABLE = 'renewable'
WIND = 'renewable:wind'
is_compensation()[source]

Return True if it is a reactive power compensator.

is_conventional()[source]

Return True if it is a conventional generation utility.

is_load()[source]

Return True if it is a load.

is_prosumer()[source]

Return True if it is a prosumer.

is_renewable()[source]

Return True if it is a renewables-based generation utility.

class hynet.types_.SolverStatus[source]

Bases: enum.Enum

Status returned by a solver after performing an optimization.

FAILED = -4
INACCURATE = 1
INFEASIBLE = -2
SOLVED = 0
UNBOUNDED = -1
class hynet.types_.SolverType[source]

Bases: enum.Enum

Type of problem that can be solved with the solver.

QCQP = 'QCQP'
SDR = 'SDR'
SOCR = 'SOCR'

Module contents

hynet: An optimal power flow framework for hybrid AC/DC power systems.

For more information, please refer to README.md, which is provided alongside hynet, as well as the docstrings of the individual classes and functions. The variables below are set up during package initialization.

param AVAILABLE_SOLVERS:
 List of classes for all solvers available on the current system.
type AVAILABLE_SOLVERS:
 list
param __version__:
 hynet version.
type __version__:
 str