Skip to content

candidate

Classes:

XpansionCandidate dataclass 

XpansionCandidate(
    name: str,
    area_from: str,
    area_to: str,
    annual_cost_per_mw: float,
    already_installed_capacity: Optional[int] = None,
    unit_size: Optional[float] = None,
    max_units: Optional[int] = None,
    max_investment: Optional[float] = None,
    direct_link_profile: Optional[str] = None,
    indirect_link_profile: Optional[str] = None,
    already_installed_direct_link_profile: Optional[str] = None,
    already_installed_indirect_link_profile: Optional[str] = None,
)

Investment candidate in the Xpansion module.

Attributes:

  • name (str) –

    Name of the candidate.

  • area_from (str) –

    Origin area of the invested link.

  • area_to (str) –

    Destination area of the invested link.

  • annual_cost_per_mw (float) –

    Annual cost of investment in €/MW.

  • already_installed_capacity (Optional[int]) –

    Already installed capacity in MW.

  • unit_size (Optional[float]) –

    Size of a unit of investment in MW. None if max_investment is filled.

  • max_units (Optional[int]) –

    Maximum number invesment units. None if max_investment is filled.

  • max_investment (Optional[float]) –

    Maximum investment possible on this candidate None if unit_size and max_units are filled.

  • direct_link_profile (Optional[str]) –

    Time-series' filename of the direct link profile.

  • indirect_link_profile (Optional[str]) –

    Time-series' filename of the indirect link profile.

  • already_installed_direct_link_profile (Optional[str]) –

    Time-series' filename of the already installed direct link profile.

  • already_installed_indirect_link_profile (Optional[str]) –

    Time-series' filename of the already installed indirect link profile.

XpansionCandidateUpdate dataclass 

XpansionCandidateUpdate(
    name: Optional[str] = None,
    area_from: Optional[str] = None,
    area_to: Optional[str] = None,
    annual_cost_per_mw: Optional[float] = None,
    already_installed_capacity: Optional[int] = None,
    unit_size: Optional[float] = None,
    max_units: Optional[int] = None,
    max_investment: Optional[float] = None,
    direct_link_profile: Optional[str] = None,
    indirect_link_profile: Optional[str] = None,
    already_installed_direct_link_profile: Optional[str] = None,
    already_installed_indirect_link_profile: Optional[str] = None,
)

Update an investment candidate in the Xpansion module.

Attributes:

  • name (Optional[str]) –

    Name of the candidate.

  • area_from (Optional[str]) –

    Origin area of the invested link.

  • area_to (Optional[str]) –

    Destination area of the invested link.

  • annual_cost_per_mw (Optional[float]) –

    Annual cost of investment in €/MW.

  • already_installed_capacity (Optional[int]) –

    Already installed capacity in MW.

  • unit_size (Optional[float]) –

    Size of a unit of investment in MW. None if max_investment is filled.

  • max_units (Optional[int]) –

    Maximum number invesment units. None if max_investment is filled.

  • max_investment (Optional[float]) –

    Maximum investment possible on this candidate None if unit_size and max_units are filled.

  • direct_link_profile (Optional[str]) –

    Time-series' filename of the direct link profile.

  • indirect_link_profile (Optional[str]) –

    Time-series' filename of the indirect link profile.

  • already_installed_direct_link_profile (Optional[str]) –

    Time-series' filename of the already installed direct link profile.

  • already_installed_indirect_link_profile (Optional[str]) –

    Time-series' filename of the already installed indirect link profile.

XpansionLinkProfile

Xpansion link profile types.

Attributes:

  • DIRECT_LINK –

    Link profile of a candidate in the direct sense

  • INDIRECT_LINK –

    Link profile of a candidate in the indirect sense

  • ALREADY_INSTALLED_DIRECT_LINK –

    Already installed link profile in the direct sense

  • ALREADY_INSTALLED_INDIRECT_LINK –

    Already installed link profile in the indirect sense