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

ANTARESS_DACE_launcher(star_name, inst, sub_inst, data_path, working_path, 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. To generate a single master with minimal input, you can also run the workflow from the terminal as:

antaress --sequence st_master_tseries --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[‘type’] with your chosen instrument, and gen_dic[‘data_dir_list’] pointing to your data directory.

Parameters:

  • star_name (str) – name of the star (to be saved in the master 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

Returns:

None

Contents