lsst.sims.ocs.configuration.science_proposals module

class lsst.sims.ocs.configuration.science_proposals.ScienceProposals

Bases: lsst.pex.config.config.Config

Configuration for the science proposals.

!Allocate a new Config object.

In order to ensure that all Config object are always in a proper state when handed to users or to derived Config classes, some attributes are handled at allocation time rather than at initialization

This ensures that even if a derived Config class implements __init__, the author does not need to be concerned about when or even if he should call the base Config.__init__

load(config_files)

Load the configuration override files.

Parameters:config_files (list[str]) – A set of configuration override files.

load_proposals(proposals, alternate_proposals=None)

Load given proposals.

This function loads the propsals requested from the function argument. The argument is a dictionary with two keys: GEN or SEQ and a comma-delimited list of proposal names associated with each key.

Parameters:

• proposals (dict[str: list[str]]) – The set of proposals to load.
• alternate_proposals (str) – A directory location containing alternate proposals to load.

save_as(save_dir='')

Save the configuration objects to separate files.

Parameters:save_dir (str) – The directory in which to save the configuration files.

general_proposals

Listing of available general proposals.

Returns:list[str] – The available general proposals.

general_props

The list of general proposals.

sequence_proposals

Listing of available sequence proposals.

Returns:list[str] – The available sequence proposals.

sequence_props

The list of sequence proposals.