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)
Formatting input meteorological data
MONARCHS run settings
MONARCHS grid variables
MONARCHS met forcing variables
Common errors and debugging
Making changes to MONARCHS
Code structure
API Reference
MONARCHS
Index
Index
_
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
X
_
__enter__() (monarchs.core.utils.Timer method)
__exit__() (monarchs.core.utils.Timer method)
_ACRONYMS (in module monarchs.docs_tables)
_COLUMNS (in module monarchs.config.docs)
(in module monarchs.variables.docs)
_DEFAULT_VARS (in module monarchs.io.output)
_DEFAULT_VARS_TO_SAVE (in module monarchs.config.catalogue)
_DIM_SIZE (in module monarchs.variables.build)
_DIR_COL (in module monarchs.physics.lateral.directions)
_DIR_ROW (in module monarchs.physics.lateral.directions)
_INTRO (in module monarchs.config.docs)
(in module monarchs.variables.docs)
_KERNELS (in module monarchs.core.kernels)
_N_DIRS (in module monarchs.physics.lateral.directions)
_NEEDS_DUMP_FILEPATH (in module monarchs.config.rules)
B
bare_ice_albedo (in module monarchs.physics.constants)
BOOL (in module monarchs.variables.definitions)
built-in function
loop_over_grid.loop_over_grid_numba()
monarchs.config.apply._raise_problems()
monarchs.config.apply._required_problems()
monarchs.config.apply._rule_problems()
monarchs.config.apply._setting_problems()
monarchs.config.apply.check_required()
monarchs.config.apply.check_rules()
monarchs.config.apply.check_settings()
monarchs.config.apply.configure()
monarchs.config.apply.fill_defaults()
monarchs.config.check_required()
monarchs.config.check_rules()
monarchs.config.check_settings()
monarchs.config.computed_defaults.lat_grid_size()
monarchs.config.computed_defaults.lateral_timestep()
monarchs.config.computed_defaults.met_data_source()
monarchs.config.computed_defaults.output_grid_size()
monarchs.config.configure()
monarchs.config.definitions.dtype_name()
monarchs.config.definitions.type_matches()
monarchs.config.docs._constraint_cell()
monarchs.config.docs._default_cell()
monarchs.config.docs._row()
monarchs.config.docs.to_markdown()
monarchs.config.fill_defaults()
monarchs.config.rules._met_source_input_missing()
monarchs.config.rules._no_dump_filepath()
monarchs.config.rules._no_met_source()
monarchs.config.to_markdown()
monarchs.core.configuration.create_output_folders()
monarchs.core.configuration.parse_args()
monarchs.core.debug.neighbourhood_check()
monarchs.core.diagnostics.check_firn_met_consistency()
monarchs.core.diagnostics.print_model_end_of_timestep_messages()
monarchs.core.driver.lateral_movement_step()
monarchs.core.driver.monarchs()
monarchs.core.driver.run_model()
monarchs.core.driver.setup_parallelism()
monarchs.core.driver.setup_toggle_dict()
monarchs.core.driver.single_column_step()
monarchs.core.driver.validate_visits()
monarchs.core.driver.write_outputs()
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.kernels.compile_all()
monarchs.core.kernels.kernel()
monarchs.core.load_model_setup.get_model_setup()
monarchs.core.loop_over_grid.loop_over_grid()
monarchs.core.setup_run.check_for_reload_from_dump()
monarchs.core.setup_run.initialise_model_data()
monarchs.core.utils.add_edge_water()
monarchs.core.utils.add_random_water()
monarchs.core.utils.calc_mass_sum()
monarchs.core.utils.find_nearest()
monarchs.core.utils.get_2d_grid()
monarchs.core.utils.get_num_cores()
monarchs.core.utils.memory_tracker()
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.docs_tables.group_order()
monarchs.docs_tables.heading()
monarchs.docs_tables.render_reference()
monarchs.io.append_output()
monarchs.io.checkpoint.read_checkpoint()
monarchs.io.checkpoint.write_checkpoint()
monarchs.io.initialise_output()
monarchs.io.netcdf_utils.create_grid_dimensions()
monarchs.io.netcdf_utils.extract_field()
monarchs.io.netcdf_utils.is_vector_field()
monarchs.io.netcdf_utils.netcdf_dtype()
monarchs.io.netcdf_utils.variable_dimensions()
monarchs.io.output.add_lat_long()
monarchs.io.output.append_output()
monarchs.io.output.create_variable()
monarchs.io.output.initialise_output()
monarchs.io.output.interpolate_model_output()
monarchs.io.read_checkpoint()
monarchs.io.write_checkpoint()
monarchs.physics.firn.firn_column.calc_height_change()
monarchs.physics.firn.firn_column.firn_column()
monarchs.physics.firn.heateqn._firn_jacobian()
monarchs.physics.firn.heateqn._firn_residual()
monarchs.physics.firn.heateqn.firn_heateqn_solver()
monarchs.physics.firn.heateqn.heateqn_firn()
monarchs.physics.firn.heateqn.newton_jacobian_firn()
monarchs.physics.firn.percolation.calc_liquid_mass()
monarchs.physics.firn.percolation.calc_refreezing()
monarchs.physics.firn.percolation.calc_saturation()
monarchs.physics.firn.percolation.calc_solid_mass()
monarchs.physics.firn.percolation.capillary()
monarchs.physics.firn.percolation.perc_time()
monarchs.physics.firn.percolation.percolate()
monarchs.physics.firn.regrid_column._integrate_piecewise_constant()
monarchs.physics.firn.regrid_column.conservative_regrid()
monarchs.physics.firn.regrid_column.merge_cells_into_lake()
monarchs.physics.firn.regrid_column.regrid_after_freeze()
monarchs.physics.firn.regrid_column.regrid_after_melt()
monarchs.physics.firn.snow_accumulation.densification()
monarchs.physics.firn.snow_accumulation.snowfall()
monarchs.physics.lake.development.calc_height_adjustment()
monarchs.physics.lake.development.lake_development()
monarchs.physics.lake.development.radiative_transfer()
monarchs.physics.lake.development.turbulent_mixing()
monarchs.physics.lake.formation.lake_formation()
monarchs.physics.lake.lake_development()
monarchs.physics.lake.lake_formation()
monarchs.physics.lake.radiative_transfer()
monarchs.physics.lake.seb.lake_development_eqn()
monarchs.physics.lake.seb.lake_formation_eqn()
monarchs.physics.lake.seb.lake_seb_solver()
monarchs.physics.lake.turbulent_mixing()
monarchs.physics.lateral.available_water.calc_available_water_ice_lens()
monarchs.physics.lateral.available_water.calc_available_water_lake()
monarchs.physics.lateral.available_water.calc_catchment_outflow()
monarchs.physics.lateral.available_water.water_fraction()
monarchs.physics.lateral.move_water()
monarchs.physics.lateral.move_water.move_water()
monarchs.physics.lateral.neighbours.find_biggest_neighbour()
monarchs.physics.lateral.neighbours.get_neighbour_water_levels()
monarchs.physics.lateral.transfer.handle_edge_cases()
monarchs.physics.lateral.transfer.handle_invalid_neighbour_cell()
monarchs.physics.lateral.transfer.move_from_ice_lens()
monarchs.physics.lateral.transfer.move_from_lake()
monarchs.physics.lateral.transfer.move_to_neighbours()
monarchs.physics.lateral.water_level.update_water_level()
monarchs.physics.lid.heateqn._lid_jacobian()
monarchs.physics.lid.heateqn._lid_residual()
monarchs.physics.lid.heateqn.heateqn_lid()
monarchs.physics.lid.heateqn.lid_heateqn_solver()
monarchs.physics.lid.heateqn.newton_jacobian_lid()
monarchs.physics.lid.lid.adjust_lid_height()
monarchs.physics.lid.lid.calc_k_and_cp()
monarchs.physics.lid.lid.initialise_lid()
monarchs.physics.lid.lid.interpolate_profiles()
monarchs.physics.lid.lid.lid_development()
monarchs.physics.lid.lid.surface_freezing()
monarchs.physics.lid.lid.surface_melt()
monarchs.physics.lid.lid_development()
monarchs.physics.lid.seb.lid_seb_solver()
monarchs.physics.lid.seb.sfc_energy_lid()
monarchs.physics.lid.seb.sfc_energy_virtual_lid()
monarchs.physics.lid.virtual_lid.freeze_virtual_lid()
monarchs.physics.lid.virtual_lid.melt_virtual_lid()
monarchs.physics.lid.virtual_lid.update_virtual_lid_temperature()
monarchs.physics.lid.virtual_lid.virtual_lid_development()
monarchs.physics.lid.virtual_lid_development()
monarchs.physics.material_properties.cp_ice()
monarchs.physics.material_properties.cv_mixture()
monarchs.physics.material_properties.k_and_kappa()
monarchs.physics.material_properties.k_ice()
monarchs.physics.material_properties.k_mixture()
monarchs.physics.reset_column.combine_lid_firn()
monarchs.physics.reset_column.mass_conserving_profile()
monarchs.physics.solver.newton_scalar()
monarchs.physics.solver.newton_tridiagonal()
monarchs.physics.solver.solve_tridiagonal()
monarchs.physics.surface_fluxes.bulk_fluxes()
monarchs.physics.surface_fluxes.sfc_albedo()
monarchs.physics.surface_fluxes.sfc_flux()
monarchs.physics.timestep.timestep_loop()
monarchs.run_monarchs.run_from_cli()
monarchs.variables.build.build_dtype()
monarchs.variables.build.make_grid()
monarchs.variables.build.validate_catalogue()
monarchs.variables.build.variable_metadata()
monarchs.variables.build_dtype()
monarchs.variables.docs._default_cell()
monarchs.variables.docs._row()
monarchs.variables.docs.to_markdown()
monarchs.variables.initial_value_functions.ice_lens_below_column()
monarchs.variables.initial_value_functions.n_firn()
monarchs.variables.initial_value_functions.n_lake()
monarchs.variables.initial_value_functions.n_lid()
monarchs.variables.initial_value_functions.sfrac_from_rho()
monarchs.variables.initial_value_functions.vertical_profile()
monarchs.variables.make_grid()
monarchs.variables.to_markdown()
monarchs.variables.validate_catalogue()
monarchs.variables.variable_metadata()
C
CATALOGUE (in module monarchs.variables)
(in module monarchs.variables.catalogue)
check_file_exists() (monarchs.core.load_model_setup.ModelSetup method)
check_for_key_variables() (monarchs.core.load_model_setup.ModelSetup method)
choices (monarchs.config.definitions.Setting attribute)
(monarchs.config.Setting attribute)
Config (in module monarchs.config)
(in module monarchs.config.apply)
cp_air (in module monarchs.physics.constants)
cp_water (in module monarchs.physics.constants)
D
default (monarchs.config.definitions.Setting attribute)
(monarchs.config.Setting attribute)
default_doc (monarchs.config.definitions.Setting attribute)
(monarchs.config.Setting attribute)
default_value (monarchs.variables.definitions.Variable attribute)
(monarchs.variables.Variable attribute)
description (monarchs.config.definitions.Setting attribute)
(monarchs.config.Setting attribute)
(monarchs.variables.definitions.Variable attribute)
(monarchs.variables.Variable attribute)
dim (monarchs.variables.definitions.Variable attribute)
(monarchs.variables.Variable attribute)
DIRECTIONS (monarchs.variables.definitions.Dim attribute)
(monarchs.variables.Dim attribute)
DQ_DT_STEP (in module monarchs.physics.solver)
dry_snow_albedo (in module monarchs.physics.constants)
dtype (monarchs.config.definitions.Setting attribute)
(monarchs.config.Setting attribute)
(monarchs.variables.definitions.Variable attribute)
(monarchs.variables.Variable attribute)
E
emissivity (in module monarchs.physics.constants)
error (monarchs.config.definitions.Rule attribute)
(monarchs.config.Rule attribute)
errors (monarchs.core.load_model_setup.ModelSetup attribute)
eta_water (in module monarchs.physics.constants)
F
failed_when (monarchs.config.definitions.Rule attribute)
(monarchs.config.Rule attribute)
FD_STEP (in module monarchs.physics.solver)
FIRN (monarchs.variables.definitions.Dim attribute)
(monarchs.variables.Dim attribute)
FLOAT (in module monarchs.variables.definitions)
FTOL (in module monarchs.physics.solver)
G
g (in module monarchs.physics.constants)
group (monarchs.config.definitions.Setting attribute)
(monarchs.config.Setting attribute)
(monarchs.variables.definitions.Variable attribute)
(monarchs.variables.Variable attribute)
H
h (in module monarchs.dem_utils.create_dem_gaussian_test_case)
(in module monarchs.dem_utils.create_dem_planar_test_case)
I
INPUT (in module monarchs.variables.definitions)
inputs (monarchs.variables.definitions.InitContext attribute)
INT (in module monarchs.variables.definitions)
J
J (in module monarchs.physics.constants)
K
k_air (in module monarchs.physics.constants)
k_water (in module monarchs.physics.constants)
kernel_toggle (monarchs.config.definitions.Setting attribute)
(monarchs.config.Setting attribute)
L
L_ice (in module monarchs.physics.constants)
label (monarchs.core.utils.Timer attribute)
LAKE (monarchs.variables.definitions.Dim attribute)
(monarchs.variables.Dim attribute)
LID (monarchs.variables.definitions.Dim attribute)
(monarchs.variables.Dim attribute)
logger (in module monarchs.core.driver)
long_name (monarchs.variables.definitions.Variable attribute)
(monarchs.variables.Variable attribute)
loop_over_grid
module
loop_over_grid.loop_over_grid_numba()
built-in function
M
message (monarchs.config.definitions.Rule attribute)
(monarchs.config.Rule attribute)
module
loop_over_grid
monarchs
monarchs.config
monarchs.config.apply
monarchs.config.catalogue
monarchs.config.computed_defaults
monarchs.config.definitions
monarchs.config.docs
monarchs.config.rules
monarchs.core
monarchs.core.configuration
monarchs.core.debug
monarchs.core.diagnostics
monarchs.core.driver
monarchs.core.error_handling
monarchs.core.initial_conditions
monarchs.core.kernels
monarchs.core.load_model_setup
monarchs.core.loop_over_grid
monarchs.core.setup_run
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.docs_tables
monarchs.io
monarchs.io.checkpoint
monarchs.io.netcdf_utils
monarchs.io.output
monarchs.physics
monarchs.physics.constants
monarchs.physics.firn
monarchs.physics.firn.firn_column
monarchs.physics.firn.heateqn
monarchs.physics.firn.percolation
monarchs.physics.firn.regrid_column
monarchs.physics.firn.snow_accumulation
monarchs.physics.lake
monarchs.physics.lake.development
monarchs.physics.lake.formation
monarchs.physics.lake.seb
monarchs.physics.lateral
monarchs.physics.lateral.available_water
monarchs.physics.lateral.directions
monarchs.physics.lateral.neighbours
monarchs.physics.lateral.transfer
monarchs.physics.lateral.water_level
monarchs.physics.lid
monarchs.physics.lid.heateqn
monarchs.physics.lid.lid
monarchs.physics.lid.seb
monarchs.physics.lid.virtual_lid
monarchs.physics.material_properties
monarchs.physics.reset_column
monarchs.physics.solver
monarchs.physics.surface_fluxes
monarchs.physics.timestep
monarchs.run_monarchs
monarchs.variables
monarchs.variables.build
monarchs.variables.catalogue
monarchs.variables.definitions
monarchs.variables.docs
monarchs.variables.initial_value_functions
MODULE_NAME (in module monarchs.core.load_model_setup)
(in module monarchs.physics.firn.firn_column)
(in module monarchs.physics.firn.percolation)
(in module monarchs.physics.firn.snow_accumulation)
(in module monarchs.physics.lake.development)
(in module monarchs.physics.lake.formation)
(in module monarchs.physics.lid.lid)
(in module monarchs.physics.lid.virtual_lid)
(in module monarchs.physics.timestep)
monarchs
module
monarchs.config
module
monarchs.config.apply
module
monarchs.config.apply._raise_problems()
built-in function
monarchs.config.apply._required_problems()
built-in function
monarchs.config.apply._rule_problems()
built-in function
monarchs.config.apply._setting_problems()
built-in function
monarchs.config.apply.check_required()
built-in function
monarchs.config.apply.check_rules()
built-in function
monarchs.config.apply.check_settings()
built-in function
monarchs.config.apply.configure()
built-in function
monarchs.config.apply.fill_defaults()
built-in function
monarchs.config.catalogue
module
monarchs.config.check_required()
built-in function
monarchs.config.check_rules()
built-in function
monarchs.config.check_settings()
built-in function
monarchs.config.computed_defaults
module
monarchs.config.computed_defaults.lat_grid_size()
built-in function
monarchs.config.computed_defaults.lateral_timestep()
built-in function
monarchs.config.computed_defaults.met_data_source()
built-in function
monarchs.config.computed_defaults.output_grid_size()
built-in function
monarchs.config.configure()
built-in function
monarchs.config.definitions
module
monarchs.config.definitions.dtype_name()
built-in function
monarchs.config.definitions.Rule (built-in class)
monarchs.config.definitions.Setting (built-in class)
monarchs.config.definitions.type_matches()
built-in function
monarchs.config.docs
module
monarchs.config.docs._constraint_cell()
built-in function
monarchs.config.docs._default_cell()
built-in function
monarchs.config.docs._row()
built-in function
monarchs.config.docs.to_markdown()
built-in function
monarchs.config.fill_defaults()
built-in function
monarchs.config.Rule (built-in class)
monarchs.config.rules
module
monarchs.config.rules._met_source_input_missing()
built-in function
monarchs.config.rules._no_dump_filepath()
built-in function
monarchs.config.rules._no_met_source()
built-in function
monarchs.config.Setting (built-in class)
monarchs.config.to_markdown()
built-in function
monarchs.core
module
monarchs.core.configuration
module
monarchs.core.configuration.create_output_folders()
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.diagnostics
module
monarchs.core.diagnostics.check_firn_met_consistency()
built-in function
monarchs.core.diagnostics.print_model_end_of_timestep_messages()
built-in function
monarchs.core.driver
module
monarchs.core.driver.lateral_movement_step()
built-in function
monarchs.core.driver.monarchs()
built-in function
monarchs.core.driver.run_model()
built-in function
monarchs.core.driver.setup_parallelism()
built-in function
monarchs.core.driver.setup_toggle_dict()
built-in function
monarchs.core.driver.single_column_step()
built-in function
monarchs.core.driver.validate_visits()
built-in function
monarchs.core.driver.write_outputs()
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.kernels
module
monarchs.core.kernels.compile_all()
built-in function
monarchs.core.kernels.kernel()
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.loop_over_grid()
built-in function
monarchs.core.setup_run
module
monarchs.core.setup_run.check_for_reload_from_dump()
built-in function
monarchs.core.setup_run.initialise_model_data()
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.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.Timer (built-in class)
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.docs_tables
module
monarchs.docs_tables.group_order()
built-in function
monarchs.docs_tables.heading()
built-in function
monarchs.docs_tables.render_reference()
built-in function
monarchs.io
module
monarchs.io.append_output()
built-in function
monarchs.io.checkpoint
module
monarchs.io.checkpoint.read_checkpoint()
built-in function
monarchs.io.checkpoint.write_checkpoint()
built-in function
monarchs.io.initialise_output()
built-in function
monarchs.io.netcdf_utils
module
monarchs.io.netcdf_utils.create_grid_dimensions()
built-in function
monarchs.io.netcdf_utils.extract_field()
built-in function
monarchs.io.netcdf_utils.is_vector_field()
built-in function
monarchs.io.netcdf_utils.netcdf_dtype()
built-in function
monarchs.io.netcdf_utils.variable_dimensions()
built-in function
monarchs.io.output
module
monarchs.io.output.add_lat_long()
built-in function
monarchs.io.output.append_output()
built-in function
monarchs.io.output.create_variable()
built-in function
monarchs.io.output.initialise_output()
built-in function
monarchs.io.output.interpolate_model_output()
built-in function
monarchs.io.read_checkpoint()
built-in function
monarchs.io.write_checkpoint()
built-in function
monarchs.physics
module
monarchs.physics.constants
module
monarchs.physics.firn
module
monarchs.physics.firn.firn_column
module
monarchs.physics.firn.firn_column.calc_height_change()
built-in function
monarchs.physics.firn.firn_column.firn_column()
built-in function
monarchs.physics.firn.heateqn
module
monarchs.physics.firn.heateqn._firn_jacobian()
built-in function
monarchs.physics.firn.heateqn._firn_residual()
built-in function
monarchs.physics.firn.heateqn.firn_heateqn_solver()
built-in function
monarchs.physics.firn.heateqn.heateqn_firn()
built-in function
monarchs.physics.firn.heateqn.newton_jacobian_firn()
built-in function
monarchs.physics.firn.percolation
module
monarchs.physics.firn.percolation.calc_liquid_mass()
built-in function
monarchs.physics.firn.percolation.calc_refreezing()
built-in function
monarchs.physics.firn.percolation.calc_saturation()
built-in function
monarchs.physics.firn.percolation.calc_solid_mass()
built-in function
monarchs.physics.firn.percolation.capillary()
built-in function
monarchs.physics.firn.percolation.perc_time()
built-in function
monarchs.physics.firn.percolation.percolate()
built-in function
monarchs.physics.firn.regrid_column
module
monarchs.physics.firn.regrid_column._integrate_piecewise_constant()
built-in function
monarchs.physics.firn.regrid_column.conservative_regrid()
built-in function
monarchs.physics.firn.regrid_column.merge_cells_into_lake()
built-in function
monarchs.physics.firn.regrid_column.regrid_after_freeze()
built-in function
monarchs.physics.firn.regrid_column.regrid_after_melt()
built-in function
monarchs.physics.firn.snow_accumulation
module
monarchs.physics.firn.snow_accumulation.densification()
built-in function
monarchs.physics.firn.snow_accumulation.snowfall()
built-in function
monarchs.physics.lake
module
monarchs.physics.lake.development
module
monarchs.physics.lake.development.calc_height_adjustment()
built-in function
monarchs.physics.lake.development.lake_development()
built-in function
monarchs.physics.lake.development.radiative_transfer()
built-in function
monarchs.physics.lake.development.turbulent_mixing()
built-in function
monarchs.physics.lake.formation
module
monarchs.physics.lake.formation.lake_formation()
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.seb
module
monarchs.physics.lake.seb.lake_development_eqn()
built-in function
monarchs.physics.lake.seb.lake_formation_eqn()
built-in function
monarchs.physics.lake.seb.lake_seb_solver()
built-in function
monarchs.physics.lake.turbulent_mixing()
built-in function
monarchs.physics.lateral
module
monarchs.physics.lateral.available_water
module
monarchs.physics.lateral.available_water.calc_available_water_ice_lens()
built-in function
monarchs.physics.lateral.available_water.calc_available_water_lake()
built-in function
monarchs.physics.lateral.available_water.calc_catchment_outflow()
built-in function
monarchs.physics.lateral.available_water.water_fraction()
built-in function
monarchs.physics.lateral.directions
module
monarchs.physics.lateral.move_water()
built-in function
monarchs.physics.lateral.move_water.move_water()
built-in function
monarchs.physics.lateral.neighbours
module
monarchs.physics.lateral.neighbours.find_biggest_neighbour()
built-in function
monarchs.physics.lateral.neighbours.get_neighbour_water_levels()
built-in function
monarchs.physics.lateral.transfer
module
monarchs.physics.lateral.transfer.handle_edge_cases()
built-in function
monarchs.physics.lateral.transfer.handle_invalid_neighbour_cell()
built-in function
monarchs.physics.lateral.transfer.move_from_ice_lens()
built-in function
monarchs.physics.lateral.transfer.move_from_lake()
built-in function
monarchs.physics.lateral.transfer.move_to_neighbours()
built-in function
monarchs.physics.lateral.water_level
module
monarchs.physics.lateral.water_level.update_water_level()
built-in function
monarchs.physics.lid
module
monarchs.physics.lid.heateqn
module
monarchs.physics.lid.heateqn._lid_jacobian()
built-in function
monarchs.physics.lid.heateqn._lid_residual()
built-in function
monarchs.physics.lid.heateqn.heateqn_lid()
built-in function
monarchs.physics.lid.heateqn.lid_heateqn_solver()
built-in function
monarchs.physics.lid.heateqn.newton_jacobian_lid()
built-in function
monarchs.physics.lid.lid
module
monarchs.physics.lid.lid.adjust_lid_height()
built-in function
monarchs.physics.lid.lid.calc_k_and_cp()
built-in function
monarchs.physics.lid.lid.initialise_lid()
built-in function
monarchs.physics.lid.lid.interpolate_profiles()
built-in function
monarchs.physics.lid.lid.lid_development()
built-in function
monarchs.physics.lid.lid.surface_freezing()
built-in function
monarchs.physics.lid.lid.surface_melt()
built-in function
monarchs.physics.lid.lid_development()
built-in function
monarchs.physics.lid.seb
module
monarchs.physics.lid.seb.lid_seb_solver()
built-in function
monarchs.physics.lid.seb.sfc_energy_lid()
built-in function
monarchs.physics.lid.seb.sfc_energy_virtual_lid()
built-in function
monarchs.physics.lid.virtual_lid
module
monarchs.physics.lid.virtual_lid.freeze_virtual_lid()
built-in function
monarchs.physics.lid.virtual_lid.melt_virtual_lid()
built-in function
monarchs.physics.lid.virtual_lid.update_virtual_lid_temperature()
built-in function
monarchs.physics.lid.virtual_lid.virtual_lid_development()
built-in function
monarchs.physics.lid.virtual_lid_development()
built-in function
monarchs.physics.material_properties
module
monarchs.physics.material_properties.cp_ice()
built-in function
monarchs.physics.material_properties.cv_mixture()
built-in function
monarchs.physics.material_properties.k_and_kappa()
built-in function
monarchs.physics.material_properties.k_ice()
built-in function
monarchs.physics.material_properties.k_mixture()
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.solver
module
monarchs.physics.solver.newton_scalar()
built-in function
monarchs.physics.solver.newton_tridiagonal()
built-in function
monarchs.physics.solver.solve_tridiagonal()
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.run_monarchs
module
monarchs.run_monarchs.run_from_cli()
built-in function
monarchs.variables
module
monarchs.variables.build
module
monarchs.variables.build.build_dtype()
built-in function
monarchs.variables.build.make_grid()
built-in function
monarchs.variables.build.validate_catalogue()
built-in function
monarchs.variables.build.variable_metadata()
built-in function
monarchs.variables.build_dtype()
built-in function
monarchs.variables.catalogue
module
monarchs.variables.definitions
module
monarchs.variables.definitions.Dim (built-in class)
monarchs.variables.definitions.InitContext (built-in class)
monarchs.variables.definitions.Variable (built-in class)
monarchs.variables.Dim (built-in class)
monarchs.variables.docs
module
monarchs.variables.docs._default_cell()
built-in function
monarchs.variables.docs._row()
built-in function
monarchs.variables.docs.to_markdown()
built-in function
monarchs.variables.initial_value_functions
module
monarchs.variables.initial_value_functions.ice_lens_below_column()
built-in function
monarchs.variables.initial_value_functions.n_firn()
built-in function
monarchs.variables.initial_value_functions.n_lake()
built-in function
monarchs.variables.initial_value_functions.n_lid()
built-in function
monarchs.variables.initial_value_functions.sfrac_from_rho()
built-in function
monarchs.variables.initial_value_functions.vertical_profile()
built-in function
monarchs.variables.make_grid()
built-in function
monarchs.variables.to_markdown()
built-in function
monarchs.variables.validate_catalogue()
built-in function
monarchs.variables.Variable (built-in class)
monarchs.variables.variable_metadata()
built-in function
N
name (monarchs.config.definitions.Setting attribute)
(monarchs.config.Setting attribute)
(monarchs.variables.definitions.Variable attribute)
(monarchs.variables.Variable attribute)
num_cols (monarchs.variables.definitions.InitContext attribute)
num_rows (monarchs.variables.definitions.InitContext attribute)
O
output (monarchs.variables.definitions.Variable attribute)
(monarchs.variables.Variable attribute)
P
pore_closure (in module monarchs.physics.constants)
R
REQUIRED (in module monarchs.config)
(in module monarchs.config.definitions)
rho_air (in module monarchs.physics.constants)
rho_ice (in module monarchs.physics.constants)
rho_water (in module monarchs.physics.constants)
RULES (in module monarchs.config)
(in module monarchs.config.rules)
S
saturated_firn_albedo (in module monarchs.physics.constants)
SCALAR (monarchs.variables.definitions.Dim attribute)
(monarchs.variables.Dim attribute)
script_path (monarchs.core.load_model_setup.ModelSetup attribute)
SETTINGS (in module monarchs.config)
(in module monarchs.config.catalogue)
sfc_absorbed_frac (in module monarchs.physics.constants)
SOLVER_MAXITER (in module monarchs.physics.solver)
SOLVER_TOL (in module monarchs.physics.solver)
stefan_boltzmann (in module monarchs.physics.constants)
T
tau_ice (in module monarchs.physics.constants)
tau_water (in module monarchs.physics.constants)
U
units (monarchs.variables.definitions.Variable attribute)
(monarchs.variables.Variable attribute)
UNSET (in module monarchs.config)
(in module monarchs.config.definitions)
V
v_lid_min_thickness (in module monarchs.physics.constants)
validate_model_setup() (monarchs.core.load_model_setup.ModelSetup method)
validator (monarchs.config.definitions.Setting attribute)
(monarchs.config.Setting attribute)
validator_doc (monarchs.config.definitions.Setting attribute)
(monarchs.config.Setting attribute)
vert_grid (monarchs.variables.definitions.InitContext attribute)
vert_grid_lake (monarchs.variables.definitions.InitContext attribute)
vert_grid_lid (monarchs.variables.definitions.InitContext attribute)
W
wet_snow_albedo (in module monarchs.physics.constants)
X
XTOL (in module monarchs.physics.solver)