antaress.ANTARESS_process.ANTARESS_main module#

ANTARESS_settings_overwrite(data_dic, mock_dic, gen_dic, theo_dic, plot_dic, glob_fit_dic, detrend_prof_dic, input_dic)[source]#

ANTARESS settings overwrite.

Overwrites ANTARESS default settings with custom inputs.

Parameters:

TBD

Returns:

None

ANTARESS_main(data_dic, mock_dic, gen_dic, theo_dic, plot_dic, glob_fit_dic, detrend_prof_dic, system_param, input_dic, custom_plot_settings)[source]#

Main ANTARESS function.

Runs ANTARESS workflow. The pipeline is defined as modules than can be run independently. Each module takes as input the datasets produced by earlier modules, transforms or analyzes them, and saves the outputs to disk. This approach allows the user to re-run the pipeline from any module, which is useful when several flow options are available. It is even critical with large datasets such as the ones produced by ESPRESSO, which can take several hours to process with a given module. Finally, this approach also allows a user to retrieve data at any stage of the process flow for external use.

Parameters:

TBD

Returns:

None

conv_2D_to_1D_gen_functions(data_type_gen, data_dic, inst, vis, gen_dic, coord_dic, theo_dic, plot_dic, system_param)[source]#

Wrap-up function for 2D->1D datasets.

Parameters:

TBD

Returns:

None

bin_gen_functions(data_type_gen, mode, inst, gen_dic, data_dic, coord_dic, data_prop, system_param, theo_dic, plot_dic, mock_dic={}, vis=None)[source]#

Wrap-up function for binned datasets.

Parameters:

TBD

Returns:

None

init_gen(data_dic, mock_dic, gen_dic, system_param, theo_dic, plot_dic, glob_fit_dic, detrend_prof_dic)[source]#

Initialization: generic

Initializes generic fields for the workflow.

Parameters:

TBD

Returns:

None

init_inst(mock_dic, inst, gen_dic, data_dic, theo_dic, data_prop, coord_dic, system_param, plot_dic)[source]#

Initialization: instrument

Initializes instrument-specific fields for the workflow.

Parameters:

TBD

Returns:

None

init_vis(data_prop, data_dic, vis, coord_dic, inst, system_param, gen_dic)[source]#

Initialization: visit

Initializes visit-specific fields for the workflow.

Parameters:

TBD

Returns:

None

update_inst(data_dic, inst, gen_dic)[source]#

Update: instrument

Updates instrument-specific fields for the workflow, once all visits have been processed.

Parameters:

TBD

Returns:

None

update_gen(data_dic, gen_dic)[source]#

Update: generic

Updates generic fields for the workflow, once all instruments have been processed.

Parameters:

TBD

Returns:

None