py21cmfast.management
=====================

.. py:module:: py21cmfast.management

.. autoapi-nested-parse::

   Tools for simulation managements.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   py21cmfast.management.get_expected_outputs
   py21cmfast.management.get_expected_sizes
   py21cmfast.management.get_total_storage_size


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

.. py:function:: get_expected_outputs(inputs, cache_config = CacheConfig.on())

   
   Return a dictionary of expected output structs and their arrays for given inputs.
















   ..
       !! processed by numpydoc !!

.. py:function:: get_expected_sizes(inputs, cache_config = CacheConfig.on(), redshift = 6.0)

   
   Compute the expected size of each of the relevant output structs in a sim.

   The returned dictionary holds the size in bytes of each relevant output struct
   kind, estimated as the _full_ size given the inputs.

   The peak memory usage of a simulation is *not* simply the sum of these
   numbers. Running :func:`run_lightcone` or :func:`run_coeval` is able to intelligently
   offload memory onto disk at various points, reducing peak memory, however very often
   two of each type of array must be in memory at once, and peak memory while inside
   a C compute function can be temporarily higher again.















   ..
       !! processed by numpydoc !!

.. py:function:: get_total_storage_size(inputs, cache_config = CacheConfig.on())

   
   Compute the total storage size of a simulation.
















   ..
       !! processed by numpydoc !!