clevar.clv_yaml.footprint module¶

@file footprint.py Footprint functions for command line execution

clevar.clv_yaml.footprint.artificial(config_file, overwrite_config, overwrite_files, case)[source]¶

Function to create footprint

Parameters

config_file (str) – Yaml file with configuration to run
overwrite_config (bool) – Forces overwrite of config.log.yml file
overwrite_files (bool) – Forces overwrite of output files
case (str) – Run for which catalog. Options: 1, 2, both

clevar.clv_yaml.footprint.make_masks(config_file, overwrite_config, overwrite_files, case)[source]¶

Main plot function

Parameters

config_file (str) – Yaml file with configuration to run
overwrite_config (bool) – Forces overwrite of config.log.yml file
overwrite_files (bool) – Forces overwrite of output files
case (str) – Run for which catalog. Options: 1, 2, both

clevar.clv_yaml.footprint.prep_ftpt_config(config)[source]¶

Prepare footprint coming from yml file into kwargs for Footprint

Parameters: config (dict) – Footprint config from yml
Returns: kwargs – kwargs to instanciate clevar.footprint.Footprint
Return type: dict