antaress.ANTARESS_launch.ANTARESS_launcher module

antaress.ANTARESS_launch.ANTARESS_launcher module#

ANTARESS_launcher(sequence='', custom_systems='', custom_settings='', custom_plot_settings='', working_path='', nbook_dic={}, exec_comm=True)[source]#

ANTARESS launch routine.

Runs ANTARESS with default or manual settings.

This routine can be called directly from a python environment, or from the terminal.

Parameters:

  • sequence (str) – name of custom sequence (default “”: default settings are used)

  • custom_systems (str) – name of custom systems file (default “”: ANTARESS_systems.py file is used)

  • custom_settings (str) – name of custom settings file (default “”: ANTARESS_settings.py file is used)

  • custom_plot_settings (str) – name of custom plot settings file (default “”: ANTARESS_plot_settings.py file is used)

  • working_path (str) – path to the working directory, in which the workflow outputs will be stored (default “”: current directory is used) if custom files are used, they should be placed in the working directory

Returns:

None

copy_settings_files_to_save_dir(settings_path_dic, run_path)[source]#

Generic launch routines: copy settings files to save directory.

Copies the three settings files (ANTARESS_settings, ANTARESS_systems, ANTARESS_plot_settings) to a run-specific subdirectory in Settings_archive. Each run is tracked with a timestamped folder named RunXXX_YYYY-MM-DD_HH-MM-SS.

Parameters:

  • settings_path_dic (dict) – dictionary containing paths to settings files

  • run_path (str) – generic path to current simulation

Returns:

None

ANTARESS_DACE_launcher(star_name, inst, sub_inst, data_path, working_path, master1D=True, def_nthreads=16, debug_mode=False, del_dir=True)[source]#

ANTARESS launch routine: master computation

Runs ANTARESS on a S2D dataset to generate 2D and 1D master spectra with minimal inputs. The masters are aligned in the stellar rest frame.

This routine can be called directly from a python environment, or from terminal as:

antaress --sequence st_master_tseries --custom_settings ANTARESS_settings_sequence.py

Using a copy of the default configuration file where the only field that need to be modified is:

  • gen_dic[‘data_dir_list’] : path to your data directory, for the associated instrument

Parameters:

  • star_name (str) – name of the star (to be saved in the outputs, not critical to the computation)

  • inst (str) – name of the instrument used to acquire the dataset

  • sub_inst (str) – name of the sub-instrument used to acquire the dataset

  • data_path (str) – path to the dataset directory

  • working_path (str) – path to the directory where ANTARESS outputs are stored

  • master1D (bool) – set to True to calculate 1D master

  • def_nthreads (int) – maximum number of CPUs to be used

  • debug_mode (bool) – set to True to enter debugging mode

  • del_dir (bool) – set to False to prevent automatic deletion of intermediate data products

Returns:

None

ANTARESS_DACE_launcher_RVs(star_name, inst, sub_inst, data_path, working_path, def_nthreads=16, debug_mode=False, del_dir=True)[source]#

ANTARESS launch routine: RV computation

Runs ANTARESS on a S2D dataset to generate RV time series with minimal inputs. RVs are derived from disk-integrated CCFs, in the solar barycentric rest frame.

This routine can be called directly from a python environment, or from terminal as:

antaress --sequence st_rv_tseries --custom_settings ANTARESS_settings_sequence.py

Using a copy of the default configuration file where the only field that need to be modified is:

  • gen_dic[‘data_dir_list’] : path to your data directory, for the associated instrument

Parameters:

  • star_name (str) – name of the star (to be saved in the outputs, not critical to the computation)

  • inst (str) – name of the instrument used to acquire the dataset

  • sub_inst (str) – name of the sub-instrument used to acquire the dataset

  • data_path (str) – path to the dataset directory

  • working_path (str) – path to the directory where ANTARESS outputs are stored

  • def_nthreads (int) – maximum number of CPUs to be used

  • debug_mode (bool) – set to True to enter debugging mode

  • del_dir (bool) – set to False to prevent automatic deletion of intermediate data products

Returns:

None

ANTARESS_launcher_CCFmask(star_name, inst, sub_inst, working_path, master_path, def_nthreads=16, debug_mode=False, del_dir=True)[source]#

ANTARESS launch routine: CCF mask computation

Runs ANTARESS on a S1D master to generate a star-specific CCF mask with minimal inputs.

This routine can be called directly from a python environment, or from terminal as:

antaress --sequence st_CCF_mask --custom_settings ANTARESS_settings_sequence.py

Using a copy of the default configuration file where the only field that need to be modified is:

  • gen_dic[‘data_dir_list’] : path to your data directory, for the associated instrument

Parameters:

  • star_name (str) – name of the star (to be saved in the outputs, not critical to the computation)

  • inst (str) – name of the instrument used to acquire the dataset

  • sub_inst (str) – name of the sub-instrument used to acquire the dataset

  • working_path (str) – path to the directory where ANTARESS outputs are stored

  • master_path (str) – path to an ANTARESS .npz file storing a stellar 1D master spectrum

  • def_nthreads (int) – maximum number of CPUs to be used

  • debug_mode (bool) – set to True to enter debugging mode

  • del_dir (bool) – set to False to prevent automatic deletion of intermediate data products

Returns:

None

ANTARESS_launcher_init(debug_mode, working_path, star_name, sub_inst)[source]#

ANTARESS launch routine: general initialization

ANTARESS_NIGHT_proc(star_name, pl_name, date, data_path, working_path, debug_mode=False, del_dir=True)[source]#

ANTARESS launch routine: NIGHT fast processing

Runs ANTARESS on a NIGHT dataset to derive … with minimal inputs.

This routine can be called directly from a python environment. To derive RVs with minimal input, you can also run the workflow from terminal as:

antaress --sequence night_proc --custom_settings ANTARESS_settings_sequence.py

Using a copy of the default configuration file where the only fields that need to be modified are:

  • gen_dic[‘data_dir_list’] : path to your data directory, for the associated instrument

Parameters:

TBD

Returns:

None