py21cmfast.management

Tools for simulation managements.

Functions

get_expected_outputs(inputs[, cache_config])

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

get_expected_sizes(inputs[, cache_config, redshift])

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

get_total_storage_size(inputs[, cache_config])

Compute the total storage size of a simulation.

Module Contents

py21cmfast.management.get_expected_outputs(inputs, cache_config=CacheConfig.on())[source]

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

Parameters:
Return type:

dict[str, dict[str, py21cmfast.wrapper.arrays.Array]]

py21cmfast.management.get_expected_sizes(inputs, cache_config=CacheConfig.on(), redshift=6.0)[source]

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 run_lightcone() or 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.

Parameters:
Return type:

dict[str, int]

py21cmfast.management.get_total_storage_size(inputs, cache_config=CacheConfig.on())[source]

Compute the total storage size of a simulation.

Parameters: