CLIMLAB API reference¶
This chapter documents the source code of the climlab package.
The focus is on the methods and functions that the user invokes
while using the package.
Nevertheless also the underlying code of the climlab architecture
has been documented for a comprehensive understanding and traceability.
- climlab.convection
- climlab.domain
- climlab.dynamics
- BudykoTransport
- AdvectionDiffusion
- MeridionalAdvectionDiffusion
- MeridionalHeatDiffusion
- MeridionalMoistDiffusion
- Numerical core for the advection-diffusion solver (climlab.dynamics.adv_diff_numerics)
- The 1D advection-diffusion problem
- Spatial discretization
- Centered difference formulas for the flux
- Centered difference formulas for the flux convergence
- Implicit time discretization
- Analytical benchmark
- Module function reference
advdiff_tridiag()advective_flux()compute_source()compute_tendency()diffusive_flux()implicit_step_forward()make_the_actual_tridiagonal_matrix()total_flux()
- climlab.model
- climlab.process
- diagnostic
- energy_budget
- external_forcing
- implicit
- process
ProcessProcess.add_diagnostic()Process.add_input()Process.add_subprocess()Process.add_subprocesses()Process.declare_diagnostics()Process.declare_input()Process.depthProcess.depth_boundsProcess.diagnosticsProcess.inputProcess.latProcess.lat_boundsProcess.levProcess.lev_boundsProcess.lonProcess.lon_boundsProcess.remove_diagnostic()Process.remove_subprocess()Process.set_state()Process.to_xarray()
get_axes()process_like()
- time_dependent_process
TimeDependentProcessTimeDependentProcess.compute()TimeDependentProcess.compute_diagnostics()TimeDependentProcess.integrate_converge()TimeDependentProcess.integrate_days()TimeDependentProcess.integrate_years()TimeDependentProcess.set_state()TimeDependentProcess.set_timestep()TimeDependentProcess.step_forward()TimeDependentProcess.timestep
couple()
- climlab.radiation
- climlab.solar
- climlab.surface
- climlab.utils
- constants
- heat_capacity
- legendre
- thermo
EIS()Planck_frequency()Planck_wavelength()Planck_wavenumber()T()blackbody_emission()clausius_clapeyron()estimated_inversion_strength()lifting_condensation_level()mixing_ratio_from_vapor_pressure()mmr_to_vmr()potential_temperature()pseudoadiabat()qsat()rho_moist()temperature_from_potential()theta()vapor_pressure_from_specific_humidity()virtual_temperature_from_mixing_ratio()vmr_to_mmr()
- walk