esm_pism Package¶

`plugin` Module¶

esm_pism.plugin.pism_assemble_command(config)[source]¶

Puts together the final PISM command used to launch the model

Parameters: config (dict) – The entire exp config
Returns: config – The entire exp config
Return type: dict

esm_pism.plugin.pism_override_file(config)[source]¶

Generates a PISM Overrides file.

Opens the pism_config.nc file in your YAML (see below), or uses the default found in the model directory under share/pism/pism_config.nc. This is used to determine which override keys are valid. A new file is written which is used during your simulation.

Alternatively, you can provide an override file to use, in which case that one will be used rather than generating a new one.

Warning

It is currently not possible to provide both an override file and extend it!

Example

In your YAML, you can specify:

pism:
    # This config file will be used as a template rather than the
    # one in model_dir!
    config_file: "/some/path/to/a/config/file"
    overrides_kv_pairs:
        "frontal_melt.given.period": 3

Alternatively:

pism:
    overrides_file: "/some/path/to/an/overrides/file.nc"

Parameters: config (dict) – The entire exp config
Returns: config – The entire exp config
Return type: dict

esm_pism.plugin.pism_set_couplers(config)[source]¶

Parameters: config (dict) – The entire exp config
Returns: config – The entire exp config
Return type: dict

esm_pism.plugin.pism_set_flags(config)[source]¶

Parameters: config (dict) – The entire exp config
Returns: config – The entire exp config
Return type: dict

esm_pism.plugin.pism_set_kv_pairs(config)[source]¶

Parameters: config (dict) – The entire exp config
Returns: config – The entire exp config
Return type: dict

esm_pism Package¶

plugin Module¶

`plugin` Module¶