Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
21cmFAST 0.0.1.dev508+g3c61b2249.d20260619 documentation
Logo
  • Installation
  • Quickstart
  • Tutorials
    • Defining Simulation Inputs
    • Running and Plotting Coeval Cubes
    • Running and Plotting LightCones
    • Running global evolution
    • Accessing evolutionary Coeval data
    • Using the CLI
    • Exploring the Impact of Mini-Halos
    • Adding DM-Baryon Relative Velocities
    • Halo Sampling in 21cmFAST
    • Redshift Space Distortions
  • Performance
  • Description of Physical Models
  • FAQs
    • Installation FAQ
    • Miscellaneous FAQs
  • Changes from v3 to v4
  • Acknowledging

API Reference

  • py21cmfast
    • py21cmfast.cli
      • py21cmfast.cli.NodeRedshiftParameters
      • py21cmfast.cli.ParameterSelection
      • py21cmfast.cli.Parameters
      • py21cmfast.cli.RunParams
    • py21cmfast.drivers
      • py21cmfast.drivers.coeval
        • py21cmfast.drivers.coeval.Coeval
      • py21cmfast.drivers.global_evolution
        • py21cmfast.drivers.global_evolution.GlobalEvolution
      • py21cmfast.drivers.lightcone
        • py21cmfast.drivers.lightcone.AngularLightcone
        • py21cmfast.drivers.lightcone.LightCone
      • py21cmfast.drivers.single_field
      • py21cmfast.drivers.Coeval
      • py21cmfast.drivers.GlobalEvolution
      • py21cmfast.drivers.LightCone
    • py21cmfast.input_serialization
    • py21cmfast.io
      • py21cmfast.io.caching
        • py21cmfast.io.caching.CacheConfig
        • py21cmfast.io.caching.CacheConfigUpdate
        • py21cmfast.io.caching.OutputCache
        • py21cmfast.io.caching.RunCache
      • py21cmfast.io.h5
        • py21cmfast.io.h5.HDF5FileStructureError
    • py21cmfast.lightconers
      • py21cmfast.lightconers.AngularLightconer
      • py21cmfast.lightconers.Lightconer
      • py21cmfast.lightconers.RectilinearLightconer
    • py21cmfast.management
    • py21cmfast.plotting
    • py21cmfast.rsds
    • py21cmfast.utils
    • py21cmfast.wrapper
      • py21cmfast.wrapper.arrays
        • py21cmfast.wrapper.arrays.Array
        • py21cmfast.wrapper.arrays.CacheBackend
        • py21cmfast.wrapper.arrays.H5Backend
      • py21cmfast.wrapper.arraystate
        • py21cmfast.wrapper.arraystate.ArrayStateError
        • py21cmfast.wrapper.arraystate.ArrayState
      • py21cmfast.wrapper.cfuncs
      • py21cmfast.wrapper.classy_interface
        • py21cmfast.wrapper.classy_interface.EHTransferFunction
      • py21cmfast.wrapper.exceptions
        • py21cmfast.wrapper.exceptions.ArgumentValueError
        • py21cmfast.wrapper.exceptions.FatalCError
        • py21cmfast.wrapper.exceptions.FileIOError
        • py21cmfast.wrapper.exceptions.GSLError
        • py21cmfast.wrapper.exceptions.InfinityorNaNError
        • py21cmfast.wrapper.exceptions.MassDepZetaError
        • py21cmfast.wrapper.exceptions.MemoryAllocError
        • py21cmfast.wrapper.exceptions.ParameterError
        • py21cmfast.wrapper.exceptions.PhotonConsError
        • py21cmfast.wrapper.exceptions.TableEvaluationError
        • py21cmfast.wrapper.exceptions.TableGenerationError
      • py21cmfast.wrapper.inputs
        • py21cmfast.wrapper.inputs.InputCrossValidationError
        • py21cmfast.wrapper.inputs.AstroOptions
        • py21cmfast.wrapper.inputs.AstroParams
        • py21cmfast.wrapper.inputs.CosmoParams
        • py21cmfast.wrapper.inputs.CosmoTables
        • py21cmfast.wrapper.inputs.InputParameters
        • py21cmfast.wrapper.inputs.InputStruct
        • py21cmfast.wrapper.inputs.MatterOptions
        • py21cmfast.wrapper.inputs.SimulationOptions
        • py21cmfast.wrapper.inputs.Table1D
      • py21cmfast.wrapper.outputs
        • py21cmfast.wrapper.outputs.BrightnessTemp
        • py21cmfast.wrapper.outputs.Halo
        • py21cmfast.wrapper.outputs.HaloBox
        • py21cmfast.wrapper.outputs.HaloCatalog
        • py21cmfast.wrapper.outputs.InitialConditions
        • py21cmfast.wrapper.outputs.IonizedBox
        • py21cmfast.wrapper.outputs.OutputStruct
        • py21cmfast.wrapper.outputs.OutputStructZ
        • py21cmfast.wrapper.outputs.PerturbedField
        • py21cmfast.wrapper.outputs.PerturbedHaloCatalog
        • py21cmfast.wrapper.outputs.TsBox
        • py21cmfast.wrapper.outputs.XraySourceBox
      • py21cmfast.wrapper.photoncons
      • py21cmfast.wrapper.structs
        • py21cmfast.wrapper.structs.StructInstanceWrapper
        • py21cmfast.wrapper.structs.StructWrapper
    • py21cmfast.yaml
    • py21cmfast.AngularLightconer
    • py21cmfast.AstroOptions
    • py21cmfast.AstroParams
    • py21cmfast.BrightnessTemp
    • py21cmfast.CacheConfig
    • py21cmfast.Coeval
    • py21cmfast.CosmoParams
    • py21cmfast.GlobalEvolution
    • py21cmfast.HaloBox
    • py21cmfast.HaloCatalog
    • py21cmfast.InitialConditions
    • py21cmfast.InputParameters
    • py21cmfast.IonizedBox
    • py21cmfast.LightCone
    • py21cmfast.MatterOptions
    • py21cmfast.OutputCache
    • py21cmfast.PerturbedField
    • py21cmfast.PerturbedHaloCatalog
    • py21cmfast.RectilinearLightconer
    • py21cmfast.RunCache
    • py21cmfast.SimulationOptions
    • py21cmfast.TsBox
    • py21cmfast.XraySourceBox

Development

  • Install as a Developer
  • Contributing
  • Developer Documentation
  • License
  • Changelog
  • Authors
Back to top
Copyright © 2020, The 21cmFAST collaboration
Made with Sphinx and @pradyunsg's Furo
Last updated on Jun 19, 2026