API Reference#

class astro_tigress.Model(model_id, dir_master)[source]#

Class containing the simulation model information.

Parameters

model_id (str) – name of the model, e.g. R8_2pc.

download(ivtk=300, dataset='MHD', Z=1.0, iline=1)[source]#

Download simulation data from a certain data set.

Parameters
  • ivtk (int) – vtk output number

  • dataset (str, ["MHD", "chem", "CO_lines", "history", "input", "all"]) – name of the dataset or download all.

  • Z (float, [0.5, 1, 2]) – metallicity for chemistry post-processing.

  • iline (int, [1, 2]) – uppper level of CO rotational line. 1 for J=1-0, 2 for J=2-1

load(ivtk, dataset='MHD', Z=1.0, iline=1, Tdect=0.0)[source]#

Load simulation data from a certain data set.

Parameters
  • ivtk (int) – vtk output number

  • dataset (str or list, ["MHD", "chem", "CO_lines", "MHD_PI", "all"]) – name of the dataset or load all.

  • Z (float, [0.5, 1, 2]) – metallicity for chemistry post-processing.

  • iline (int, [1, 2]) – uppper level of CO rotational line. 1 for J=1-0, 2 for J=2-1

  • Tdect (float) – detection limit for atenna temperature in K for each velocity channel.

show()[source]#

Print available data list