geoprob_pipe.calculations.systems.base_objects.base_system_build
================================================================

.. py:module:: geoprob_pipe.calculations.systems.base_objects.base_system_build


Classes
-------

.. autoapisummary::

   geoprob_pipe.calculations.systems.base_objects.base_system_build.BaseSystemBuilder


Functions
---------

.. autoapisummary::

   geoprob_pipe.calculations.systems.base_objects.base_system_build._gather_variable_correlations
   geoprob_pipe.calculations.systems.base_objects.base_system_build._gather_calculation_input
   geoprob_pipe.calculations.systems.base_objects.base_system_build._generate_single_calculation


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

.. py:function:: _gather_variable_correlations(geopackage_filepath)

   Input originally from the input Excel-file. It defines per combination of two parameters the correlation; a
   value between 0.0 (no correlation) and 1.0 (fully correlated). By default, no correlation is specified for
   parameter combinations, i.e. the probabilistic library automatically assigns 0.0 as correlation for the
   combination. The correlation applies for the entire trajectory.

   TODO: This setup applies for the entire trajectory. In future versions of
   the code the user should be able to assign the correlation on vak, scenario and uittredepunten level.

   :return:


.. py:function:: _gather_calculation_input(df_expanded, uittredepunt_id, ondergrondscenario_naam)

.. py:function:: _generate_single_calculation(row_calculation_metadata, vak_id, df_expanded, system_class, variable_correlations)

.. py:class:: BaseSystemBuilder(geopackage_filepath, to_run_vakken_ids)

   .. py:attribute:: system_class


   .. py:attribute:: geopackage_filepath


   .. py:attribute:: df_expanded


   .. py:method:: setup_iteration_df()


   .. py:method:: build_instance(row_unique)