nuctransportdb.dataframe2yaml
=============================

.. py:module:: nuctransportdb.dataframe2yaml


Classes
-------

.. autoapisummary::

   nuctransportdb.dataframe2yaml.List_flow_sequence


Functions
---------

.. autoapisummary::

   nuctransportdb.dataframe2yaml.flow_sequence_representer
   nuctransportdb.dataframe2yaml.convert_to_flow_sequence
   nuctransportdb.dataframe2yaml.dataframe2yaml_str
   nuctransportdb.dataframe2yaml.export2yaml


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

.. py:class:: List_flow_sequence

   Bases: :py:obj:`list`


   Built-in mutable sequence.

   If no argument is given, the constructor creates a new empty list.
   The argument must be an iterable if specified.


.. py:function:: flow_sequence_representer(dumper, data)

.. py:function:: convert_to_flow_sequence(unit_base)

   Convert unit_base to a flow sequence representation.

   :param unit_base: The unit_base to convert.
   :type unit_base: list or nonetype

   :returns: The flow sequence representation of the unit base.
   :rtype: List_flow_sequence


.. py:function:: dataframe2yaml_str(property_df)

   Convert the property dataframe to a YAML string.

   :param property_df: The input property dataframe.
   :type property_df: pd.DataFrame

   :returns: The YAML string representation of the property dataframe.
   :rtype: str


.. py:function:: export2yaml(property_df, output_file_path) -> None

   Export the property dataframe to a YAML file.

   :param property_df: The input property dataframe.
   :type property_df: pd.DataFrame
   :param output_file_path: Path to the output YAML file.
   :type output_file_path: str