Pre-processing modules

Source code can be found in 'igm/modules/preproc'

Module name	Doc	Code	Description
oggm_shop	doc	code	feeds the initial 'state' from online data using OGGM given RGI ID (unix and mac only)
load_ncdf	doc	code	feeds the initial 'state' from a given NetCDF file
load_tif	doc	code	feeds the initial 'state' from given tiff files
include_icemask	doc	code	loads a shapefile (ESRI shapefile) and creates an ice mask from it
pretraining (<= v2.2.2)	doc	code	perform a pretraining of the iceflow emulator on a glacier catalogue
optimize (<= v2.2.2)	doc	code	perform the preliminary optimization/inversion scheme (e.g. find the bedrock) from observations
pretraining (> v2.2.2)			This module was merged to iceflow , check module iceflow
optimize (> v2.2.2)			This module was merged to iceflow, check module iceflow

Processing modules

Source code can be found in 'igm/modules/process'

Module name	Doc	Code	Description
clim_oggm	doc	code	compute "oggm-like" climate data
smb_oggm	doc	code	compute "oggm-like" surface mass balance from climate data
smb_simple	doc	code	compute surface mass balance with a simple ELA parametrization
iceflow	doc	code	compute the horizontal iceflow velocity field using Physics-Informed Deep Learning
time	doc	code	compute the time step, time accounting for CFL and saving times
thk	doc	code	computes the ice thickness solving mass conservation equation
vert_flow	doc	code	compute the vertical component of the velocity a posteriori
enthalpy	doc	code	compute the enthalpy and the subglacial hydrology (new! use with care)
particles	doc	code	compute the trajectory of individual lagrangian particles
rockflow	doc	code	extend the velocity field in ice ice-free area to mimic the dynamics of rocks in steep terrain
glerosion	doc	code	update the topography after being eroded by glaciers
avalanche	doc	code	redistribute snow after taking into account snow avalanches
gflex	doc	code	Compute lithospheric flexure using gflex python module

Post-processing modules

Source code can be found in 'igm/modules/postproc'

Module name	Doc	Code	Description
write_ncdf	doc	code	writes the 2D results at given intervals in a NetCDF file
write_tif	doc	code	writes the 2D results at given intervals in a tif file
write_ts	doc	code	writes the time serie results at given intervals in a NetCDF file
plot2d	doc	code	produce on the fly 2D plots of ice thk/speed with particles if activated
write_particles	doc	code	write particle positions in dedicated files in the folder 'trajectory'
print_info	doc	code	write basic information on the fly about ice volume, time step ...
print_comp	doc	code	summarize the computational costs of each step, and global of the run at the end
anim_plotly	doc	code	interactively make 3D vizu from the final NetCDF file (depends on dash and plotly)
anim_mayavi	doc	code	make a nice 3D vizu from the final NetCDF file (depends on mayavi and pyqt5)
anim_video	doc	code	make a nice mp4 animation from the final NetCDF file