topotherm.fileio
================

.. py:module:: topotherm.fileio

.. autoapi-nested-parse::

   Module for reading and writing input and output data for the optimization
   problem.

   The input data has to be stored in parquet files and read with the function
   `load`.



Functions
---------

.. autoapisummary::

   topotherm.fileio.load


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

.. py:function:: load(path)

   Read the input data from the given path and return the matrices.

   :param path: Path to the input data.
   :type path: str or os.PathLike

   :returns: Matrices stored in the following keys:

             - ``a_i`` : Incidence matrix for the pipes (rows: nodes, columns: edges).
             - ``a_p`` : Adjacency matrix for the producers (rows: nodes, columns: supply IDs).
             - ``a_c`` : Adjacency matrix for the consumers (rows: nodes, columns: consumer IDs).
             - ``Q_c`` : Heat demand of the consumers in W.
             - ``L_i`` : Length of edges.
             - ``rel_positions`` : ``(x, y)`` coordinates of the nodes in the network.
   :rtype: dict