carbatpy.models.coupled.read_cycle_structure
============================================

.. py:module:: carbatpy.models.coupled.read_cycle_structure

.. autoapi-nested-parse::

   Created on Fri Dec 15 14:33:04 2023

   @author: atakan



Attributes
----------

.. autoapisummary::

   carbatpy.models.coupled.read_cycle_structure.DIRNAME
   carbatpy.models.coupled.read_cycle_structure.FILE_NAME


Functions
---------

.. autoapisummary::

   carbatpy.models.coupled.read_cycle_structure.plot_cycle_structure


Module Contents
---------------

.. py:data:: DIRNAME
   :value: '..//..//data'


.. py:data:: FILE_NAME
   :value: 'orc_structure.xlsx'


.. py:function:: plot_cycle_structure(fname, dirname=DIRNAME, cycle_name='cycle', format_='png', engine='circo')

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

   for visualization, a file is generated.

   :param fname: the excel filename.
   :type fname: string
   :param dirname: the directory name to read the file and to store afterwards. The default is DIRNAME.
   :type dirname: string, optional
   :param cycle_name: name of the cycle. The default is "cyle".
   :type cycle_name: string, optional
   :param format: plot-format (png, pdf etc). The default is "png".
   :type format: String, optional
   :param engine: an engine name from graphviz (dot, circo etc.). The default is "circo".
   :type engine: string, optional

   :rtype: None.