pedophysics package

Subpackages

Submodules

pedophysics.instruments module

pedophysics.instruments.Inst2FreqEC(soil)

Set missing values of soil.df.frequency_ec and return

This function iterates over each state in the ‘soil’ object, checking the type of instrument associated with the ‘soil’ object (‘EMI Dualem’ or ‘EMI EM38-DD’). If the current ‘frequency_ec’ value is NaN, the function sets a default frequency value (9e3 Hz for ‘EMI Dualem’ and 16e3 Hz for ‘EMI EM38-DD’) in both the ‘info’ attribute and the ‘df’ dataframe. If the ‘frequency_ec’ value is already set or the instrument type does not match, the function retains the existing value.

Parameters

soilobject

A custom soil object that contains:

dfDataFrame
Data Frame containing all the quantitative information of soil array-like attributes for each state

Returns

np.ndarray: Array containing the updated frequency of electric conductivity measurement values

Notes

This function modifies the soil object in-place by updating the df and info dataframes.

pedophysics.instruments.Inst2FreqP(soil)

Set missing values of soil.df.frequency_perm and return

This function iterates over each state in the ‘soil’ object. It checks the instrument type associated with the soil (‘GPR’, ‘TDR’, or ‘HydraProbe’). If the current ‘frequency_perm’ value is NaN, the function sets a default frequency value specific to the instrument type (1e9 Hz for ‘GPR’, 200e6 Hz for ‘TDR’, and 50e6 Hz for ‘HydraProbe’) in both the ‘info’ attribute and the ‘df’ DataFrame. If the ‘frequency_perm’ value is already set or the instrument type does not match any specified case, the function retains the existing value.

Parameters

soilobject

A custom soil object that contains:

dfDataFrame
Data Frame containing all the quantitative information of soil array-like attributes for each state

Returns

np.ndarray: Array containing the updated frequency of dielectric permittivity measurement values

Notes

This function modifies the soil object in-place by updating the df and info dataframes.

pedophysics.main module

pedophysics.simulate module

class pedophysics.simulate.Soil(**kwargs)

Bases: object

A class to represent a soil sample with its characteristics.

Attributes

temperaturearray-like: Soil bulk temperature [K]
waterarray-like: Soil volumetric water content [m**3/m**3]
salinityarray-like: Soil salinity (NaCl) of the bulk pore fluid [mol/L]
sandarray-like: Soil sand content [g/g]*100
siltarray-like: Soil silt content [g/g]*100
clayarray-like: Soil clay content [g/g]*100
porosityarray-like: Soil porosity [m**3/m**3]
bulk_densityarray-like: Soil bulk density [kg/m**3]
particle_densityarray-like: Soil particle density [kg/m**3]
CECarray-like: Soil cation exchange capacity [meq/100g]
orgmarray-like: Soil organic matter [g/g]*100
bulk_permarray-like: Soil bulk real relative dielectric permittivity [-]
bulk_perm_infarray-like: Soil bulk real relative permittivity at infinite frequency [-]
water_permarray-like: Soil water phase real dielectric permittivity [-]
solid_permarray-like: Soil solid real relative dielectric permittivity phase [-]
air_permarray-like: Soil air real relative dielectric permittivity phase [-]
offset_permarray-like: Soil bulk real relative dielectric permittivity when soil bulk real electrical conductivity is zero [-]
bulk_ecarray-like: Soil bulk real electrical conductivity [S/m]
bulk_ec_tcarray-like: Soil bulk real electrical conductivity temperature corrected (298.15 K) [S/m]
bulk_ec_dcarray-like: Soil bulk real electrical conductivity direct current [S/m]
bulk_ec_dc_tcarray-like: Soil bulk real electrical conductivity direct current (0 Hz) temperature corrected (298.15 K) [S/m]
water_ecarray-like: Soil water real electrical conductivity [S/m]
s_ecarray-like: Soil bulk real surface electrical conductivity [S/m]
solid_ecarray-like: Soil solid real electrical conductivity [S/m]
dry_ecarray-like: Soil bulk real electrical conductivity at zero water content [S/m]
sat_ecarray-like: Soil bulk real electrical conductivity at saturation water content [S/m]
frequency_permarray-like: Frequency of dielectric permittivity measurement [Hz]
frequency_ecarray-like: Frequency of electric conductivity measurement [Hz]
Lsingle-value: Soil scalar depolarization factor of solid particles (effective medium theory) [-]
Lwsingle-value: Soil scalar depolarization factor of water aggregates (effective medium theory) [-]
msingle-value: Soil cementation factor as defined in Archie law [-]
nsingle-value: Soil saturation factor as defined in Archie second law [-]
alphasingle-value: Soil alpha exponent as defined in volumetric mixing theory [-]
texturestr: Soil texture according to USDA convention: “Sand”, “Loamy sand”, “Sandy loam”, “Loam”, “Silt loam”, “Silt”, “Sandy clay loam”, “Clay loam”, “Silty clay loam”, “Sandy clay”, “Clay”, “Silty clay”
instrumentstr: Instrument utilized: ‘HydraProbe’, ‘TDR’, ‘GPR’, ‘Miller 400D’, ‘Dualem’
infoDataFrame: Data Frame containing descriptive information about how each array-like attribute was determined or modified.
dfDataFrame: Data Frame containing the quantitative information of all soil array-like attributes for each state.
Esingle-value: Empirical constant as in Rohades model [-]
Fsingle-value: Empirical constant as in Rohades model [-]
roundnint: Number of decimal places to round results.
range_ratiosingle-value: Factor for extending extrapolation domain during fitting modelling
n_statesint: Number of soil states

Notes

Attributes provided by the user that do not match the expected types or values will raise a ValueError.

pedophysics package

Subpackages

Submodules

pedophysics.instruments module

Parameters

Returns

Notes

Parameters

Returns

Notes

pedophysics.main module

pedophysics.simulate module

Attributes

Notes

Module contents