Getting Started
Firn Model Formats
SMB and firn model files are available from different modeling groups in different formats.
FirnCorr has drivers for GEMB, GSFC-fdm, MAR and RACMO model formats, which are presently usually netCDF4 files.
FirnCorr uses pint to handle parsing the units of the model data and convert them into different sets of units.
meters (\(m\))
centimeters water equivalent (\(cm\,w.e.\))
centimeters ice equivalent (\(cm\,i.e.\))
kilograms per square meter (\(kg/m^2\), equivalent to \(mm\,w.e.\))
Data Access
Some model outputs can be programmatically downloaded using the fetching routines in FirnCorr.datasets.
Other firn models may require manual downloading due to licensing agreements or limitations on programmatic access. See the model links in Directories for the references to specific firn models.
Model Database
FirnCorr stores the metadata for some models within a JSON database.
FirnCorr currently supports several solutions from the following models:
GEMBGardner et al. [6]GSFC-fdmMedley et al. [8]RACMO-asciiEttema et al. [3]RACMO-downscaledNoël et al. [10]
import FirnCorr
# create a FirnCorr model object from database
m = FirnCorr.io.model(verify=False).from_database("GSFC-fdm-v1.2.1")
m
FirnCorr.io.model
name: GSFC-fdm-v1.2.1Directories
FirnCorr uses a tree structure for storing and accessing the model outputs.
This structure was chosen based on the different formats of each model.
The base of the tree structure (in the table below as <model_path>) can be the default FirnCorr cache directory or a user-specified (external) directory.
Several models can be programmatically downloaded from their providers to their parameterized directories using the fetching routines in FirnCorr.datasets.
Presently, the following models and their directories are parameterized within FirnCorr:
Model |
Directory |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
MARv3.12 |
|
MARv3.14 |
|
Model |
Directory |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
MARv3.11-ERA |
|
MARv3.11-NCEP |
|
MARv3.11.2-ERA-10km |
|
MARv3.11.2-ERA-15km |
|
MARv3.11.2-ERA-20km |
|
MARv3.11.2-ERA-6km |
|
MARv3.11.2-ERA-7.5km |
|
MARv3.11.2-NCEP-20km |
|
MARv3.11.5-ERA-10km |
|
MARv3.11.5-ERA-15km |
|
MARv3.11.5-ERA-20km |
|
MARv3.11.5-ERA-6km |
|
MARv3.14-ERA-10km |
|
MARv3.14-ERA-1km |
|
MARv3.9-ERA |
|