energia.components.operations.process

energia.components.operations.process#

Process

Functions

timer(logger[, kind, level])

Logs execution time and optionally shows a full computation using function arguments and result.

Classes

Operation(*args[, label, citations])

A General Operation

Process(*args[, label, citations])

Process converts one Resource to another Resource at some Location

Production([operation, resource, balance, ...])

Process Production
class Process(*args, label: str = '', citations: str = '', **kwargs)[source]#

Bases: Operation

Process converts one Resource to another Resource at some Location

Parameters:

  • label (str, optional) – An optional label for the component. Defaults to None.

  • citations (str | list[str] | dict[str, str | list[str]], optional) – An optional citation or description for the component. Defaults to None.

Variables:

  • model (Model) – The model to which the component belongs.

  • name (str) – Set when the component is assigned as a Model attribute.

  • constraints (list[str]) – List of constraints associated with the component.

  • domains (list[Domain]) – List of domains associated with the component.

  • aspects (dict[Aspect, list[Domain]]) – Aspects associated with the component with domains.

  • conversion (Conversion, optional) – Operational conversion associated with the operation. Defaults to None.

  • _conv (bool) – True if the operational conversion has been set. Defaults to False.

  • fab (Conversion, optional) – Material conversion associated with the operation. Defaults to None.

  • _fab_balanced (bool) – True if the material conversion has been balanced. Defaults to False.

  • locations (list[Location]) – Locations at which the process is balanced. Defaults to [].

  • charges (Storage, optional) – If the Process is Storage charging. Defaults to None.

  • discharges (Storage, optional) – If the Process is Storage discharging. Defaults to None.

property spaces: list[Location]#

Locations at which the process is balanced

property production#

Alias for primary_conversion

property I#

gana index set (I)

property balance: dict[Resource, int | float]#

Conversion of commodities

property basis: Resource#

Base resource

property capacity_aspect: Aspect#

Capacity Aspect

property capacity_sample: Sample#

Capacity Sample

property cons: list[C]#

Constraints

property horizon: Periods#

Circumscribing Periods (Temporal Scale)

property lag: Lag#

Lag of the process

locate(*spaces: Location | Linkage)#

Locate the process

property network: Location#

Circumscribing Loc (Spatial Scale)

property operate_aspect: Aspect#

Operate Aspect

property operate_sample: Sample#

Operate Sample

property problem: Problem#

Feasible Region

property program: Prg#

Mathematical program

show(descriptive=False, category: str = '')#

Pretty print the component

property space: Space#

Space

property time: Time#

Time

write_construction(space_times: list[tuple[Location | Linkage, Periods]])#

write fabrication constraints for the operation

write_primary_conversion(space_times: list[tuple[Location, Periods]])[source]#

Write the production constraints for the process

Contents