MONARCHS
Installing MONARCHS
Running MONARCHS (a quickstart guide)
Tips and tricks
Setting up your own model run
Running MONARCHS with a Digital Elevation Model (DEM)
Generating plots
Formatting input meteorological data
model_setup
variable reference
Common errors and debugging
Making changes to MONARCHS
Code structure
API Reference
MONARCHS
Index
Index
B
|
C
|
D
|
E
|
F
|
H
|
I
|
K
|
L
|
M
|
P
|
R
|
S
|
T
|
V
|
W
B
bare_ice_albedo (in module monarchs.physics.constants)
built-in function
extract_args.extract_firn_arrays()
extract_args.extract_lake_variables()
extract_args.extract_lid_variables()
extract_args.extract_met_data()
extract_args.extract_scalars()
extract_args.pack_args()
heateqn_nb.get_k_and_kappa()
heateqn_nb.heateqn()
heateqn_nb.heateqn_lid()
heateqn_nb.propagate_temperature()
heateqn_nb.solve_tridiagonal()
loop_over_grid.loop_over_grid_numba()
monarchs.core.configuration.create_defaults_for_missing_flags()
monarchs.core.configuration.create_output_folders()
monarchs.core.configuration.handle_incompatible_flags()
monarchs.core.configuration.handle_invalid_values()
monarchs.core.configuration.jit_modules()
monarchs.core.configuration.parse_args()
monarchs.core.debug.neighbourhood_check()
monarchs.core.driver.check_firn_met_consistency()
monarchs.core.driver.check_for_reload_from_dump()
monarchs.core.driver.get_snow_sum()
monarchs.core.driver.initialise_model_data()
monarchs.core.driver.main()
monarchs.core.driver.monarchs()
monarchs.core.driver.print_model_end_of_timestep_messages()
monarchs.core.driver.setup_toggle_dict()
monarchs.core.driver.update_met_conditions()
monarchs.core.dump_model_state.dump_state()
monarchs.core.dump_model_state.reload_from_dump()
monarchs.core.error_handling.calc_grid_mass()
monarchs.core.error_handling.check_correct()
monarchs.core.error_handling.check_for_mass_conservation()
monarchs.core.error_handling.check_for_single_column_errors()
monarchs.core.error_handling.check_grid_correctness()
monarchs.core.error_handling.generic_error()
monarchs.core.initial_conditions.check_for_isolated_cells()
monarchs.core.initial_conditions.create_model_grid()
monarchs.core.initial_conditions.initialise_firn_profile()
monarchs.core.initial_conditions.rho_init_emp()
monarchs.core.load_model_setup.get_model_setup()
monarchs.core.loop_over_grid.chunk_grid()
monarchs.core.loop_over_grid.loop_over_grid()
monarchs.core.loop_over_grid.process_chunk()
monarchs.core.model_grid.get_spec()
monarchs.core.model_grid.initialise_iceshelf()
monarchs.core.model_output.add_lat_long()
monarchs.core.model_output.convert_bool_dtypes()
monarchs.core.model_output.create_dimensions()
monarchs.core.model_output.create_variable()
monarchs.core.model_output.get_variable_dims()
monarchs.core.model_output.interpolate_model_output()
monarchs.core.model_output.setup_output()
monarchs.core.model_output.update_model_output()
monarchs.core.utils.add_edge_water()
monarchs.core.utils.add_random_water()
monarchs.core.utils.calc_mass_sum()
monarchs.core.utils.check_energy_conservation()
monarchs.core.utils.do_not_jit()
monarchs.core.utils.find_nearest()
monarchs.core.utils.get_2d_grid()
monarchs.core.utils.get_num_cores()
monarchs.core.utils.memory_tracker()
monarchs.core.utils.spinup()
monarchs.dem_utils.create_dem_gaussian_test_case.export_gaussian_dem()
monarchs.dem_utils.create_dem_gaussian_test_case.interpolate_func_to_dem()
monarchs.dem_utils.create_dem_planar_test_case.export_planar_dem()
monarchs.dem_utils.load_dem.bounding_box_diagnostic_plots()
monarchs.dem_utils.load_dem.export_DEM()
monarchs.dem_utils.load_dem.generate_diagnostic_plots()
monarchs.dem_utils.load_dem.get_xy_distance()
monarchs.dem_utils.load_dem.interpolate_DEM()
monarchs.physics.firn_column.calc_height_change()
monarchs.physics.firn_column.firn_column()
monarchs.physics.heateqn.get_k_and_kappa()
monarchs.physics.heateqn.heateqn()
monarchs.physics.heateqn.heateqn_lid()
monarchs.physics.heateqn.propagate_temperature()
monarchs.physics.heateqn.solve_tridiagonal()
monarchs.physics.lake.calc_height_adjustment()
monarchs.physics.lake.freeze_pre_lake()
monarchs.physics.lake.lake_development()
monarchs.physics.lake.lake_formation()
monarchs.physics.lake.radiative_transfer()
monarchs.physics.lake.turbulent_mixing()
monarchs.physics.lateral_movement.calc_available_water_ice_lens()
monarchs.physics.lateral_movement.calc_available_water_lake()
monarchs.physics.lateral_movement.calc_catchment_outflow()
monarchs.physics.lateral_movement.find_biggest_neighbour()
monarchs.physics.lateral_movement.get_neighbour_water_levels()
monarchs.physics.lateral_movement.handle_edge_cases()
monarchs.physics.lateral_movement.handle_invalid_neighbour_cell()
monarchs.physics.lateral_movement.move_from_ice_lens()
monarchs.physics.lateral_movement.move_from_lake()
monarchs.physics.lateral_movement.move_to_neighbours()
monarchs.physics.lateral_movement.move_water()
monarchs.physics.lateral_movement.update_water_level()
monarchs.physics.lateral_movement.water_fraction()
monarchs.physics.lid.adjust_lid_height()
monarchs.physics.lid.calc_k_and_cp()
monarchs.physics.lid.initialise_lid()
monarchs.physics.lid.interpolate_profiles()
monarchs.physics.lid.lid_development()
monarchs.physics.lid.surface_freezing()
monarchs.physics.lid.surface_melt()
monarchs.physics.percolation.calc_liquid_mass()
monarchs.physics.percolation.calc_refreezing()
monarchs.physics.percolation.calc_saturation()
monarchs.physics.percolation.calc_solid_mass()
monarchs.physics.percolation.capillary()
monarchs.physics.percolation.perc_time()
monarchs.physics.percolation.percolate()
monarchs.physics.regrid_column._integrate_piecewise_constant()
monarchs.physics.regrid_column.conservative_regrid()
monarchs.physics.regrid_column.merge_cells_into_lake()
monarchs.physics.regrid_column.regrid_after_freeze()
monarchs.physics.regrid_column.regrid_after_melt()
monarchs.physics.reset_column.combine_lid_firn()
monarchs.physics.reset_column.mass_conserving_profile()
monarchs.physics.snow_accumulation.densification()
monarchs.physics.snow_accumulation.snowfall()
monarchs.physics.solver.lake_development_eqn()
monarchs.physics.solver.lake_formation_eqn()
monarchs.physics.solver.lake_seb_solver()
monarchs.physics.solver.lid_heateqn_solver()
monarchs.physics.solver.lid_seb_solver()
monarchs.physics.solver.sfc_energy_lid()
monarchs.physics.solver.sfc_energy_virtual_lid()
monarchs.physics.solver.solve_firn_heateqn()
monarchs.physics.surface_fluxes.bulk_fluxes()
monarchs.physics.surface_fluxes.sfc_albedo()
monarchs.physics.surface_fluxes.sfc_flux()
monarchs.physics.timestep.timestep_loop()
monarchs.physics.virtual_lid.freeze_virtual_lid()
monarchs.physics.virtual_lid.melt_virtual_lid()
monarchs.physics.virtual_lid.update_virtual_lid_temperature()
monarchs.physics.virtual_lid.virtual_lid_development()
monarchs.run_monarchs.run_from_cli()
solver_nb.lake_seb_solver()
solver_nb.lid_heateqn_solver()
solver_nb.lid_seb_solver()
solver_nb.solve_firn_heateqn()
surface_energy_balance.lake_development_eqn()
surface_energy_balance.lake_formation_eqn()
surface_energy_balance.sfc_energy_lid()
surface_energy_balance.sfc_energy_virtual_lid()
C
check_file_exists() (monarchs.core.load_model_setup.ModelSetup method)
check_for_key_variables() (monarchs.core.load_model_setup.ModelSetup method)
check_for_unexpected_imports() (monarchs.core.load_model_setup.ModelSetup method)
CLIENT (in module monarchs.core.driver)
cp_air (in module monarchs.physics.constants)
cp_water (in module monarchs.physics.constants)
D
DEFAULT_VARS (in module monarchs.core.model_output)
dev_eqn_cfunc (in module solver_nb)
dev_eqnaddress (in module solver_nb)
dry_snow_albedo (in module monarchs.physics.constants)
E
emissivity (in module monarchs.physics.constants)
errors (monarchs.core.load_model_setup.ModelSetup attribute)
extract_args
module
extract_args.extract_firn_arrays()
built-in function
extract_args.extract_lake_variables()
built-in function
extract_args.extract_lid_variables()
built-in function
extract_args.extract_met_data()
built-in function
extract_args.extract_scalars()
built-in function
extract_args.pack_args()
built-in function
F
form_eqn_cfunc (in module solver_nb)
form_eqnaddress (in module solver_nb)
H
h (in module monarchs.dem_utils.create_dem_gaussian_test_case)
(in module monarchs.dem_utils.create_dem_planar_test_case)
HEADER_SIZE (in module extract_args)
heateqn (in module heateqn_nb)
heateqn_lid (in module heateqn_nb)
heateqn_nb
module
heateqn_nb.get_k_and_kappa()
built-in function
heateqn_nb.heateqn()
built-in function
heateqn_nb.heateqn_lid()
built-in function
heateqn_nb.propagate_temperature()
built-in function
heateqn_nb.solve_tridiagonal()
built-in function
heq (in module solver_nb)
heqlid (in module solver_nb)
I
ice_extinction_coefficient (in module monarchs.physics.constants)
IDX_AIR_TEMP (in module extract_args)
IDX_ALBEDO (in module extract_args)
IDX_DP_TEMP (in module extract_args)
IDX_DT (in module extract_args)
IDX_DZ (in module extract_args)
IDX_EXPOSED_WATER (in module extract_args)
IDX_FIRN_DEPTH (in module extract_args)
IDX_K_LID_SCALAR (in module extract_args)
IDX_LAKE (in module extract_args)
IDX_LAKE_DEPTH (in module extract_args)
IDX_LID (in module extract_args)
IDX_LID_DEPTH (in module extract_args)
IDX_LW_IN (in module extract_args)
IDX_MELT (in module extract_args)
IDX_N_GRID (in module extract_args)
IDX_P_AIR (in module extract_args)
IDX_SCALARS_END (in module extract_args)
IDX_SFRAC_LID_SCALAR (in module extract_args)
IDX_SNOW_LID (in module extract_args)
IDX_SW_IN (in module extract_args)
IDX_V_LID (in module extract_args)
IDX_V_LID_DEPTH (in module extract_args)
IDX_V_LID_TEMP (in module extract_args)
IDX_WIND (in module extract_args)
K
k_air (in module monarchs.physics.constants)
k_water (in module monarchs.physics.constants)
L
L_ice (in module monarchs.physics.constants)
loop_over_grid
module
loop_over_grid.loop_over_grid_numba()
built-in function
M
module
extract_args
heateqn_nb
loop_over_grid
monarchs
monarchs.core
monarchs.core.configuration
monarchs.core.debug
monarchs.core.driver
monarchs.core.dump_model_state
monarchs.core.error_handling
monarchs.core.initial_conditions
monarchs.core.load_model_setup
monarchs.core.loop_over_grid
monarchs.core.model_grid
monarchs.core.model_output
monarchs.core.utils
monarchs.dem_utils
monarchs.dem_utils.create_dem_gaussian_test_case
monarchs.dem_utils.create_dem_planar_test_case
monarchs.dem_utils.load_dem
monarchs.physics
monarchs.physics.constants
monarchs.physics.firn_column
monarchs.physics.heateqn
monarchs.physics.lake
monarchs.physics.lateral_movement
monarchs.physics.lid
monarchs.physics.percolation
monarchs.physics.regrid_column
monarchs.physics.reset_column
monarchs.physics.snow_accumulation
monarchs.physics.solver
monarchs.physics.surface_fluxes
monarchs.physics.timestep
monarchs.physics.virtual_lid
monarchs.run_monarchs
solver_nb
surface_energy_balance
MODULE_NAME (in module monarchs.core.load_model_setup)
(in module monarchs.physics.firn_column)
(in module monarchs.physics.lake)
(in module monarchs.physics.lid)
(in module monarchs.physics.percolation)
(in module monarchs.physics.snow_accumulation)
(in module monarchs.physics.timestep)
(in module monarchs.physics.virtual_lid)
monarchs
module
monarchs.core
module
monarchs.core.configuration
module
monarchs.core.configuration.create_defaults_for_missing_flags()
built-in function
monarchs.core.configuration.create_output_folders()
built-in function
monarchs.core.configuration.handle_incompatible_flags()
built-in function
monarchs.core.configuration.handle_invalid_values()
built-in function
monarchs.core.configuration.jit_modules()
built-in function
monarchs.core.configuration.parse_args()
built-in function
monarchs.core.debug
module
monarchs.core.debug.neighbourhood_check()
built-in function
monarchs.core.driver
module
monarchs.core.driver.check_firn_met_consistency()
built-in function
monarchs.core.driver.check_for_reload_from_dump()
built-in function
monarchs.core.driver.get_snow_sum()
built-in function
monarchs.core.driver.initialise_model_data()
built-in function
monarchs.core.driver.main()
built-in function
monarchs.core.driver.monarchs()
built-in function
monarchs.core.driver.print_model_end_of_timestep_messages()
built-in function
monarchs.core.driver.setup_toggle_dict()
built-in function
monarchs.core.driver.update_met_conditions()
built-in function
monarchs.core.dump_model_state
module
monarchs.core.dump_model_state.dump_state()
built-in function
monarchs.core.dump_model_state.reload_from_dump()
built-in function
monarchs.core.error_handling
module
monarchs.core.error_handling.calc_grid_mass()
built-in function
monarchs.core.error_handling.check_correct()
built-in function
monarchs.core.error_handling.check_for_mass_conservation()
built-in function
monarchs.core.error_handling.check_for_single_column_errors()
built-in function
monarchs.core.error_handling.check_grid_correctness()
built-in function
monarchs.core.error_handling.generic_error()
built-in function
monarchs.core.initial_conditions
module
monarchs.core.initial_conditions.check_for_isolated_cells()
built-in function
monarchs.core.initial_conditions.create_model_grid()
built-in function
monarchs.core.initial_conditions.initialise_firn_profile()
built-in function
monarchs.core.initial_conditions.rho_init_emp()
built-in function
monarchs.core.load_model_setup
module
monarchs.core.load_model_setup.get_model_setup()
built-in function
monarchs.core.load_model_setup.ModelSetup (built-in class)
monarchs.core.loop_over_grid
module
monarchs.core.loop_over_grid.chunk_grid()
built-in function
monarchs.core.loop_over_grid.loop_over_grid()
built-in function
monarchs.core.loop_over_grid.process_chunk()
built-in function
monarchs.core.model_grid
module
monarchs.core.model_grid.get_spec()
built-in function
monarchs.core.model_grid.initialise_iceshelf()
built-in function
monarchs.core.model_output
module
monarchs.core.model_output.add_lat_long()
built-in function
monarchs.core.model_output.convert_bool_dtypes()
built-in function
monarchs.core.model_output.create_dimensions()
built-in function
monarchs.core.model_output.create_variable()
built-in function
monarchs.core.model_output.get_variable_dims()
built-in function
monarchs.core.model_output.interpolate_model_output()
built-in function
monarchs.core.model_output.setup_output()
built-in function
monarchs.core.model_output.update_model_output()
built-in function
monarchs.core.utils
module
monarchs.core.utils.add_edge_water()
built-in function
monarchs.core.utils.add_random_water()
built-in function
monarchs.core.utils.calc_mass_sum()
built-in function
monarchs.core.utils.check_energy_conservation()
built-in function
monarchs.core.utils.do_not_jit()
built-in function
monarchs.core.utils.find_nearest()
built-in function
monarchs.core.utils.get_2d_grid()
built-in function
monarchs.core.utils.get_num_cores()
built-in function
monarchs.core.utils.memory_tracker()
built-in function
monarchs.core.utils.spinup()
built-in function
monarchs.dem_utils
module
monarchs.dem_utils.create_dem_gaussian_test_case
module
monarchs.dem_utils.create_dem_gaussian_test_case.export_gaussian_dem()
built-in function
monarchs.dem_utils.create_dem_gaussian_test_case.interpolate_func_to_dem()
built-in function
monarchs.dem_utils.create_dem_planar_test_case
module
monarchs.dem_utils.create_dem_planar_test_case.export_planar_dem()
built-in function
monarchs.dem_utils.load_dem
module
monarchs.dem_utils.load_dem.bounding_box_diagnostic_plots()
built-in function
monarchs.dem_utils.load_dem.export_DEM()
built-in function
monarchs.dem_utils.load_dem.generate_diagnostic_plots()
built-in function
monarchs.dem_utils.load_dem.get_xy_distance()
built-in function
monarchs.dem_utils.load_dem.interpolate_DEM()
built-in function
monarchs.physics
module
monarchs.physics.constants
module
monarchs.physics.firn_column
module
monarchs.physics.firn_column.calc_height_change()
built-in function
monarchs.physics.firn_column.firn_column()
built-in function
monarchs.physics.heateqn
module
monarchs.physics.heateqn.get_k_and_kappa()
built-in function
monarchs.physics.heateqn.heateqn()
built-in function
monarchs.physics.heateqn.heateqn_lid()
built-in function
monarchs.physics.heateqn.propagate_temperature()
built-in function
monarchs.physics.heateqn.solve_tridiagonal()
built-in function
monarchs.physics.lake
module
monarchs.physics.lake.calc_height_adjustment()
built-in function
monarchs.physics.lake.freeze_pre_lake()
built-in function
monarchs.physics.lake.lake_development()
built-in function
monarchs.physics.lake.lake_formation()
built-in function
monarchs.physics.lake.radiative_transfer()
built-in function
monarchs.physics.lake.turbulent_mixing()
built-in function
monarchs.physics.lateral_movement
module
monarchs.physics.lateral_movement.calc_available_water_ice_lens()
built-in function
monarchs.physics.lateral_movement.calc_available_water_lake()
built-in function
monarchs.physics.lateral_movement.calc_catchment_outflow()
built-in function
monarchs.physics.lateral_movement.find_biggest_neighbour()
built-in function
monarchs.physics.lateral_movement.get_neighbour_water_levels()
built-in function
monarchs.physics.lateral_movement.handle_edge_cases()
built-in function
monarchs.physics.lateral_movement.handle_invalid_neighbour_cell()
built-in function
monarchs.physics.lateral_movement.move_from_ice_lens()
built-in function
monarchs.physics.lateral_movement.move_from_lake()
built-in function
monarchs.physics.lateral_movement.move_to_neighbours()
built-in function
monarchs.physics.lateral_movement.move_water()
built-in function
monarchs.physics.lateral_movement.update_water_level()
built-in function
monarchs.physics.lateral_movement.water_fraction()
built-in function
monarchs.physics.lid
module
monarchs.physics.lid.adjust_lid_height()
built-in function
monarchs.physics.lid.calc_k_and_cp()
built-in function
monarchs.physics.lid.initialise_lid()
built-in function
monarchs.physics.lid.interpolate_profiles()
built-in function
monarchs.physics.lid.lid_development()
built-in function
monarchs.physics.lid.surface_freezing()
built-in function
monarchs.physics.lid.surface_melt()
built-in function
monarchs.physics.percolation
module
monarchs.physics.percolation.calc_liquid_mass()
built-in function
monarchs.physics.percolation.calc_refreezing()
built-in function
monarchs.physics.percolation.calc_saturation()
built-in function
monarchs.physics.percolation.calc_solid_mass()
built-in function
monarchs.physics.percolation.capillary()
built-in function
monarchs.physics.percolation.perc_time()
built-in function
monarchs.physics.percolation.percolate()
built-in function
monarchs.physics.regrid_column
module
monarchs.physics.regrid_column._integrate_piecewise_constant()
built-in function
monarchs.physics.regrid_column.conservative_regrid()
built-in function
monarchs.physics.regrid_column.merge_cells_into_lake()
built-in function
monarchs.physics.regrid_column.regrid_after_freeze()
built-in function
monarchs.physics.regrid_column.regrid_after_melt()
built-in function
monarchs.physics.reset_column
module
monarchs.physics.reset_column.combine_lid_firn()
built-in function
monarchs.physics.reset_column.mass_conserving_profile()
built-in function
monarchs.physics.snow_accumulation
module
monarchs.physics.snow_accumulation.densification()
built-in function
monarchs.physics.snow_accumulation.snowfall()
built-in function
monarchs.physics.solver
module
monarchs.physics.solver.lake_development_eqn()
built-in function
monarchs.physics.solver.lake_formation_eqn()
built-in function
monarchs.physics.solver.lake_seb_solver()
built-in function
monarchs.physics.solver.lid_heateqn_solver()
built-in function
monarchs.physics.solver.lid_seb_solver()
built-in function
monarchs.physics.solver.sfc_energy_lid()
built-in function
monarchs.physics.solver.sfc_energy_virtual_lid()
built-in function
monarchs.physics.solver.solve_firn_heateqn()
built-in function
monarchs.physics.surface_fluxes
module
monarchs.physics.surface_fluxes.bulk_fluxes()
built-in function
monarchs.physics.surface_fluxes.sfc_albedo()
built-in function
monarchs.physics.surface_fluxes.sfc_flux()
built-in function
monarchs.physics.timestep
module
monarchs.physics.timestep.timestep_loop()
built-in function
monarchs.physics.virtual_lid
module
monarchs.physics.virtual_lid.freeze_virtual_lid()
built-in function
monarchs.physics.virtual_lid.melt_virtual_lid()
built-in function
monarchs.physics.virtual_lid.update_virtual_lid_temperature()
built-in function
monarchs.physics.virtual_lid.virtual_lid_development()
built-in function
monarchs.run_monarchs
module
monarchs.run_monarchs.run_from_cli()
built-in function
P
pore_closure (in module monarchs.physics.constants)
prange (in module monarchs.core.error_handling)
(in module monarchs.core.utils)
(in module monarchs.physics.lateral_movement)
PTR_FIRN_T (in module extract_args)
PTR_LAKE_T (in module extract_args)
PTR_LFRAC (in module extract_args)
PTR_LID_T (in module extract_args)
PTR_SFRAC (in module extract_args)
PTR_SIZE (in module extract_args)
R
rho_air (in module monarchs.physics.constants)
rho_ice (in module monarchs.physics.constants)
rho_water (in module monarchs.physics.constants)
S
SAFE_IMPORTS (in module monarchs.core.load_model_setup)
saturated_firn_albedo (in module monarchs.physics.constants)
script_path (monarchs.core.load_model_setup.ModelSetup attribute)
sfc_absorbed_frac (in module monarchs.physics.constants)
sfc_energy_lid (in module solver_nb)
sfc_energy_lid_address (in module solver_nb)
sfc_energy_virtual_lid (in module solver_nb)
sfc_energy_vlid_address (in module solver_nb)
solver_nb
module
solver_nb.lake_seb_solver()
built-in function
solver_nb.lid_heateqn_solver()
built-in function
solver_nb.lid_seb_solver()
built-in function
solver_nb.solve_firn_heateqn()
built-in function
stefan_boltzmann (in module monarchs.physics.constants)
surface_energy_balance
module
surface_energy_balance.lake_development_eqn()
built-in function
surface_energy_balance.lake_formation_eqn()
built-in function
surface_energy_balance.sfc_energy_lid()
built-in function
surface_energy_balance.sfc_energy_virtual_lid()
built-in function
T
tau_ice (in module monarchs.physics.constants)
tau_water (in module monarchs.physics.constants)
V
v_lid_min_thickness (in module monarchs.physics.constants)
validate_model_setup() (monarchs.core.load_model_setup.ModelSetup method)
W
wet_snow_albedo (in module monarchs.physics.constants)