Source code for oemof.solph.components._source

# -*- coding: utf-8 -*-

"""
solph version of oemof.network.Source

SPDX-FileCopyrightText: Uwe Krien <krien@uni-bremen.de>
SPDX-FileCopyrightText: Simon Hilpert
SPDX-FileCopyrightText: Cord Kaldemeyer
SPDX-FileCopyrightText: Stephan Günther
SPDX-FileCopyrightText: Birgit Schachler
SPDX-FileCopyrightText: Johannes Kochems

SPDX-License-Identifier: MIT

"""

from oemof.network import Node




class Source(Node):
    """A component which is designed for one output flow.

    Parameters
    ----------
    label : str or tuple
        String holding the label of the Source object.
        The label of each object must be unique.
    outputs: dict
        A dictionary mapping input nodes to corresponding outflows
        (i.e. output values).
    custom_properties: dict
        Additional keyword arguments for use in user-defined equations or for
        information purposes.

    Examples
    --------
    Defining a Source:

    >>> from oemof import solph
    >>> bel = solph.buses.Bus(label='electricity')

    >>> pv_plant = solph.components.Source(
    ...    label='pp_pv',
    ...    outputs={bel: solph.flows.Flow()})

    >>> type(pv_plant)
    <class 'oemof.solph.components._source.Source'>

    >>> pv_plant.label
    'pp_pv'

    >>> str(pv_plant.outputs[bel].output)
    'electricity'
    >>> bgas = solph.buses.Bus(label='gas')
    >>> gas_source = solph.components.Source(
    ...    label='gas_import',
    ...    outputs={bgas: solph.flows.Flow()},
    ...    custom_properties={"emission": 201})  # g/kWh
    >>> gas_source.custom_properties["emission"]
    201
    """

    def __init__(
        self, label=None, *, outputs, parent_node=None, custom_properties=None
    ):
        if outputs is None:
            outputs = {}
        if custom_properties is None:
            custom_properties = {}

        super().__init__(
            label=label,
            outputs=outputs,
            parent_node=parent_node,
            custom_properties=custom_properties,
        )



    def constraint_group(self):
        pass