:py:mod:`hazimp.config`
=======================

.. py:module:: hazimp.config

.. autoapi-nested-parse::

   Functions concerning the yaml configuration file.



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


Functions
~~~~~~~~~

.. autoapisummary::

   hazimp.config.read_config_file
   hazimp.config.instance_builder



.. py:function:: read_config_file(file_name: str) -> list

   Read the configuration file and return the info as a list.

   :param file_name: The yaml file.
   :returns: A list of the configuration file


.. py:function:: instance_builder(config_list: list) -> list

   From the configuration list build and knowing
   the template, build the the job instances
   and add attributes in the config to the instances.

   :param config_list: A list describing the simulation.
   :returns: A list of job instances to process over.