Processes

pydantic model flodym.Process

Processes serve as nodes for the MFA system layout definition. Flows are defined between two processes. Stocks are connected to a process. Processes do not contain values themselves.

Processes get an ID by the order they are defined in the :py:attribute::MFASystem.definition. The process with ID 0 necessarily contains everything outside the system boundary. It has to be named ‘sysenv’.

Fields:

  • id (int)

  • name (str)

Validators:

  • check_id0 » all fields

field id: int [Required]

ID of the process.

field name: str [Required]

Name of the process.

validator check_id0  »  all fields

Ensure that the process with ID 0 is named ‘sysenv’.

flodym.make_processes(definitions)

Create a dictionary of processes from a list of process names.

Parameters:

definitions (List[str])

Return type:

dict[str, Process]