carbatpy.models.coupled.read_cycle_structure

Created on Fri Dec 15 14:33:04 2023

@author: atakan

Attributes

DIRNAME

FILE_NAME

Functions

plot_cycle_structure(fname[, dirname, cycle_name, ...])

read an Excel file with information about the cycle structure and use graphviz

Module Contents

carbatpy.models.coupled.read_cycle_structure.DIRNAME = '..//..//data'[source]
carbatpy.models.coupled.read_cycle_structure.FILE_NAME = 'orc_structure.xlsx'[source]
carbatpy.models.coupled.read_cycle_structure.plot_cycle_structure(fname, dirname=DIRNAME, cycle_name='cycle', format_='png', engine='circo')[source]

read an Excel file with information about the cycle structure and use graphviz

for visualization, a file is generated.

Parameters:

  • fname (string) – the excel filename.

  • dirname (string, optional) – the directory name to read the file and to store afterwards. The default is DIRNAME.

  • cycle_name (string, optional) – name of the cycle. The default is “cyle”.

  • format (String, optional) – plot-format (png, pdf etc). The default is “png”.

  • engine (string, optional) – an engine name from graphviz (dot, circo etc.). The default is “circo”.

Return type:

None.