bluemira.codes.process._setup
=============================

.. py:module:: bluemira.codes.process._setup

.. autoapi-nested-parse::

   Defines the setup task for running PROCESS.



Classes
-------

.. autoapisummary::

   bluemira.codes.process._setup.Setup


Functions
---------

.. autoapisummary::

   bluemira.codes.process._setup._make_writer
   bluemira.codes.process._setup.create_template_from_path


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

.. py:class:: Setup(params: dict | bluemira.base.parameter_frame.ParameterFrame, in_dat_path: str, problem_settings: dict[str, float | str] | None = None)

   Bases: :py:obj:`bluemira.codes.interface.CodesSetup`

   .. autoapi-inheritance-diagram:: bluemira.codes.process._setup.Setup
      :parts: 1
      :private-bases:


   Setup Task for running PROCESS.

   :param params: The bluemira parameters for this task.
   :param in_dat_path: The path to where the IN.DAT file should be written.
   :param problem_settings: The PROCESS parameters that do not exist in bluemira.


   .. py:attribute:: MODELS
      :type:  ClassVar


   .. py:attribute:: params
      :type:  bluemira.codes.process.params.ProcessSolverParams


   .. py:attribute:: in_dat_path


   .. py:attribute:: problem_settings


   .. py:method:: run()

      Write the IN.DAT file and store in the main PROCESS folder.

      Bluemira params with :code:`param.mapping.send == True` will be
      written to IN.DAT.



   .. py:method:: runinput()

      Write the IN.DAT file and store in the main PROCESS folder.

      Bluemira outputs will not be written to the file.



   .. py:method:: _write_in_dat(*, use_bp_inputs: bool = True)

      Write the IN.DAT file and stores in the main PROCESS folder.

      :param use_bp_inputs: Option to use bluemira values as PROCESS inputs. Used to re-run PROCESS
                            within a bluemira run. If False, runs PROCESS without modifying inputs.
                            Default, True



   .. py:method:: _validate_models(writer)

      Loop through known models, find the PROCESS output value for the
      model, and convert the type to its corresponding Enum value.



.. py:function:: _make_writer(template_in_dat: dict[str, bluemira.codes.process.api._INVariable]) -> bluemira.codes.process.api.InDat

.. py:function:: create_template_from_path(template_in_dat: str | pathlib.Path) -> bluemira.codes.process._inputs.ProcessInputs