pyarts.data

Common functions for the pyarts package.

pyarts.data.download(data=('xml', 'cat'), download_dir=None, verbose=False, **kwargs)[source]

Download and extract data files.

This function sets the ARTS data search path to the downloaded data directories, so that ARTS can find the required data files.

If the environment variable ARTS_DATA_PATH or ARTS_INCLUDE_PATH is set, it is assumed that the user wants to use their own catalog locations and this function does nothing.

Parameters:

  • data (Tuple[str]) – List of data types to download. Possible values are: - "xml": arts-xml-data package - "cat": arts-cat-data package

  • download_dir (str, optional) – The directory where the data files will be stored. If not provided, the default is ~/.cache/arts/.

  • verbose (bool, optional) – Whether to print info messages. Defaults to False.

  • **kwargs – Additional options passed on to the data specific download functions, e.g. version for ARTS catalogs.

pyarts.data.download_arts_cat_data(download_dir=None, version=None, verbose=False)[source]

Download and extract the ARTS catalog data files from github.

This function sets the ARTS data search path to the downloaded data directories, so that ARTS can find the required data files.

If the environment variable ARTS_DATA_PATH or ARTS_INCLUDE_PATH is set, it is assumed that the user wants to use their own catalog locations and this function does nothing.

Parameters:

  • download_dir (str, optional) – The directory where the data files will be stored. ggkIf not provided, the default is ~/.cache/arts.

  • version (str, optional) – The version of ARTS to download the data files for. The default is the version of the currently installed pyarts package.

  • verbose (bool, optional) – Whether to print info messages. Defaults to False.

pyarts.data.download_arts_xml_data(download_dir=None, version=None, verbose=False)[source]

Download and extract the ARTS XML data files from github.

This function sets the ARTS data search path to the downloaded data directories, so that ARTS can find the required data files.

If the environment variable ARTS_DATA_PATH or ARTS_INCLUDE_PATH is set, it is assumed that the user wants to use their own catalog locations and this function does nothing.

Parameters:

  • download_dir (str, optional) – The directory where the data files will be stored. ggkIf not provided, the default is ~/.cache/arts.

  • version (str, optional) – The version of ARTS to download the data files for. The default is the version of the currently installed pyarts package.

  • verbose (bool, optional) – Whether to print info messages. Defaults to False.