crunchflow.input.InputFile
==========================

.. py:class:: crunchflow.input.InputFile

   
   The main class for creating and saving CrunchFlow input files.
















   ..
       !! processed by numpydoc !!

   .. py:method:: set_block(block_name, parameters)

      
      Set the parameters of a block in an InputFile instance.


      :Parameters:

          **block_name** : str
              The name of the block to set.

          **parameters** : dict
              A dictionary of parameters to set for the block.














      ..
          !! processed by numpydoc !!


   .. py:method:: __str__()

      
      Return a string representation of the CrunchFlow input file.
















      ..
          !! processed by numpydoc !!


   .. py:method:: save(filename, path='.', update_pestcontrol=False)

      
      Write this CrunchFlow run to an input file.


      :Parameters:

          **filename** : str
              The name of the output file to save.

          **path** : str, optional
              The path to the output file. Default is the current directory.

          **update_pestcontrol** : bool, optional
              Whether to update PestControl.ant with the name of the
              CrunchFlow input file. Default is False.



      :Returns:

          None
              The CrunchFlow input file is saved to disk.











      ..
          !! processed by numpydoc !!


   .. py:method:: load(filename, path='.', warnings=True)
      :classmethod:


      
      Read a CrunchFlow input file and create a Run instance.


      :Parameters:

          **filename** : str
              The name of the input file to read.

          **path** : str, optional
              The path to the input file. Default is the current directory.

          **warnings** : bool, optional
              Whether to print warnings for unrecognized blocks or attributes.
              Default is True.



      :Returns:

          InputFile
              A Run instance with the data read from the input file.











      ..
          !! processed by numpydoc !!