scopesim.commands.user_commands.list_local_packages

scopesim.commands.user_commands.list_local_packages#

scopesim.commands.user_commands.list_local_packages(action='display')#

List the packages on the local disk that ScopeSim can find.

Packages can only be found in the directory listed under:

scopesim.rc.__config__["!SIM.file.local_packages_path"]

Packages are divided into “main” packages and “extension” packages.

  • Main packages contain a default.yaml file which tell ScopeSim which other packages are required to generate the full optical system

  • Extension packages contain only the data files needed to support the effects listed in the package YAML file

Note

Only “main” packages can be passed to a UserCommands object using the use_instrument=... parameter

Parameters:

action (str, optional) – [“display”, “return”] What to do with the output. - “display”: the list of packages are printed to the screen - “return”: package names are returned in lists

Returns:

main_pkgs, ext_pkgs – If action=”return”: Lists containing the names of locally saved packages

Return type:

lists

Contents