py21cmfast.io.caching.CacheConfig
=================================

.. py:class:: py21cmfast.io.caching.CacheConfig

   
   A configuration object that specifies whether a certain field should be cached.
















   ..
       !! processed by numpydoc !!

   .. py:method:: last_step_only()
      :classmethod:


      
      Generate a CacheConfig where only boxes needed from more than one step away are cached.

      This represents the minimum caching setup which will *never* store every redshift in memory.
      PerturbedField and PerturbedHaloCatalogs are all calculated at the start of the run, and HaloBox
      is required at multiple redshifts for the XraySourceBox. So this caching setup allows free
      purging of these objects without losing data.















      ..
          !! processed by numpydoc !!


   .. py:method:: noloop()
      :classmethod:


      
      Generate a CacheConfig where only boxes not requiring evolution are cached.
















      ..
          !! processed by numpydoc !!


   .. py:method:: off()
      :classmethod:


      
      Generate a CacheConfig where no boxes are cached.
















      ..
          !! processed by numpydoc !!


   .. py:method:: on()
      :classmethod:


      
      Generate a CacheConfig where all boxes are cached.
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: brightness_temp
      :type:  bool


   .. py:attribute:: halo_catalog
      :type:  bool


   .. py:attribute:: halobox
      :type:  bool


   .. py:attribute:: initial_conditions
      :type:  bool


   .. py:attribute:: ionized_box
      :type:  bool


   .. py:attribute:: perturbed_field
      :type:  bool


   .. py:attribute:: spin_temp
      :type:  bool


   .. py:attribute:: xray_source_box
      :type:  bool