SRFM

Contents:

  • Overview
    • Components
    • Installation
    • Supported platforms and prerequisites
    • Building and packaging
    • Installing from dist/
    • Verification
    • Usage
    • External dependencies
    • Documentation
    • References
  • Examples
  • Basic examples
    • Basic examples
      • Run SRFM with a driver table
        • External spectroscopy data
        • The driver table
        • Example output
  • Driver table
    • General run and output
    • Spectral grids
    • Output geometry
    • Atmospheric calculation levels
    • RFM execution configuration
    • RFM driver sections
    • DISORT configuration
    • Scattering-layer configuration
    • Solar and viewing geometry
  • Memory-efficient calculations
    • Output retention
    • Compatibility interfaces
    • Benchmarking
  • Modules and Functions
    • srfm.ARIA_module
      • RI
        • RI.expected_column_names
        • RI.expected_header_names
        • RI.load_refractive_indices()
        • RI.read()
        • RI.select()
      • ReadError
      • find_ri_files()
      • get_ri_filepathname()
      • read_ri_file()
    • srfm.disort_functions
      • get_pmom_from_disort()
      • test_disort_input_format()
      • test_disort_input_integrity()
      • update_maxcmu()
      • update_maxulv()
      • update_maxumu()
    • srfm.forward_model
      • DISORT
        • DISORT.add_disort_empty_input()
        • DISORT.add_disort_input()
        • DISORT.calc_bbt()
        • DISORT.calc_pmom()
        • DISORT.calc_pmom_double()
        • DISORT.calc_pmom_single()
        • DISORT.initialize_disort_output_arrays()
        • DISORT.run_disort()
        • DISORT.run_disort_double()
        • DISORT.run_disort_single()
        • DISORT.save_model_pickle()
        • DISORT.set_accur()
        • DISORT.set_albedo()
        • DISORT.set_bemst()
        • DISORT.set_btemp()
        • DISORT.set_deltamplus()
        • DISORT.set_do_pseudo_sphere()
        • DISORT.set_dtauc()
        • DISORT.set_dtauc_manually()
        • DISORT.set_earth_radius()
        • DISORT.set_emust()
        • DISORT.set_fbeam()
        • DISORT.set_fisot()
        • DISORT.set_h_lyr()
        • DISORT.set_h_lyr_from_rfm()
        • DISORT.set_header()
        • DISORT.set_ibcnd()
        • DISORT.set_lamber()
        • DISORT.set_maxcly()
        • DISORT.set_maxcly_from_rfm()
        • DISORT.set_maxcmu()
        • DISORT.set_maxmom()
        • DISORT.set_maxphi()
        • DISORT.set_maxulv()
        • DISORT.set_maxumu()
        • DISORT.set_mixed_pmom()
        • DISORT.set_onlyfl()
        • DISORT.set_phi()
        • DISORT.set_phi0()
        • DISORT.set_plank()
        • DISORT.set_pmom()
        • DISORT.set_pmom_manually()
        • DISORT.set_prnt()
        • DISORT.set_rho_accurate()
        • DISORT.set_rhoq()
        • DISORT.set_rhou()
        • DISORT.set_ssalb()
        • DISORT.set_ssalb_manually()
        • DISORT.set_temis()
        • DISORT.set_temper()
        • DISORT.set_temper_from_rfm()
        • DISORT.set_ttemp()
        • DISORT.set_umu()
        • DISORT.set_umu0()
        • DISORT.set_usrang()
        • DISORT.set_usrtau()
        • DISORT.set_utau()
        • DISORT.set_wvl()
        • DISORT.set_wvnm()
        • DISORT.set_wvnm_range()
        • DISORT.test_disort_input_format()
        • DISORT.test_disort_input_integrity()
      • DisortResult
        • DisortResult.albmed
        • DisortResult.as_dict()
        • DisortResult.dfdt
        • DisortResult.flup
        • DisortResult.rfldir
        • DisortResult.rfldn
        • DisortResult.trnmed
        • DisortResult.uavg
        • DisortResult.uu
        • DisortResult.wavelength
        • DisortResult.wavenumber
      • Fwd_model
      • RFM
        • RFM.add_rfm_opt_output()
        • RFM.calc_col_dens_and_mass()
        • RFM.get_wnos_from_RFM()
        • RFM.load_output_prf()
        • RFM.run_rfm()
      • SRFM
        • SRFM.calc_bbt()
        • SRFM.convolve_with_iasi()
        • SRFM.initialize_srfm_output_arrays_from_disort()
        • SRFM.interp()
        • SRFM.set_wvls()
        • SRFM.set_wvnm()
        • SRFM.store_disort_result()
    • srfm.layer
      • GreyBodyCloud
        • GreyBodyCloud.calc_grids()
        • GreyBodyCloud.calc_layer_extent()
        • GreyBodyCloud.calc_optical_properties()
        • GreyBodyCloud.calculate_op()
        • GreyBodyCloud.plot_diff()
        • GreyBodyCloud.regrid()
        • GreyBodyCloud.set_alt_lim()
        • GreyBodyCloud.set_center_alt()
        • GreyBodyCloud.set_emis()
        • GreyBodyCloud.set_input_from_dict()
        • GreyBodyCloud.set_name()
        • GreyBodyCloud.set_res()
        • GreyBodyCloud.set_spc_lim()
        • GreyBodyCloud.set_spec_units()
        • GreyBodyCloud.set_tau()
        • GreyBodyCloud.set_thick()
        • GreyBodyCloud.test_complete_input_format()
        • GreyBodyCloud.test_input_values()
        • GreyBodyCloud.track_regrid_diff()
      • Layer
      • MieLayer
        • MieLayer.add_op_calc_output()
        • MieLayer.calc_grids()
        • MieLayer.calc_layer_extent()
        • MieLayer.calc_optical_properties()
        • MieLayer.calc_size_distribution()
        • MieLayer.calc_tau()
        • MieLayer.calculate_op()
        • MieLayer.discard_phase_function()
        • MieLayer.interpolate_optical_properties()
        • MieLayer.n_s_v()
        • MieLayer.nsv_or_ml()
        • MieLayer.plot_diff()
        • MieLayer.regrid()
        • MieLayer.set_alt_lim()
        • MieLayer.set_center_alt()
        • MieLayer.set_comp()
        • MieLayer.set_dist_type()
        • MieLayer.set_eta()
        • MieLayer.set_input_from_dict()
        • MieLayer.set_leg_coeffs()
        • MieLayer.set_leg_coeffs_type()
        • MieLayer.set_mass_loading()
        • MieLayer.set_multiproccess()
        • MieLayer.set_n()
        • MieLayer.set_name()
        • MieLayer.set_phase_quad_N()
        • MieLayer.set_phase_quad_type()
        • MieLayer.set_r()
        • MieLayer.set_radii()
        • MieLayer.set_radii_quad_type()
        • MieLayer.set_res()
        • MieLayer.set_rho()
        • MieLayer.set_s()
        • MieLayer.set_s_a_den()
        • MieLayer.set_spc_lim()
        • MieLayer.set_spec_units()
        • MieLayer.set_thick()
        • MieLayer.set_v_den()
        • MieLayer.test_complete_input_format()
        • MieLayer.test_input_values()
        • MieLayer.track_regrid_diff()
    • srfm.optical_properties
      • calc_op_diff()
      • ewp_hs()
      • get_quad()
      • get_radii()
      • get_ri()
      • legendre_polynomial_expansion()
      • loop_mie_over_radii()
      • loop_mie_over_wavelengths()
      • mie_ewp()
      • normalised_legendre_polynomial_expansion()
      • phase_from_legendre()
      • phase_from_normalised_legendre()
      • plot_diff_dict()
      • regrid()
      • track_regrid_diff()
    • srfm.plotting
      • map_extent()
    • srfm.quadrature
      • bessel_zero()
      • first_guess()
      • legendre()
      • newton_g()
      • quadrature()
      • quadrature101()
      • shift_quadrature()
    • srfm.rfm_functions
      • compile_rfm()
      • construct_rfm_driver_table()
      • construct_rfm_grid_file()
      • construct_rfm_output_levels_file()
      • get_rfm_optical_depths()
      • read_atm_file()
      • read_output()
      • read_output_prf()
      • write_atm_file()
      • write_xsc_file()
    • srfm.size_distribution
      • GaussianDistribution
        • GaussianDistribution.mean()
      • LogNormalDistribution
        • LogNormalDistribution.mean()
        • LogNormalDistribution.value()
      • SizeDistribution
        • SizeDistribution.mean()
      • create_distribution()
    • srfm.units
      • DU_to_col_den()
      • decimal_degree_to_DMS()
      • inv_cm_to_micron()
      • inv_cm_to_nm()
      • micron_to_inv_cm()
      • nm_to_inv_cm()
    • srfm.utilities
      • add_lyr_from_Layer()
      • calc_Rayleigh_opt_depths()
      • calc_grids()
      • calc_layer_bounds()
      • calc_layer_extent()
      • calc_layer_opt_thick_Rayleigh()
      • calc_tot_Rayleigh_opt_depth()
      • calc_tot_dtauc()
      • closest()
      • convert_spectral_radiance_to_bbt()
      • convolve_spectrum()
      • find_prime_factors()
      • get_altitude_prf()
      • json_handler()
      • line_break_str()
      • load_solar_spectrum_Gueymard20018()
      • mass_loading_from_number_conc()
      • memory_safe_np_zeros_2d()
      • monotonic()
      • number_conc_from_mass_loading()
      • read_ils()
      • scale_solar_spectrum()
      • show_runtime()
      • track_lev_to_track_lyr()
    • srfm.readers.read_iasi_l1c
    • srfm.read_iasi_l2
    • srfm.rfm_helper
    • srfm.main
    • srfm.iasi_main
    • srfm.inputs
    • srfm.orography
    • srfm.oxharp_main
SRFM
We use Google Analytics to understand traffic. Learn more.
  • SRFM documentation
  • View page source

SRFM documentation

Welcome the the Scattering Reference Forward Model (SRFM) documentation. This package is designed to manage satellite data and perform retrievals. It combines Python tooling with compiled Fortran extensions for radiative transfer.

The package was built and is maintained by Antonin Knizek as part of code belonging to the Earth Observation Data Group and the University of Oxford. For more info, comments or to leave feedback, please contact antonin.knizek@physics.ox.ac.uk or contact the EODG group.

Contents:

  • Overview
    • Components
    • Installation
    • Supported platforms and prerequisites
    • Building and packaging
    • Installing from dist/
    • Verification
    • Usage
    • External dependencies
    • Documentation
    • References
  • Examples
  • Basic examples
  • Driver table
    • General run and output
    • Spectral grids
    • Output geometry
    • Atmospheric calculation levels
    • RFM execution configuration
    • RFM driver sections
    • DISORT configuration
    • Scattering-layer configuration
    • Solar and viewing geometry
  • Memory-efficient calculations
    • Output retention
    • Compatibility interfaces
    • Benchmarking
  • Modules and Functions
    • srfm.ARIA_module
    • srfm.disort_functions
    • srfm.forward_model
    • srfm.layer
    • srfm.optical_properties
    • srfm.plotting
    • srfm.quadrature
    • srfm.rfm_functions
    • srfm.size_distribution
    • srfm.units
    • srfm.utilities
    • srfm.readers.read_iasi_l1c
    • srfm.read_iasi_l2
    • srfm.rfm_helper
    • srfm.main
    • srfm.iasi_main
    • srfm.inputs
    • srfm.orography
    • srfm.oxharp_main
Next

© Copyright 2026, Antonin Knizek, Roy Grainger.

Built with Sphinx using a theme provided by Read the Docs.