scopesim.server.example_data_utils.list_example_data

scopesim.server.example_data_utils.list_example_data(url: str | None = None, return_files: bool = False, silent: bool = False) → list[str]

List all example files found under url.

Parameters:

• 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”]

• return_files (bool) – If True, returns a list of file names

• silent (bool) – If True, does not print the list of file names

Returns:

all_files – A list of paths to the example files relative to url. The full string should be passed to download_example_data.

Return type:

list of str