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
|
G
|
H
|
I
|
L
|
M
|
N
|
P
|
R
|
S
|
T
|
W
|
X
|
Y
|
Z
B
built-in function
extract_args.extract_args_firn()
extract_args.extract_args_lid()
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()
solver_nb.args_array()
solver_nb.firn_heateqn_solver()
solver_nb.lake_development_eqn()
solver_nb.lake_formation_eqn()
solver_nb.lake_solver()
solver_nb.lid_heateqn_solver()
solver_nb.lid_seb_solver()
solver_nb.sfc_energy_lid()
solver_nb.sfc_energy_virtual_lid()
src.monarchs.core.configuration.create_defaults_for_missing_flags()
src.monarchs.core.configuration.create_output_folders()
src.monarchs.core.configuration.get_model_setup()
src.monarchs.core.configuration.handle_incompatible_flags()
src.monarchs.core.configuration.jit_modules()
src.monarchs.core.configuration.parse_args()
src.monarchs.core.driver.check_firn_met_consistency()
src.monarchs.core.driver.check_for_reload_from_dump()
src.monarchs.core.driver.get_num_cores()
src.monarchs.core.driver.get_snow_sum()
src.monarchs.core.driver.initialise()
src.monarchs.core.driver.main()
src.monarchs.core.driver.monarchs()
src.monarchs.core.driver.print_model_end_of_timestep_messages()
src.monarchs.core.driver.setup_toggle_dict()
src.monarchs.core.driver.update_met_conditions()
src.monarchs.core.dump_model_state.dump_state()
src.monarchs.core.dump_model_state.reload_from_dump()
src.monarchs.core.initial_conditions.check_for_isolated_cells()
src.monarchs.core.initial_conditions.create_model_grid()
src.monarchs.core.initial_conditions.initialise_firn_profile()
src.monarchs.core.initial_conditions.rho_init_emp()
src.monarchs.core.loop_over_grid.chunk_grid()
src.monarchs.core.loop_over_grid.loop_over_grid()
src.monarchs.core.loop_over_grid.process_chunk()
src.monarchs.core.model_grid.get_spec()
src.monarchs.core.model_grid.initialise_iceshelf()
src.monarchs.core.model_output.interpolate_model_output()
src.monarchs.core.model_output.setup_output()
src.monarchs.core.model_output.update_model_output()
src.monarchs.core.utils.add_edge_water()
src.monarchs.core.utils.add_random_water()
src.monarchs.core.utils.calc_grid_mass()
src.monarchs.core.utils.calc_mass_sum()
src.monarchs.core.utils.check_correct()
src.monarchs.core.utils.check_energy_conservation()
src.monarchs.core.utils.check_grid_correctness()
src.monarchs.core.utils.do_not_jit()
src.monarchs.core.utils.find_nearest()
src.monarchs.core.utils.get_2d_grid()
src.monarchs.core.utils.memory_tracker()
src.monarchs.core.utils.spinup()
src.monarchs.DEM.create_DEM_GaussianTestCase.export_gaussian_DEM()
src.monarchs.DEM.create_DEM_planar_test_case.export_planar_DEM()
src.monarchs.DEM.load_DEM.bounding_box_diagnostic_plots()
src.monarchs.DEM.load_DEM.export_DEM()
src.monarchs.DEM.load_DEM.generate_diagnostic_plots()
src.monarchs.DEM.load_DEM.get_xy_distance()
src.monarchs.DEM.load_DEM.interpolate_DEM()
src.monarchs.physics.firn_functions.calc_height_change()
src.monarchs.physics.firn_functions.firn_column()
src.monarchs.physics.firn_functions.interp_nb()
src.monarchs.physics.firn_functions.regrid_after_melt()
src.monarchs.physics.heateqn.get_k_and_kappa()
src.monarchs.physics.heateqn.heateqn()
src.monarchs.physics.heateqn.heateqn_lid()
src.monarchs.physics.heateqn.propagate_temperature()
src.monarchs.physics.heateqn.solve_tridiagonal()
src.monarchs.physics.lake_functions.lake_development()
src.monarchs.physics.lake_functions.lake_formation()
src.monarchs.physics.lake_functions.sfc_energy_lake()
src.monarchs.physics.lake_functions.sfc_energy_lake_formation()
src.monarchs.physics.lake_functions.turbulent_mixing()
src.monarchs.physics.lateral_functions.calc_available_water_ice_lens()
src.monarchs.physics.lateral_functions.calc_available_water_lake()
src.monarchs.physics.lateral_functions.calc_catchment_outflow()
src.monarchs.physics.lateral_functions.find_biggest_neighbour()
src.monarchs.physics.lateral_functions.get_neighbour_water_levels()
src.monarchs.physics.lateral_functions.move_from_ice_lens()
src.monarchs.physics.lateral_functions.move_from_lake()
src.monarchs.physics.lateral_functions.move_to_neighbours()
src.monarchs.physics.lateral_functions.move_water()
src.monarchs.physics.lateral_functions.update_water_level()
src.monarchs.physics.lateral_functions.water_fraction()
src.monarchs.physics.lid_functions.calc_surface_melt()
src.monarchs.physics.lid_functions.combine_lid_firn()
src.monarchs.physics.lid_functions.interpolate_profiles()
src.monarchs.physics.lid_functions.lid_development()
src.monarchs.physics.lid_functions.mass_conserving_profile()
src.monarchs.physics.lid_functions.virtual_lid()
src.monarchs.physics.percolation_functions.calc_liquid_mass()
src.monarchs.physics.percolation_functions.calc_refreezing()
src.monarchs.physics.percolation_functions.calc_saturation()
src.monarchs.physics.percolation_functions.calc_solid_mass()
src.monarchs.physics.percolation_functions.capillary()
src.monarchs.physics.percolation_functions.perc_time()
src.monarchs.physics.percolation_functions.percolation()
src.monarchs.physics.snow_accumulation.densification()
src.monarchs.physics.snow_accumulation.snowfall()
src.monarchs.physics.solver.firn_heateqn_solver()
src.monarchs.physics.solver.lake_development_eqn()
src.monarchs.physics.solver.lake_formation_eqn()
src.monarchs.physics.solver.lake_solver()
src.monarchs.physics.solver.lid_heateqn_solver()
src.monarchs.physics.solver.lid_seb_solver()
src.monarchs.physics.solver.sfc_energy_lid()
src.monarchs.physics.solver.sfc_energy_virtual_lid()
src.monarchs.physics.surface_fluxes.bulk_fluxes()
src.monarchs.physics.surface_fluxes.sfc_albedo()
src.monarchs.physics.surface_fluxes.sfc_flux()
src.monarchs.physics.timestep.timestep_loop()
C
cbar (in module src.monarchs.DEM.RBIS_DEM)
column_dz (in module src.monarchs.physics.mass_conservation_test)
D
DEM_grid (in module src.monarchs.DEM.RBIS_DEM)
dev_eqn_cfunc (in module solver_nb)
dev_eqnaddress (in module solver_nb)
dz_full (in module src.monarchs.physics.mass_conservation_test)
dz_new (in module src.monarchs.physics.mass_conservation_test)
E
extract_args
module
extract_args.extract_args_firn()
built-in function
extract_args.extract_args_lid()
built-in function
extract_args_firn (in module extract_args)
extract_args_lid (in module extract_args)
F
fig (in module src.monarchs.DEM.RBIS_DEM)
font (in module src.monarchs.DEM.RBIS_DEM)
form_eqn_cfunc (in module solver_nb)
form_eqnaddress (in module solver_nb)
G
gt (in module src.monarchs.DEM.Read_DEM_coords)
H
h (in module src.monarchs.DEM.create_DEM_GaussianTestCase)
(in module src.monarchs.DEM.create_DEM_planar_test_case)
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
heights (in module src.monarchs.DEM.RBIS_DEM)
(in module src.monarchs.DEM.Read_DEM_coords)
heq (in module solver_nb)
heqlid (in module solver_nb)
I
im (in module src.monarchs.DEM.RBIS_DEM)
interp (in module src.monarchs.DEM.interpolation_test)
L
lid_dz (in module src.monarchs.physics.mass_conservation_test)
loop_over_grid
module
loop_over_grid.loop_over_grid_numba()
built-in function
M
mass_final (in module src.monarchs.physics.mass_conservation_test)
mass_initial (in module src.monarchs.physics.mass_conservation_test)
mass_interp_edges (in module src.monarchs.physics.mass_conservation_test)
mass_new (in module src.monarchs.physics.mass_conservation_test)
mass_old (in module src.monarchs.physics.mass_conservation_test)
mass_profile (in module src.monarchs.physics.mass_conservation_test)
max_grid_col (in module src.monarchs.DEM.RBIS_DEM)
max_grid_row (in module src.monarchs.DEM.RBIS_DEM)
meta_dict (in module src.monarchs.DEM.RBIS_DEM)
module
extract_args
heateqn_nb
loop_over_grid
solver_nb
src.monarchs
src.monarchs.core
src.monarchs.core.configuration
src.monarchs.core.driver
src.monarchs.core.dump_model_state
src.monarchs.core.initial_conditions
src.monarchs.core.loop_over_grid
src.monarchs.core.model_grid
src.monarchs.core.model_output
src.monarchs.core.utils
src.monarchs.DEM
src.monarchs.DEM.create_DEM_GaussianTestCase
src.monarchs.DEM.create_DEM_planar_test_case
src.monarchs.DEM.interpolation_test
src.monarchs.DEM.load_DEM
src.monarchs.DEM.RBIS_DEM
src.monarchs.DEM.Read_DEM_coords
src.monarchs.physics
src.monarchs.physics.firn_functions
src.monarchs.physics.heateqn
src.monarchs.physics.lake_functions
src.monarchs.physics.lateral_functions
src.monarchs.physics.lid_functions
src.monarchs.physics.mass_conservation_test
src.monarchs.physics.percolation_functions
src.monarchs.physics.snow_accumulation
src.monarchs.physics.solver
src.monarchs.physics.surface_fluxes
src.monarchs.physics.timestep
N
num_layers_new (in module src.monarchs.physics.mass_conservation_test)
P
prange (in module src.monarchs.physics.lateral_functions)
R
rho_solid (in module src.monarchs.physics.mass_conservation_test)
rng (in module src.monarchs.DEM.interpolation_test)
S
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)
sfrac_column (in module src.monarchs.physics.mass_conservation_test)
sfrac_full (in module src.monarchs.physics.mass_conservation_test)
sfrac_lid (in module src.monarchs.physics.mass_conservation_test)
sfrac_new (in module src.monarchs.physics.mass_conservation_test)
solver_nb
module
solver_nb.args_array()
built-in function
solver_nb.firn_heateqn_solver()
built-in function
solver_nb.lake_development_eqn()
built-in function
solver_nb.lake_formation_eqn()
built-in function
solver_nb.lake_solver()
built-in function
solver_nb.lid_heateqn_solver()
built-in function
solver_nb.lid_seb_solver()
built-in function
solver_nb.sfc_energy_lid()
built-in function
solver_nb.sfc_energy_virtual_lid()
built-in function
src.monarchs
module
src.monarchs.core
module
src.monarchs.core.configuration
module
src.monarchs.core.configuration.create_defaults_for_missing_flags()
built-in function
src.monarchs.core.configuration.create_output_folders()
built-in function
src.monarchs.core.configuration.get_model_setup()
built-in function
src.monarchs.core.configuration.handle_incompatible_flags()
built-in function
src.monarchs.core.configuration.jit_modules()
built-in function
src.monarchs.core.configuration.ModelSetup (built-in class)
src.monarchs.core.configuration.parse_args()
built-in function
src.monarchs.core.driver
module
src.monarchs.core.driver.check_firn_met_consistency()
built-in function
src.monarchs.core.driver.check_for_reload_from_dump()
built-in function
src.monarchs.core.driver.get_num_cores()
built-in function
src.monarchs.core.driver.get_snow_sum()
built-in function
src.monarchs.core.driver.initialise()
built-in function
src.monarchs.core.driver.main()
built-in function
src.monarchs.core.driver.monarchs()
built-in function
src.monarchs.core.driver.print_model_end_of_timestep_messages()
built-in function
src.monarchs.core.driver.setup_toggle_dict()
built-in function
src.monarchs.core.driver.update_met_conditions()
built-in function
src.monarchs.core.dump_model_state
module
src.monarchs.core.dump_model_state.dump_state()
built-in function
src.monarchs.core.dump_model_state.reload_from_dump()
built-in function
src.monarchs.core.initial_conditions
module
src.monarchs.core.initial_conditions.check_for_isolated_cells()
built-in function
src.monarchs.core.initial_conditions.create_model_grid()
built-in function
src.monarchs.core.initial_conditions.initialise_firn_profile()
built-in function
src.monarchs.core.initial_conditions.rho_init_emp()
built-in function
src.monarchs.core.loop_over_grid
module
src.monarchs.core.loop_over_grid.chunk_grid()
built-in function
src.monarchs.core.loop_over_grid.loop_over_grid()
built-in function
src.monarchs.core.loop_over_grid.process_chunk()
built-in function
src.monarchs.core.model_grid
module
src.monarchs.core.model_grid.get_spec()
built-in function
src.monarchs.core.model_grid.initialise_iceshelf()
built-in function
src.monarchs.core.model_output
module
src.monarchs.core.model_output.interpolate_model_output()
built-in function
src.monarchs.core.model_output.setup_output()
built-in function
src.monarchs.core.model_output.update_model_output()
built-in function
src.monarchs.core.utils
module
src.monarchs.core.utils.add_edge_water()
built-in function
src.monarchs.core.utils.add_random_water()
built-in function
src.monarchs.core.utils.calc_grid_mass()
built-in function
src.monarchs.core.utils.calc_mass_sum()
built-in function
src.monarchs.core.utils.check_correct()
built-in function
src.monarchs.core.utils.check_energy_conservation()
built-in function
src.monarchs.core.utils.check_grid_correctness()
built-in function
src.monarchs.core.utils.do_not_jit()
built-in function
src.monarchs.core.utils.find_nearest()
built-in function
src.monarchs.core.utils.get_2d_grid()
built-in function
src.monarchs.core.utils.memory_tracker()
built-in function
src.monarchs.core.utils.spinup()
built-in function
src.monarchs.DEM
module
src.monarchs.DEM.create_DEM_GaussianTestCase
module
src.monarchs.DEM.create_DEM_GaussianTestCase.export_gaussian_DEM()
built-in function
src.monarchs.DEM.create_DEM_planar_test_case
module
src.monarchs.DEM.create_DEM_planar_test_case.export_planar_DEM()
built-in function
src.monarchs.DEM.interpolation_test
module
src.monarchs.DEM.load_DEM
module
src.monarchs.DEM.load_DEM.bounding_box_diagnostic_plots()
built-in function
src.monarchs.DEM.load_DEM.export_DEM()
built-in function
src.monarchs.DEM.load_DEM.generate_diagnostic_plots()
built-in function
src.monarchs.DEM.load_DEM.get_xy_distance()
built-in function
src.monarchs.DEM.load_DEM.interpolate_DEM()
built-in function
src.monarchs.DEM.RBIS_DEM
module
src.monarchs.DEM.Read_DEM_coords
module
src.monarchs.physics
module
src.monarchs.physics.firn_functions
module
src.monarchs.physics.firn_functions.calc_height_change()
built-in function
src.monarchs.physics.firn_functions.firn_column()
built-in function
src.monarchs.physics.firn_functions.interp_nb()
built-in function
src.monarchs.physics.firn_functions.regrid_after_melt()
built-in function
src.monarchs.physics.heateqn
module
src.monarchs.physics.heateqn.get_k_and_kappa()
built-in function
src.monarchs.physics.heateqn.heateqn()
built-in function
src.monarchs.physics.heateqn.heateqn_lid()
built-in function
src.monarchs.physics.heateqn.propagate_temperature()
built-in function
src.monarchs.physics.heateqn.solve_tridiagonal()
built-in function
src.monarchs.physics.lake_functions
module
src.monarchs.physics.lake_functions.lake_development()
built-in function
src.monarchs.physics.lake_functions.lake_formation()
built-in function
src.monarchs.physics.lake_functions.sfc_energy_lake()
built-in function
src.monarchs.physics.lake_functions.sfc_energy_lake_formation()
built-in function
src.monarchs.physics.lake_functions.turbulent_mixing()
built-in function
src.monarchs.physics.lateral_functions
module
src.monarchs.physics.lateral_functions.calc_available_water_ice_lens()
built-in function
src.monarchs.physics.lateral_functions.calc_available_water_lake()
built-in function
src.monarchs.physics.lateral_functions.calc_catchment_outflow()
built-in function
src.monarchs.physics.lateral_functions.find_biggest_neighbour()
built-in function
src.monarchs.physics.lateral_functions.get_neighbour_water_levels()
built-in function
src.monarchs.physics.lateral_functions.move_from_ice_lens()
built-in function
src.monarchs.physics.lateral_functions.move_from_lake()
built-in function
src.monarchs.physics.lateral_functions.move_to_neighbours()
built-in function
src.monarchs.physics.lateral_functions.move_water()
built-in function
src.monarchs.physics.lateral_functions.update_water_level()
built-in function
src.monarchs.physics.lateral_functions.water_fraction()
built-in function
src.monarchs.physics.lid_functions
module
src.monarchs.physics.lid_functions.calc_surface_melt()
built-in function
src.monarchs.physics.lid_functions.combine_lid_firn()
built-in function
src.monarchs.physics.lid_functions.interpolate_profiles()
built-in function
src.monarchs.physics.lid_functions.lid_development()
built-in function
src.monarchs.physics.lid_functions.mass_conserving_profile()
built-in function
src.monarchs.physics.lid_functions.virtual_lid()
built-in function
src.monarchs.physics.mass_conservation_test
module
src.monarchs.physics.percolation_functions
module
src.monarchs.physics.percolation_functions.calc_liquid_mass()
built-in function
src.monarchs.physics.percolation_functions.calc_refreezing()
built-in function
src.monarchs.physics.percolation_functions.calc_saturation()
built-in function
src.monarchs.physics.percolation_functions.calc_solid_mass()
built-in function
src.monarchs.physics.percolation_functions.capillary()
built-in function
src.monarchs.physics.percolation_functions.perc_time()
built-in function
src.monarchs.physics.percolation_functions.percolation()
built-in function
src.monarchs.physics.snow_accumulation
module
src.monarchs.physics.snow_accumulation.densification()
built-in function
src.monarchs.physics.snow_accumulation.snowfall()
built-in function
src.monarchs.physics.solver
module
src.monarchs.physics.solver.firn_heateqn_solver()
built-in function
src.monarchs.physics.solver.lake_development_eqn()
built-in function
src.monarchs.physics.solver.lake_formation_eqn()
built-in function
src.monarchs.physics.solver.lake_solver()
built-in function
src.monarchs.physics.solver.lid_heateqn_solver()
built-in function
src.monarchs.physics.solver.lid_seb_solver()
built-in function
src.monarchs.physics.solver.sfc_energy_lid()
built-in function
src.monarchs.physics.solver.sfc_energy_virtual_lid()
built-in function
src.monarchs.physics.surface_fluxes
module
src.monarchs.physics.surface_fluxes.bulk_fluxes()
built-in function
src.monarchs.physics.surface_fluxes.sfc_albedo()
built-in function
src.monarchs.physics.surface_fluxes.sfc_flux()
built-in function
src.monarchs.physics.timestep
module
src.monarchs.physics.timestep.timestep_loop()
built-in function
T
tiffname (in module src.monarchs.DEM.load_DEM)
(in module src.monarchs.DEM.RBIS_DEM)
(in module src.monarchs.DEM.Read_DEM_coords)
total_depth (in module src.monarchs.physics.mass_conservation_test)
W
water (in module src.monarchs.DEM.RBIS_DEM)
,
[1]
water_level (in module src.monarchs.DEM.RBIS_DEM)
X
X (in module src.monarchs.DEM.interpolation_test)
x (in module src.monarchs.DEM.interpolation_test)
Y
Y (in module src.monarchs.DEM.interpolation_test)
y (in module src.monarchs.DEM.interpolation_test)
Z
Z (in module src.monarchs.DEM.interpolation_test)
z (in module src.monarchs.DEM.interpolation_test)
z_centers_full (in module src.monarchs.physics.mass_conservation_test)
z_centers_new (in module src.monarchs.physics.mass_conservation_test)
z_edges_full (in module src.monarchs.physics.mass_conservation_test)
z_edges_new (in module src.monarchs.physics.mass_conservation_test)