hadar.analyzer package

Submodules

hadar.analyzer.result module

class hadar.analyzer.result.ResultAnalyzer(study: hadar.optimizer.domain.input.Study, result: hadar.optimizer.domain.output.Result)

Bases: object

Single object to encapsulate all postprocessing aggregation.

static check_index(indexes: List[hadar.analyzer.result.Index], type: Type[CT_co])

Check indexes cohesion :param indexes: list fo indexes :param type: Index type to check inside list :return: true if at least one type is in list False else

filter(indexes: List[hadar.analyzer.result.Index]) → pandas.core.frame.DataFrame

Aggregate according to index level and filter.

get_balance(node: str, network: str = 'default') → numpy.ndarray

Compute balance over time on asked node.

Parameters

• node – node asked

• network – network asked. Default is ‘default’

Returns

timeline array with balance exchanges value

get_cost(node: str = None, network: str = None) → numpy.ndarray

Compute adequacy cost on a node, network or whole study.

Parameters

• node – node name. None by default to ask whole network.

• network – network name, ‘default’ as default if node is provided or None to ask whole network.

Returns

matrix (scn, time)

get_elements_inside(node: str = None, network: str = None)

Get numbers of elements by node.

Parameters

• node – node name. None by default to ask whole network.

• network – network name, ‘default’ as default if node is provided or None to ask whole network.

Returns

(nb of consumptions, nb of productions, nb of storages, nb of links (export), nb of converters (export), nb of converters (import)

get_rac(network='default') → numpy.ndarray

Compute Remain Availabale Capacities on network.

Parameters

network – selecto network to compute. Default is default.

Returns

matrix (scn, time)

horizon

Shortcut to get study horizon.

Returns

study horizon

nb_scn

Shortcut to get study number of scenarios.

Returns

study number of scenarios

network(name='default')

Entry point for fluent api :param name: network name. ‘default’ as default :return: Fluent API Selector

nodes(network: str = 'default') → List[str]

Shortcut to get list of node names

Parameters

network – network selected

Returns

nodes name

class hadar.analyzer.result.NetworkFluentAPISelector(indexes: List[hadar.analyzer.result.Index], analyzer: hadar.analyzer.result.ResultAnalyzer)

Bases: object

Fluent Api Selector to analyze network element.

User can join network, node, consumption, production, link, time, scn to create filter and organize hierarchy. Join can me in any order, except: - join begin by network - join is unique only one element of node, time, scn are expected for each query - production, consumption and link are excluded themself, only on of them are expected for each query

FULL_DESCRIPTION = 5

Module contents

hadar package hadar.optimizer package