py21cmfast.cli.RunParams
========================

.. py:class:: py21cmfast.cli.RunParams

   
   Common parameters for run functions.
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: cache_strategy
      :type:  Literal['on', 'off', 'noloop', 'dmfield', 'last_step_only']
      :value: 'dmfield'


      
      A strategy for which fields to cache (only used for coeval and lightcones).
      Options are: (on) cache everything, (off) cache nothing (noloop) cache only boxes
      outside the astrophysics evolution loop (dmfield) alias for noloop (last_step_only)
      cache only boxes that are required more than one step away
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: cachedir
      :type:  cyclopts.types.ExistingDirectory

      
      Where to write and search for cached items and output fullspec configuration files. Note that caches will be in hash-style folders inside this folder.
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: outcfg
      :type:  Annotated[pathlib.Path, Parameter(validator=vld.Path(file_okay=False, dir_okay=False, ext=('toml', )))]
      :value: None


      
      A filepath where the full configuration TOML of the run can be written. Random hash if not specified.
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: param_selection
      :type:  ParameterSelection


   .. py:attribute:: progress
      :type:  bool
      :value: True


      
      Whether to display a progress bar as the simulation runs.
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: regenerate
      :type:  Annotated[bool, Parameter(name=['--regenerate', '--regen'])]
      :value: False


      
      Whether to regenerate all data, even if found in cache.
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: seed
      :type:  int
      :value: 42


      
      Random seed used to generate data.
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: verbosity
      :type:  Annotated[Literal['CRITICAL', 'ERROR', 'WARNING', 'INFO', 'DEBUG'], Parameter(alias=('-v', '--v'))]
      :value: 'WARNING'


      
      How much information to print out while running the simulation.
















      ..
          !! processed by numpydoc !!