References#
Module containing submodules which load and interface with scientific references.
Cimino (1982)#
Module that provides the reference profiles from Cimino [1982], as well as interpolators for the profiles.
- xvamp.references.cimino_1982.get_h2s04_rel_permittivity(concentration, temperature, wavelength='x')[source]#
Calculate the real and imaginary parts of the relative permittivity of H2SO4 clouds.
- Parameters:
concentration (
Quantity) – Concentration of H2SO4 [%]temperature (
Quantity) – Temperature of the medium [K]wavelength (
Literal['s','x'] |Quantity, default:"x") – Wavelength for which to compute the permittivity values [cm]. If's'or'x'(for S-band, 11.32 cm, or X-band, 3.56 cm), then only the corresponding table is used; otherwise, the values are inter- or extrapolated between the two tables.
- Return type:
- Returns:
eps_prime_r – Real part of the relative permittivity [-]
eps_dprime_r – Imaginary part of the relative permittivity [-]
Note
Even if passing the exact same wavelength as one of the two tables will result in interpolation, possibly returning NaNs if the input concentration or temperature values are outside one of the two table’s data ranges.
Here, the imaginary part of the relative atmospheric permittivity has the opposite sign as in Duan et al. [2010].
- xvamp.references.cimino_1982.get_h2so4_droplet_polarization_volfrac(cloud_mass_density, eps_r_shell)[source]#
Compute the droplet polarization and volume fraction assuming a shell-like structure, following eq. (10).
- Parameters:
- Return type:
- Returns:
Pnu – Polarization per molar volume of the H2SO4 cloud droplets [-]
vol_frac_droplets – Volume fraction of the droplets [-]
Note
Here, the imaginary part of the relative atmospheric permittivity has the opposite sign as in Duan et al. [2010].
- xvamp.references.cimino_1982.D_DROPLET_CORE = <Quantity 2.5 g / cm3>#
Mass density of the droplet core
- xvamp.references.cimino_1982.D_DROPLET_SHELL = <Quantity 2. g / cm3>#
Mass density of the droplet shell
- xvamp.references.cimino_1982.EPS_DROPLETS_CORE = <Quantity 2.9>#
Estimated dielectric constant of the cloud droplet cores
- xvamp.references.cimino_1982.EXTRAPOLATE_DOWN_TO = 200.0#
Extrapolate the data down to this temperature [K]
- xvamp.references.cimino_1982.LAMBDA_S = 11.32#
Wavelength of S-band experiment [cm]
- xvamp.references.cimino_1982.LAMBDA_X = 3.56#
Wavelength of X-band experiment [cm]
- xvamp.references.cimino_1982.RATIO_MASS_DROPLETS = <Quantity 13.06401514>#
Ratio of the core mass to the shell mass
- xvamp.references.cimino_1982.RATIO_RADIUS_DROPLETS = <Quantity 0.97>#
Ratio of the core radius to the total droplet radius
- xvamp.references.cimino_1982.TABLES = ['fig7raw', 'fig8raw', 'fig9raw']#
Table numbers to load
- xvamp.references.cimino_1982.tables#
Loaded tables
Duan et al. (2010) Figures#
Module that provides the reference profiles from Duan et al. [2010], including some profiles only present in the Matlab reference code.
- xvamp.references.duan_et_al_2010.CO_FRACTION_NODES#
Nodes that define the CO molar fraction profile as pairs of altitude [km] and fraction [ppm]
- xvamp.references.duan_et_al_2010.CO_OLD_FRACTION_NODES = array([[30, 23], [40, 29]])#
Nodes that define the old CO molar fraction profile as pairs of altitude [km] and fraction [ppm]
- xvamp.references.duan_et_al_2010.ELECTRON_DENSITY_NODES#
Nodes that define the electron density profile as pairs of altitude [km] and 1e11*log(electron density [1/m3])
- xvamp.references.duan_et_al_2010.H2O_FRACTION_NODES#
Nodes that define the H2O molar fraction profile as pairs of altitude [km] and fraction [ppm]
- xvamp.references.duan_et_al_2010.H2O_OLD_FRACTION_NODES#
Nodes that define the old H2O molar fraction profile as pairs of altitude [km] and fraction [ppm]
- xvamp.references.duan_et_al_2010.H2SO4_3212_FRACTION_NODES#
Nodes that define the H2SO4 molar fraction profile from a modified Magellan orbit 3212 as pairs of altitude [km] and fraction [ppm]
- xvamp.references.duan_et_al_2010.H2SO4_FRACTION_NODES#
Nodes that define the H2SO4 molar fraction profile as pairs of altitude [km] and fraction [ppm]
- xvamp.references.duan_et_al_2010.OCS_FRACTION_NODES#
Nodes that define the OCS molar fraction profile as pairs of altitude [km] and fraction [ppm]
- xvamp.references.duan_et_al_2010.OCS_OLD_FRACTION_NODES#
Nodes that define the old OCS molar fraction profile as pairs of altitude [km] and fraction [ppm]
- xvamp.references.duan_et_al_2010.SO2_FRACTION_NODES#
Nodes that define the SO2 molar fraction profile as pairs of altitude [km] and fraction [ppm]
- xvamp.references.duan_et_al_2010.SO2_OLD_FRACTION_NODES#
Nodes that define the old SO2 molar fraction profile as pairs of altitude [km] and fraction [ppm]
- xvamp.references.duan_et_al_2010.TABLES = ['fig6b', 'fig7a', 'fig7b', 'fig7d', 'fig8a', 'fig8b', 'fig9a', 'fig9b', '4']#
Table numbers to load
- xvamp.references.duan_et_al_2010.co_molar_fraction = <xvamp.profile.Profile object>#
Carbon monoxide molar fraction profile from Duan et al. (2010)
- xvamp.references.duan_et_al_2010.co_old_molar_fraction = <xvamp.profile.Profile object>#
Carbon monoxide molar fraction profile from the reference code
- xvamp.references.duan_et_al_2010.electron_density = <xvamp.profile.Profile object>#
Electron density profile from Duan et al. (2010)
- xvamp.references.duan_et_al_2010.h2o_molar_fraction = <xvamp.profile.Profile object>#
Water vapor molar fraction profile from Duan et al. (2010)
- xvamp.references.duan_et_al_2010.h2o_old_molar_fraction = <xvamp.profile.Profile object>#
Water vapor molar fraction profile from the reference code
- xvamp.references.duan_et_al_2010.h2so4_3212_molar_fraction = <xvamp.profile.Profile object>#
Sulfuric acid molar fraction profile from the reference code from Magellan orbit 3212
- xvamp.references.duan_et_al_2010.h2so4_density_conc = <xvamp.profile.Profile object>#
Relationship profile between H2SO4 weight percentage of diluted sulfuric acid and the resulting mass density
- xvamp.references.duan_et_al_2010.h2so4_molar_fraction = <xvamp.profile.Profile object>#
Sulfuric acid molar fraction profile from Duan et al. (2010)
- xvamp.references.duan_et_al_2010.ocs_molar_fraction = <xvamp.profile.Profile object>#
Carbonyl sulfide molar fraction profile from Duan et al. (2010)
- xvamp.references.duan_et_al_2010.ocs_old_molar_fraction = <xvamp.profile.Profile object>#
Carbonyl sulfide molar fraction profile from the reference code
- xvamp.references.duan_et_al_2010.so2_molar_fraction = <xvamp.profile.Profile object>#
Sulfur dioxide molar fraction profile from Duan et al. (2010)
- xvamp.references.duan_et_al_2010.so2_old_molar_fraction = <xvamp.profile.Profile object>#
Sulfur dioxide molar fraction profile from the reference code
- xvamp.references.duan_et_al_2010.tables#
Loaded tables
James et al. (1997)#
Module that provides the reference profiles from James et al. [1997].
- xvamp.references.james_et_al_1997.TABLES = ['fig4bdroplets', 'fig4bnuclei', 'fig7']#
Table numbers to load
- xvamp.references.james_et_al_1997.cloud_concentration = <xvamp.profile.Profile object>#
Cloud H2SO4 weight percent profile
- xvamp.references.james_et_al_1997.cloud_mass_mixing_ratio = <xvamp.profile.Profile object>#
Mass mixing ratio of the clouds
- xvamp.references.james_et_al_1997.tables#
Loaded tables
Jenkins et al. (2002)#
Module that provides the reference profiles from Jenkins et al. [2002].
- xvamp.references.jenkins_et_al_2002.TABLES = ['fig6raw']#
Table numbers to load
- xvamp.references.jenkins_et_al_2002.h2so4_molar_fraction_0ppm_so2 = <xvamp.profile.Profile object>#
H2SO4 molar fraction profile from Jenkins et al. [2002] assuming 0 ppm SO2
- xvamp.references.jenkins_et_al_2002.h2so4_molar_fraction_100ppm_so2 = <xvamp.profile.Profile object>#
H2SO4 molar fraction profile from Jenkins et al. [2002] assuming 100 ppm SO2
- xvamp.references.jenkins_et_al_2002.h2so4_molar_fraction_150ppm_so2 = <xvamp.profile.Profile object>#
H2SO4 molar fraction profile from Jenkins et al. [2002] assuming 150 ppm SO2
- xvamp.references.jenkins_et_al_2002.h2so4_molar_fraction_200ppm_so2 = <xvamp.profile.Profile object>#
H2SO4 molar fraction profile from Jenkins et al. [2002] assuming 200 ppm SO2
- xvamp.references.jenkins_et_al_2002.h2so4_molar_fraction_50ppm_so2 = <xvamp.profile.Profile object>#
H2SO4 molar fraction profile from Jenkins et al. [2002] assuming 50 ppm SO2
- xvamp.references.jenkins_et_al_2002.tables#
Loaded tables
JPL Spectral Line Catalog (Pickett et al., 1998)#
Module that provides the JPL spectral line catalog from Pickett et al. [1998].
- xvamp.references.jpl_spectral_lines.COLUMNS = ['FREQ', 'ERR', 'LGINT', 'DR', 'ELO', 'GUP', 'TAG', 'QNFMT', "QN'", 'QN"']#
Column names in the catalog
- xvamp.references.jpl_spectral_lines.FORMATS = ['f8', 'f8', 'f8', 'i', 'f8', 'i', 'i', 'i', 'U12', 'U12']#
Column formats
- xvamp.references.jpl_spectral_lines.TABLES = {'OCS': 'c060001.cat', 'SO2': 'c064002.cat'}#
Tables to load
- xvamp.references.jpl_spectral_lines.UNITS = ['MHz', 'MHz', 'dex(nm2 MHz)', '', 'cm-1', '', '', '', '', '']#
Column units
- xvamp.references.jpl_spectral_lines.WIDTHS = [13, 8, 8, 2, 10, 3, 7, 4, 12, 12]#
Fixed widths of the catalog columns
- xvamp.references.jpl_spectral_lines.tables#
Loaded tables
Keating et al. (1985)#
Module that provides the background, reference atmospheric properties from Keating et al. [1985].
- xvamp.references.keating_et_al_1985.SZA = <Quantity [ 16., 34., 61., 90., 119., 146., 164.] deg>#
Solar zenith angles for tables 4-[4, 9-13, 5] [°]
- xvamp.references.keating_et_al_1985.SZA_TABLES = ['4-4', '4-9', '4-10', '4-11', '4-12', '4-13', '4-5']#
Table numbers that build the SZA-defined datacube between 150-250km
- xvamp.references.keating_et_al_1985.TABLES = ['4-6', '4-7', '4-15', '4-16', '4-4', '4-9', '4-10', '4-11', '4-12', '4-13', '4-5']#
Table numbers to load
- xvamp.references.keating_et_al_1985.dcube_100km_150km#
Physical and species quantities as a function of altitude and midnight/noon between 100-150km
- xvamp.references.keating_et_al_1985.dcube_150km_250km#
Physical and species quantities as a function of altitude and solar zenith angle between 150-250km
- xvamp.references.keating_et_al_1985.names_100km_150km = ['ALT', 'RHO', 'T', 'CO2', 'O', 'CO', 'HE', 'N', 'N2', 'M', 'NTOT', 'P', 'SS', 'MFP', 'HP', 'HRHO']#
Column (axis 1) names of of
dcube_100km_150km
- xvamp.references.keating_et_al_1985.names_150km_250km = ['ALT', 'RHO', 'T', 'CO2', 'O', 'CO', 'HE', 'N', 'N2', 'H', 'MMWT']#
Column (axis 1) names of of
dcube_150km_250km
- xvamp.references.keating_et_al_1985.species_day = <xvamp.profile.MultiProfile object>#
Species number density profiles (incl. total number density) at day
- xvamp.references.keating_et_al_1985.species_night = <xvamp.profile.MultiProfile object>#
Species number density profiles (incl. total number density) at night
- xvamp.references.keating_et_al_1985.tables#
Loaded tables
- xvamp.references.keating_et_al_1985.tpd_day = <xvamp.profile.MultiProfile object>#
Temperature, pressure, and mass density profiles at day
- xvamp.references.keating_et_al_1985.tpd_night = <xvamp.profile.MultiProfile object>#
Temperature, pressure, and mass density profiles at night
- xvamp.references.keating_et_al_1985.units_100km_150km = [Unit("km"), Unit("g / cm3"), Unit("K"), Unit("1 / cm3"), Unit("1 / cm3"), Unit("1 / cm3"), Unit("1 / cm3"), Unit("1 / cm3"), Unit("1 / cm3"), Unit("mol"), Unit("1 / cm3"), Unit("mbar"), Unit("cm / s"), Unit("cm"), Unit("km"), Unit("km")]#
Units of
dcube_100km_150km
- xvamp.references.keating_et_al_1985.units_150km_250km = [Unit("km"), Unit("g / cm3"), Unit("K"), Unit("1 / cm3"), Unit("1 / cm3"), Unit("1 / cm3"), Unit("1 / cm3"), Unit("1 / cm3"), Unit("1 / cm3"), Unit("1 / cm3"), Unit("g / mol")]#
Units of
dcube_150km_250km
Kolodner & Steffes (1998)#
Module that provides the reference profiles and some H2SO4 experiment formulas from Kolodner and Steffes [1998].
- xvamp.references.kolodner_steffes_1998.MU_H2SO4 = <Quantity 2.72e-18 Fr cm>#
Molecular dipole moment for gaseous sulfuric acid
- xvamp.references.kolodner_steffes_1998.TABLES = ['fig789']#
Table numbers to load
- xvamp.references.kolodner_steffes_1998.T_H2SO4 = <Quantity 553. K>#
Temperature of the experiment of Kolodner and Steffes [1998]
- xvamp.references.kolodner_steffes_1998.eps_prime_r_h2so4 = <Quantity 1.00058609>#
Real part of the relative permittivity of H2SO4 in the experiment
- xvamp.references.kolodner_steffes_1998.h2so4_mr_3212 = <xvamp.profile.Profile object>#
H2SO4 mixing ratio from Magellan orbit 3212
- xvamp.references.kolodner_steffes_1998.h2so4_mr_3213 = <xvamp.profile.Profile object>#
H2SO4 mixing ratio from Magellan orbit 3213
- xvamp.references.kolodner_steffes_1998.h2so4_mr_3214 = <xvamp.profile.Profile object>#
H2SO4 mixing ratio from Magellan orbit 3214
- xvamp.references.kolodner_steffes_1998.h2so4_mr_mean = <xvamp.profile.Profile object>#
Mean H2SO4 mixing ratio from Magellan orbits 3212, 3213 and 3214
- xvamp.references.kolodner_steffes_1998.rho_h2so4 = <Quantity 1.1844476e-06 mol / cm3>#
Molar density of H2SO4 in the experiment
- xvamp.references.kolodner_steffes_1998.tables#
Loaded tables
Magellan Data (Jenkins, 1996)#
Reference class that provides the profiles from the Magellan orbits no. 3212, 3213, and 3214 from Jenkins [1996] and Jenkins [1996] as processed by Jenkins et al. [1994].
- xvamp.references.magellan321x.get_wavelength_orbit(wavelength=None, orbit=None)[source]#
Return the dataset for a specific wavelength and/or orbit.
- Parameters:
- Return type:
- Returns:
mgn_abs – Subset of the
mgn_abs.datfilemgn_rtpd – Subset of the
mgn_rtpd.datfile
- xvamp.references.magellan321x.DESC_ABS = [('WAVELENGTH', 'U1', 3, ''), ('ORBIT_NUMBER', 'i', 5, ''), ('ALTITUDE', 'f8', 7, 'km'), ('ABSORPTIVITY', 'f8', 9, 'dB/km'), ('ABSORP_DEV', 'f8', 8, 'dB/km'), ('H2SO4_VOLMIX', 'f8', 6, 'ppm'), ('H2SO4_VM_DEV', 'f8', 6, 'ppm'), ('LATITUDE', 'f8', 7, '°'), ('LONGITUDE', 'f8', 8, '°'), ('ZENITH_ANGLE', 'f8', 8, '°'), ('LOCAL_TIME', 'f8', 7, 'h'), ('ERT', 'f8', 10, 's')]#
Data format description of the
mgn_abs.datfile
- xvamp.references.magellan321x.DESC_RTPD = [('WAVELENGTH', 'U1', 3, ''), ('ORBIT_NUMBER', 'i', 5, ''), ('ALTITUDE', 'f8', 7, 'km'), ('REFRACTIVITY', 'f8', 9, 'Nunit'), ('REFRACT_DEV', 'f8', 6, 'Nunit'), ('TEMPERATURE', 'f8', 7, 'K'), ('TEMP_DEV', 'f8', 6, 'K'), ('PRESSURE', 'f8', 9, 'bar'), ('PRESS_DEV', 'f8', 9, 'bar'), ('DENSITY', 'f8', 8, 'kg/m3'), ('DENS_DEV', 'f8', 8, 'kg/m3'), ('LATITUDE', 'f8', 7, '°'), ('LONGITUDE', 'f8', 8, '°'), ('ZENITH_ANGLE', 'f8', 8, '°'), ('LOCAL_TIME', 'f8', 7, 'h'), ('ERT', 'f8', 10, 's')]#
Data format description of the
mgn_rtpd.datfile
- xvamp.references.magellan321x.STR_CONVERTER = {0: <function <lambda>>}#
Convenience converter to strip whitespace from the wavelength field
- xvamp.references.magellan321x.TABLES = ['mgn_abs', 'mgn_rtpd']#
Table numbers to load
- xvamp.references.magellan321x.h2so4_mr_x_3212 = <xvamp.profile.Profile object>#
H2SO4 mixing ratio from Magellan orbit 3212 and X-band
- xvamp.references.magellan321x.h2so4_mr_x_3213 = <xvamp.profile.Profile object>#
H2SO4 mixing ratio from Magellan orbit 3213 and X-band
- xvamp.references.magellan321x.h2so4_mr_x_3214 = <xvamp.profile.Profile object>#
H2SO4 mixing ratio from Magellan orbit 3214 and X-band
- xvamp.references.magellan321x.tables#
Loaded tables
Marcq et al. (2006)#
Module that provides the reference profiles from Marcq et al. [2006].
- xvamp.references.marcq_et_al_2006.TABLES = ['fig8']#
Table numbers to load
- xvamp.references.marcq_et_al_2006.ocs_mr = <xvamp.profile.Profile object>#
OCS mixing ratio
- xvamp.references.marcq_et_al_2006.tables#
Loaded tables
Mogul et al. (2023, 2025)#
Module that provides the reference profiles from Mogul et al. [2023] and Mogul et al. [2025].
- xvamp.references.mogul_et_al_2023_2025.TABLES = ['LNMS.MixingRatios.N2.CO2']#
Table names to load
- xvamp.references.mogul_et_al_2023_2025.co2_molar_fraction = <xvamp.profile.Profile object>#
CO2 molar fraction [ppm]
- xvamp.references.mogul_et_al_2023_2025.co2_molar_fraction_error = <xvamp.profile.Profile object>#
CO2 molar fraction error [ppm]
- xvamp.references.mogul_et_al_2023_2025.n2_molar_fraction = <xvamp.profile.Profile object>#
N2 molar fraction [ppm]
- xvamp.references.mogul_et_al_2023_2025.n2_molar_fraction_error = <xvamp.profile.Profile object>#
N2 molar fraction error [ppm]
- xvamp.references.mogul_et_al_2023_2025.tables#
Loaded tables
Pätzold et al. (2007)#
Module that provides the reference profiles from Pätzold et al. [2007].
- xvamp.references.paetzold_et_al_2007.interpolate_el_density(sza)[source]#
Interpolate the electron density profiles from solar zenith angles between 50° and 113°.
- xvamp.references.paetzold_et_al_2007.DOYS = [196, 200, 202, 212, 218, 233, 234, 239]#
Day-of-years of the electron density profiles
- xvamp.references.paetzold_et_al_2007.SZAS = <Quantity [ 50. , 56. , 59. , 80. , 92.4, 113. , 113.4, 113.5] deg>#
Solar zenith angles [°] of the elctron density profiles
- xvamp.references.paetzold_et_al_2007.TABLES = ['fig4a-doy196', 'fig4b-doy200', 'fig4b-doy202', 'fig4b-doy212', 'fig5a-doy218', 'fig5b-doy233', 'fig5c-doy234', 'fig5d-doy239']#
Table numbers to load
- xvamp.references.paetzold_et_al_2007.UNIT_EL_DENSITY = Unit("1 / m3")#
Output unit of the electron density profile [1/m3]
- xvamp.references.paetzold_et_al_2007.el_density = <xvamp.profile.MultiProfile object>#
Electron density profiles at different solar zenith angles
- xvamp.references.paetzold_et_al_2007.sza_interpolating_basis = BoundedInterpolatingBasis(lower=0, upper=180, knots=array([ 50. , 56. , 59. , 80. , 92.4, 113. ]))#
Interpolating basis for the well-resolved SZA angles between 50° and 113°, returns a 2D array when called with each column representing the different knots
- xvamp.references.paetzold_et_al_2007.tables#
Loaded tables
Seiff et al. (1985)#
Module that provides the reference model from Seiff et al. [1985].
- xvamp.references.seiff_et_al_1985.LAT = <Quantity [30., 45., 60., 75., 85.] deg>#
Latitudes of tables 1-2[a-e]
- xvamp.references.seiff_et_al_1985.LAT_TABLES = ['1-2a', '1-2b', '1-2c', '1-2d', '1-2e']#
Table numbers of the 33-100km range for different latitudes
- xvamp.references.seiff_et_al_1985.TABLES = ['1-1', '1-3', '1-2a', '1-2b', '1-2c', '1-2d', '1-2e']#
Table numbers to load
- xvamp.references.seiff_et_al_1985.dcube_33km_100km#
Physical quantities as a function of altitude and latitude between 33-100km
- xvamp.references.seiff_et_al_1985.names_33km_100km = ['z', 'T', 'p', 'ρ']#
Column (axis 1) names of of
dcube_33km_100km
- xvamp.references.seiff_et_al_1985.tables#
Loaded tables
- xvamp.references.seiff_et_al_1985.units_33km_100km = [Unit("km"), Unit("K"), Unit("bar"), Unit("kg / m3")]#
Units of
dcube_33km_100km
Stratton (1968)#
Module that provides the atmospheric model from Stratton [1968].
von Zahn & Moroz (1985)#
Module that provides some data from von Zahn and Moroz [1985].
- xvamp.references.vonzahn_moroz_1985.AR_MR = <Quantity 7.e-05>#
Argon mixing ratio [-]
- xvamp.references.vonzahn_moroz_1985.CO2_MR = <Quantity 0.965>#
CO2 mixing ratio [-]
- xvamp.references.vonzahn_moroz_1985.CO2_MR_ERR = <Quantity 0.008>#
CO2 mixing ratio error [-]
- xvamp.references.vonzahn_moroz_1985.N2_MR = <Quantity 0.035>#
N2 mixing ratio [-]
- xvamp.references.vonzahn_moroz_1985.N2_MR_ERR = <Quantity 0.008>#
N2 mixing ratio error [-]
- xvamp.references.vonzahn_moroz_1985.ar_molar_fraction = <xvamp.profile.Profile object>#
Argon molar fraction profile from von Zahn and Moroz [1985]
Zasova et al. (2006)#
Module that provides the reference model from Zasova et al. [2006].
- xvamp.references.zasova_et_al_2006.TABLES = ['2', '3', '4', '5', '6']#
Table numbers to load
- xvamp.references.zasova_et_al_2006.tables#
Loaded tables