utopia-pkg
Example usage
Changelog
Contributing
Code of Conduct
API Reference
utopia-pkg
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
_
__repr__() (utopia.objects.box_class.Box method)
(utopia.objects.particulate_classes.Particulates method)
(utopia.objects_generation.Box method)
(utopia.objects_generation.Particulates method)
__version__ (in module utopia)
A
A1 (in module dry_deposition_MS)
A2 (in module dry_deposition_MS)
A3 (in module dry_deposition_MS)
A_w (in module rc_sea_spray)
add_compartment() (utopia.objects.box_class.Box method)
(utopia.objects_generation.Box method)
add_dataframe() (utopia.results_processing.pdf_reporting.PDFReport method)
add_dict() (utopia.results_processing.pdf_reporting.PDFReport method)
add_figure() (utopia.results_processing.pdf_reporting.PDFReport method)
add_particles() (utopia.objects.compartment_classes.Compartment method)
(utopia.objects_generation.Compartment method)
add_text() (utopia.results_processing.pdf_reporting.PDFReport method)
addFlows_to_results_df() (utopia.results_processing.process_results.ResultsProcessor method)
advective_transport() (in module RC_generator)
aerosolization_flux() (in module rc_sea_spray)
aerosolization_rate_constant() (in module rc_sea_spray)
assign_box() (utopia.objects.compartment_classes.Compartment method)
(utopia.objects_generation.Compartment method)
assign_compartment() (utopia.objects.particulate_classes.Particulates method)
(utopia.objects_generation.Particulates method)
B
base_path (utopia.utopia.utopiaModel attribute)
Bconexions (utopia.objects.box_class.Box attribute)
(utopia.objects_generation.Box attribute)
Bdepth_m (utopia.objects.box_class.Box attribute)
(utopia.objects_generation.Box attribute)
beaching() (in module RC_generator)
BF_density_kg_m3 (utopia.objects.particulate_classes.ParticulatesBF attribute)
(utopia.objects_generation.ParticulatesBF attribute)
BF_thickness_um (utopia.objects.particulate_classes.ParticulatesBF attribute)
(utopia.objects_generation.ParticulatesBF attribute)
biofouling() (in module RC_generator)
Blength_m (utopia.objects.box_class.Box attribute)
(utopia.objects_generation.Box attribute)
Bname (utopia.objects.box_class.Box attribute)
(utopia.objects_generation.Box attribute)
Box (class in utopia.objects.box_class)
(class in utopia.objects_generation)
burial() (in module RC_generator)
Bvolume_m3 (utopia.objects.box_class.Box attribute)
(utopia.objects_generation.Box attribute)
Bwidth_m (utopia.objects.box_class.Box attribute)
(utopia.objects_generation.Box attribute)
C
C (in module rc_sea_spray)
calc_Bvolume_m3() (utopia.objects.box_class.Box method)
(utopia.objects_generation.Box method)
calc_numConc() (utopia.objects.particulate_classes.Particulates method)
(utopia.objects_generation.Particulates method)
calc_particleConcentration_Nm3_initial() (utopia.objects.compartment_classes.Compartment method)
(utopia.objects_generation.Compartment method)
calc_vol_fromBox() (utopia.objects.compartment_classes.Compartment method)
(utopia.objects_generation.Compartment method)
calc_volume() (utopia.objects.compartment_classes.Compartment method)
(utopia.objects.particulate_classes.Particulates method)
(utopia.objects_generation.Compartment method)
(utopia.objects_generation.Particulates method)
calc_volume_heter() (utopia.objects.particulate_classes.ParticulatesSPM method)
(utopia.objects_generation.ParticulatesSPM method)
calculate_rising_velocity() (in module rc_settling)
calculate_settling() (in module dry_deposition_MS)
calculate_settling_velocity() (in module rc_settling)
Cdepth_m (utopia.objects.compartment_classes.Compartment attribute)
(utopia.objects_generation.Compartment attribute)
check_required_keys() (utopia.utopia.utopiaModel static method)
Clength_m (utopia.objects.compartment_classes.Compartment attribute)
(utopia.objects_generation.Compartment attribute)
Cname (utopia.objects.compartment_classes.Compartment attribute)
(utopia.objects_generation.Compartment attribute)
Compartment (class in utopia.objects.compartment_classes)
(class in utopia.objects_generation)
compartment_air (class in utopia.objects.compartment_classes)
(class in utopia.objects_generation)
compartment_deep_soil (class in utopia.objects.compartment_classes)
(class in utopia.objects_generation)
compartment_massBalance() (in module utopia.results_processing.mass_balance_check)
compartment_sediment (class in utopia.objects.compartment_classes)
(class in utopia.objects_generation)
compartment_soil_surface (class in utopia.objects.compartment_classes)
(class in utopia.objects_generation)
compartment_surfaceSea_water (class in utopia.objects.compartment_classes)
(class in utopia.objects_generation)
compartment_water (class in utopia.objects.compartment_classes)
(class in utopia.objects_generation)
compartments (utopia.objects.box_class.Box attribute)
(utopia.objects_generation.Box attribute)
config (utopia.utopia.utopiaModel attribute)
connexions (utopia.objects.compartment_classes.Compartment attribute)
(utopia.objects_generation.Compartment attribute)
create_inputsTable_UTOPIA
module
create_inputsTable_UTOPIA() (in module create_inputsTable_UTOPIA)
create_rateConstants_table() (utopia.results_processing.process_results.ResultsProcessor method)
CsurfaceArea_m2 (utopia.objects.compartment_classes.Compartment attribute)
(utopia.objects_generation.Compartment attribute)
Cvolume_m3 (utopia.objects.compartment_classes.Compartment attribute)
(utopia.objects_generation.Compartment attribute)
Cwidth_m (utopia.objects.compartment_classes.Compartment attribute)
(utopia.objects_generation.Compartment attribute)
D
d_p (in module rc_sea_spray)
data (utopia.utopia.utopiaModel attribute)
defouling() (in module RC_generator)
density_air_kg_m3 (in module utopia.globalConstants)
density_seaWater_kg_m3 (in module utopia.globalConstants)
density_w_21C_kg_m3 (in module utopia.globalConstants)
deposition_rate() (in module rc_dry_deposition)
description (utopia.objects.box_class.Box attribute)
(utopia.objects_generation.Box attribute)
diameter_m (utopia.objects.particulate_classes.Particulates attribute)
(utopia.objects.particulate_classes.ParticulatesBF attribute)
(utopia.objects.particulate_classes.ParticulatesSPM attribute)
(utopia.objects_generation.Particulates attribute)
(utopia.objects_generation.ParticulatesBF attribute)
(utopia.objects_generation.ParticulatesSPM attribute)
diameter_um (utopia.objects.particulate_classes.Particulates attribute)
(utopia.objects.particulate_classes.ParticulatesBF attribute)
(utopia.objects.particulate_classes.ParticulatesSPM attribute)
(utopia.objects_generation.Particulates attribute)
(utopia.objects_generation.ParticulatesBF attribute)
(utopia.objects_generation.ParticulatesSPM attribute)
discorporation() (in module RC_generator)
dispersing_comp_list (in module utopia.results_processing.emission_fractions_calculation)
dragCoefficient() (in module dry_deposition_MS)
dry_deposition() (in module RC_generator)
dry_deposition_MS
module
E
eliminationProcesses() (in module fill_interactions_df)
(in module fill_interactions_dictionaries)
emission_factor() (in module rc_sea_spray)
emission_fractions_calculations() (in module utopia.results_processing.emission_fractions_calculation)
estimate_emission_fractions() (in module utopia.results_processing.emission_fractions_calculation)
(utopia.results_processing.process_results.ResultsProcessor method)
estimate_exposure_indicators() (utopia.results_processing.process_results.ResultsProcessor method)
estimate_flows() (utopia.results_processing.process_results.ResultsProcessor method)
Exposure_indicators_calculation() (in module utopia.results_processing.exposure_indicators_calculation)
extract_results_by_compartment() (utopia.results_processing.process_results.ResultsProcessor method)
F
fill_interactions_df
module
fill_interactions_dictionaries
module
fillInteractions_fun_OOP() (in module fill_interactions_df)
fillInteractions_fun_OOP_dict() (in module fill_interactions_dictionaries)
flowVelocity_m_s (utopia.objects.compartment_classes.compartment_air attribute)
(utopia.objects.compartment_classes.compartment_surfaceSea_water attribute)
(utopia.objects.compartment_classes.compartment_water attribute)
(utopia.objects_generation.compartment_air attribute)
(utopia.objects_generation.compartment_surfaceSea_water attribute)
(utopia.objects_generation.compartment_water attribute)
fragmentation() (in module RC_generator)
full_config (in module utopia.examples_input)
full_data (in module utopia.examples_input)
G
G (utopia.objects.compartment_classes.compartment_surfaceSea_water attribute)
(utopia.objects.compartment_classes.compartment_water attribute)
(utopia.objects_generation.compartment_surfaceSea_water attribute)
(utopia.objects_generation.compartment_water attribute)
g0 (in module dry_deposition_MS)
g_m_s2 (in module utopia.globalConstants)
generate_coding_dictionaries() (utopia.utopia.utopiaModel method)
generate_flows_dict() (utopia.results_processing.process_results.ResultsProcessor method)
generate_fsd_matrix() (in module utopia.helpers)
generate_objects() (in module objects_generation)
(in module utopia.objects_generation)
generate_particles_dataframe() (utopia.utopia.utopiaModel method)
generate_particles_from_df() (in module readinputs_from_csv)
generate_rate_constants
module
generate_rate_constants() (in module generate_rate_constants)
generate_system_species_list() (in module readinputs_from_csv)
get_config_data() (in module utopia.datasets)
get_settling() (in module dry_deposition_MS)
H
h (in module rc_sea_spray)
handle_value() (in module utopia.helpers)
header() (utopia.results_processing.pdf_reporting.PDFReport method)
heteroaggregate_breackup() (in module RC_generator)
heteroaggregation() (in module RC_generator)
I
I_rainfall_mm (utopia.objects.compartment_classes.compartment_air attribute)
(utopia.objects_generation.compartment_air attribute)
inboxProcess() (in module fill_interactions_df)
inboxProcess_dict() (in module fill_interactions_dictionaries)
instantiate_compartments() (in module readinputs_from_csv)
instantiateParticles_from_csv() (in module readinputs_from_csv)
interactionProcess() (in module fill_interactions_df)
interactionProcess_dict() (in module fill_interactions_dictionaries)
K
k_a (in module rc_sea_spray)
k_B_J_K (in module utopia.globalConstants)
kineticCstdrySettlingNewtonSphere() (in module dry_deposition_MS)
L
load_csv_column() (utopia.utopia.utopiaModel static method)
load_json_file() (utopia.utopia.utopiaModel static method)
load_parameters() (utopia.utopia.utopiaModel method)
M
mass_to_num() (in module utopia.helpers)
massBalance() (in module utopia.results_processing.mass_balance_check)
mfpAir (in module dry_deposition_MS)
mixing() (in module RC_generator)
model (utopia.results_processing.process_results.ResultsProcessor attribute)
modify_and_save_data() (utopia.utopia.utopiaModel method)
module
create_inputsTable_UTOPIA
dry_deposition_MS
fill_interactions_df
fill_interactions_dictionaries
generate_rate_constants
montecarlo_analysis
objects_generation
rc_dry_deposition
RC_generator
rc_sea_spray
rc_settling
rc_wet_deposition
readinputs_from_csv
utopia
utopia.data
utopia.datasets
utopia.examples_input
utopia.globalConstants
utopia.helpers
utopia.objects
utopia.objects.box_class
utopia.objects.compartment_classes
utopia.objects.particulate_classes
utopia.objects_generation
utopia.results_processing
utopia.results_processing.emission_fractions_calculation
utopia.results_processing.exposure_indicators_calculation
utopia.results_processing.mass_balance_check
utopia.results_processing.pdf_reporting
utopia.results_processing.process_results
utopia.solver_steady_state
utopia.utopia
montecarlo_analysis
module
mu_air_21C_kg_ms (in module utopia.globalConstants)
mu_air_21C_mPas (in module utopia.globalConstants)
mu_w_21C_kg_ms (in module utopia.globalConstants)
mu_w_21C_mPas (in module utopia.globalConstants)
muAir (in module dry_deposition_MS)
N
num_to_mass() (in module utopia.helpers)
O
objects_generation
module
P
parentMP (utopia.objects.particulate_classes.ParticulatesBF attribute)
(utopia.objects.particulate_classes.ParticulatesSPM attribute)
(utopia.objects_generation.ParticulatesBF attribute)
(utopia.objects_generation.ParticulatesSPM attribute)
parentSPM (utopia.objects.particulate_classes.ParticulatesSPM attribute)
(utopia.objects_generation.ParticulatesSPM attribute)
particles (utopia.objects.compartment_classes.Compartment attribute)
(utopia.objects_generation.Compartment attribute)
particles_df (utopia.utopia.utopiaModel attribute)
Particulates (class in utopia.objects.particulate_classes)
(class in utopia.objects_generation)
ParticulatesBF (class in utopia.objects.particulate_classes)
(class in utopia.objects_generation)
ParticulatesSPM (class in utopia.objects.particulate_classes)
(class in utopia.objects_generation)
Pcomposition (utopia.objects.particulate_classes.Particulates attribute)
(utopia.objects.particulate_classes.ParticulatesBF attribute)
(utopia.objects.particulate_classes.ParticulatesSPM attribute)
(utopia.objects_generation.Particulates attribute)
(utopia.objects_generation.ParticulatesBF attribute)
(utopia.objects_generation.ParticulatesSPM attribute)
Pdensity_kg_m3 (utopia.objects.particulate_classes.Particulates attribute)
(utopia.objects.particulate_classes.ParticulatesBF attribute)
(utopia.objects.particulate_classes.ParticulatesSPM attribute)
(utopia.objects_generation.Particulates attribute)
(utopia.objects_generation.ParticulatesBF attribute)
(utopia.objects_generation.ParticulatesSPM attribute)
PDFReport (class in utopia.results_processing.pdf_reporting)
PdimensionX_m (utopia.objects.particulate_classes.Particulates attribute)
(utopia.objects.particulate_classes.ParticulatesBF attribute)
(utopia.objects.particulate_classes.ParticulatesSPM attribute)
(utopia.objects_generation.Particulates attribute)
(utopia.objects_generation.ParticulatesBF attribute)
PdimensionX_um (utopia.objects.particulate_classes.Particulates attribute)
(utopia.objects_generation.Particulates attribute)
PdimensionY_m (utopia.objects.particulate_classes.Particulates attribute)
(utopia.objects.particulate_classes.ParticulatesBF attribute)
(utopia.objects.particulate_classes.ParticulatesSPM attribute)
(utopia.objects_generation.Particulates attribute)
(utopia.objects_generation.ParticulatesBF attribute)
PdimensionY_um (utopia.objects.particulate_classes.Particulates attribute)
(utopia.objects_generation.Particulates attribute)
PdimensionZ_m (utopia.objects.particulate_classes.Particulates attribute)
(utopia.objects.particulate_classes.ParticulatesBF attribute)
(utopia.objects.particulate_classes.ParticulatesSPM attribute)
(utopia.objects_generation.Particulates attribute)
(utopia.objects_generation.ParticulatesBF attribute)
PdimensionZ_um (utopia.objects.particulate_classes.Particulates attribute)
(utopia.objects_generation.Particulates attribute)
Pemiss_t_y (utopia.objects.particulate_classes.Particulates attribute)
(utopia.objects_generation.Particulates attribute)
percolation() (in module RC_generator)
Pform (utopia.objects.particulate_classes.Particulates attribute)
(utopia.objects.particulate_classes.ParticulatesBF attribute)
(utopia.objects_generation.Particulates attribute)
(utopia.objects_generation.ParticulatesBF attribute)
plot_compartment_distribution() (utopia.results_processing.process_results.ResultsProcessor method)
plot_emission_fractions() (in module utopia.results_processing.emission_fractions_calculation)
plot_fractionDistribution_heatmaps() (utopia.results_processing.process_results.ResultsProcessor method)
plot_rateConstants() (utopia.results_processing.process_results.ResultsProcessor method)
Pname (utopia.objects.particulate_classes.Particulates attribute)
(utopia.objects.particulate_classes.ParticulatesBF attribute)
(utopia.objects.particulate_classes.ParticulatesSPM attribute)
(utopia.objects_generation.Particulates attribute)
(utopia.objects_generation.ParticulatesBF attribute)
(utopia.objects_generation.ParticulatesSPM attribute)
Pnumber_t0 (utopia.objects.particulate_classes.Particulates attribute)
(utopia.objects_generation.Particulates attribute)
process_all() (utopia.results_processing.process_results.ResultsProcessor method)
process_flows() (in module utopia.helpers)
process_flows_comp() (in module utopia.helpers)
process_results() (utopia.results_processing.process_results.ResultsProcessor method)
processed_results (utopia.results_processing.process_results.ResultsProcessor attribute)
processess (utopia.objects.compartment_classes.Compartment attribute)
(utopia.objects.compartment_classes.compartment_air attribute)
(utopia.objects.compartment_classes.compartment_deep_soil attribute)
(utopia.objects.compartment_classes.compartment_sediment attribute)
(utopia.objects.compartment_classes.compartment_soil_surface attribute)
(utopia.objects.compartment_classes.compartment_surfaceSea_water attribute)
(utopia.objects.compartment_classes.compartment_water attribute)
(utopia.objects_generation.Compartment attribute)
(utopia.objects_generation.compartment_air attribute)
(utopia.objects_generation.compartment_deep_soil attribute)
(utopia.objects_generation.compartment_sediment attribute)
(utopia.objects_generation.compartment_soil_surface attribute)
(utopia.objects_generation.compartment_surfaceSea_water attribute)
(utopia.objects_generation.compartment_water attribute)
Pshape (utopia.objects.particulate_classes.Particulates attribute)
(utopia.objects.particulate_classes.ParticulatesBF attribute)
(utopia.objects.particulate_classes.ParticulatesSPM attribute)
(utopia.objects_generation.Particulates attribute)
(utopia.objects_generation.ParticulatesBF attribute)
(utopia.objects_generation.ParticulatesSPM attribute)
R
R (utopia.results_processing.process_results.ResultsProcessor attribute)
radius_m (utopia.objects.particulate_classes.ParticulatesBF attribute)
(utopia.objects.particulate_classes.ParticulatesSPM attribute)
(utopia.objects_generation.Particulates attribute)
(utopia.objects_generation.ParticulatesBF attribute)
(utopia.objects_generation.ParticulatesSPM attribute)
rc_dry_deposition
module
RC_generator
module
rc_sea_spray
module
rc_settling
module
rc_wet_deposition
module
readinputs_from_csv
module
Results_extended (utopia.results_processing.process_results.ResultsProcessor attribute)
ResultsProcessor (class in utopia.results_processing.process_results)
ReynoldsNumberFromStokes() (in module dry_deposition_MS)
ReynoldsNumberFromVg() (in module dry_deposition_MS)
rho_p (in module rc_sea_spray)
rhoAir (in module dry_deposition_MS)
rising() (in module RC_generator)
run() (utopia.utopia.utopiaModel method)
run_mc_analysis() (in module montecarlo_analysis)
runoff_transport() (in module RC_generator)
S
save_json_file() (utopia.utopia.utopiaModel method)
sea_spray_aerosol() (in module RC_generator)
sed_density (in module utopia.globalConstants)
sed_porosity (in module utopia.globalConstants)
sediment_resuspension() (in module RC_generator)
sequestration_deep_soils() (in module RC_generator)
set_interactions() (in module readinputs_from_csv)
settling() (in module RC_generator)
settling_velocity() (in module rc_sea_spray)
soil_air_resuspension() (in module RC_generator)
soil_convection() (in module RC_generator)
solve_ODES_SS() (in module utopia.solver_steady_state)
solver_SS() (in module utopia.solver_steady_state)
species (utopia.objects.particulate_classes.ParticulatesBF attribute)
(utopia.objects.particulate_classes.ParticulatesSPM attribute)
(utopia.objects_generation.ParticulatesBF attribute)
(utopia.objects_generation.ParticulatesSPM attribute)
SPM_mgL (utopia.objects.compartment_classes.compartment_surfaceSea_water attribute)
(utopia.objects.compartment_classes.compartment_water attribute)
(utopia.objects_generation.compartment_surfaceSea_water attribute)
(utopia.objects_generation.compartment_water attribute)
sum_column_values() (in module utopia.helpers)
summarize() (utopia.utopia.utopiaModel method)
T
t_half_d (utopia.objects.particulate_classes.Particulates attribute)
(utopia.objects.particulate_classes.ParticulatesBF attribute)
(utopia.objects_generation.Particulates attribute)
(utopia.objects_generation.ParticulatesBF attribute)
T_K (utopia.objects.compartment_classes.compartment_air attribute)
(utopia.objects.compartment_classes.compartment_surfaceSea_water attribute)
(utopia.objects.compartment_classes.compartment_water attribute)
(utopia.objects_generation.compartment_air attribute)
(utopia.objects_generation.compartment_surfaceSea_water attribute)
(utopia.objects_generation.compartment_water attribute)
transportProcess() (in module fill_interactions_df)
(in module fill_interactions_dictionaries)
U
U10 (in module rc_sea_spray)
utopia
module
utopia.data
module
utopia.datasets
module
utopia.examples_input
module
utopia.globalConstants
module
utopia.helpers
module
utopia.objects
module
utopia.objects.box_class
module
utopia.objects.compartment_classes
module
utopia.objects.particulate_classes
module
utopia.objects_generation
module
utopia.results_processing
module
utopia.results_processing.emission_fractions_calculation
module
utopia.results_processing.exposure_indicators_calculation
module
utopia.results_processing.mass_balance_check
module
utopia.results_processing.pdf_reporting
module
utopia.results_processing.process_results
module
utopia.solver_steady_state
module
utopia.utopia
module
utopiaModel (class in utopia.utopia)
V
v_sed_trans (in module utopia.globalConstants)
validate_inputs() (utopia.utopia.utopiaModel method)
W
waterFlow_m3_s (utopia.objects.compartment_classes.compartment_surfaceSea_water attribute)
(utopia.objects.compartment_classes.compartment_water attribute)
(utopia.objects_generation.compartment_surfaceSea_water attribute)
(utopia.objects_generation.compartment_water attribute)
wet_deposition() (in module RC_generator)
wet_deposition_rate() (in module rc_wet_deposition)
wind_speed_m_s (utopia.objects.compartment_classes.compartment_air attribute)
(utopia.objects_generation.compartment_air attribute)
wind_trasport() (in module RC_generator)