pydox.CalibrationSet

class CalibrationSet(*args, **kwargs)

Collection of methodology implementations

Notes

• Support more than one calibration method

• Handle sequential or parallel execution of configuration sets

Examples

from pydox import Calibration, CalibrationSet

s = CalibrationSet()
s.commit(Calibration('in_air').set_params('calibration_methods.in_air', carryover=[False, True], dataset=['ncep', 'era5']))
s.commit(Calibration('climatology').set_params('calibration_methods.climatology.max_pressure', [25., 50.]))

s.n_configs
s.configs

s.fit(a_float)

s.fitted
s.coefs
s.set_best_fit
s.best_fit

s.plot

__init__(*args, **kwargs)

Parameters:

• name (Optional[str] = None)

• config (Config) – A specific configuration object to use instead of the current one from pydox.params

Methods

__init__(*args, **kwargs)
commit(o)	This method looks like the real added difference compared to a 'Workflow' for a single method ('Method')
create_corrBfile(a_float[, icfg])
fit(argofloat_obj[, cumulative])	Load input data and compute coefficients
flatten_configs()	Return a dictionary with all possible configurations
get_params(*args, **kwargs)	Get configuration parameter(s) for this instance only
is_cumulative()	Check if this instance can perform a cumulative fit
load_input_data(argofloat_obj, *args, **kwargs)	Load input data for the flatten list of configurations
plot([icfg, categories, configs_layout])	Show figures from this instance
reset_params(*args, **kwargs)	Reset configuration parameter(s) to instantiation initial value(s)
set_best_fit(icfg)	Set the configuration ID for the best fit
set_params(*args, **kwargs)	Set configuration parameter(s) for this instance only
to_report(a_float[, file_name])	Create a calibration report
uid([icfg])	UID for this CalibrationSet or a specific configuration

Attributes

best_fit	ID of the configuration selected as the best fit
coefs	Dictionary of fit coefficients for each configuration
configs	A property to directly access the dictionary of configurations
configs_figures	Dictionary of figures associated with each configurations UID
figures	List of figures associated with this workflow UID
fit_data	Dictionary of fit auxiliary data for each configuration
fitted	Was the instance fitted at least once ?
input_data	Input data for fit
n_configs	Return the number of all possible configurations