scopesim.server.example_data_utils.download_example_data

scopesim.server.example_data_utils.download_example_data#

scopesim.server.example_data_utils.download_example_data(*files: str, save_dir: Path | str | None = None, url: str | None = None) → list[Path]#

Download example fits files to the local disk.

Parameters:

  • files (str(s)) – Name(s) of FITS file(s) as given by list_example_data().

  • save_dir (str) – The place on the local disk where the downloaded files are to be saved. If left as None, defaults to the “~/.astar/scopesim”.

  • url (str) – The URL of the database HTTP server. If left as None, defaults to the value in scopesim.rc.__config__[“!SIM.file.server_base_url”]

Returns:

  • save_path (list of Paths) – The absolute path(s) to the saved files

  • .. versionchanged:: 0.8.4 – Passing a list to download_example_data is deprecated since version 0.8.4, this function now accepts multiple file names in *args-style.

  • .. versionchanged:: 0.11.0 – Passing a list to download_example_data as the first argument will now throw a TypeError. This is to catch any remaining uses of the old call signature of this function. From version 0.12 onwards, agruments will be silently passed to the retriever.

Contents