schrodinger.application.models.datamodels.configuration module

Classes to represent a LiveDesign model configuration i.e. a set of values and inheritance rules corresponding to a model definition.

Many of these classes inherit CompoundParam, which is built upon QtCore.QObject. CompoundParam implements features such as serialization, versioning adapters, and Qt signals. As such, it’s a useful base class for data classes.

class schrodinger.application.models.datamodels.configuration.ConfigurationMetadata(*args, _param_type=<object object>, **kwargs)

Bases: ModelMetadata

location: str

A parameter of the class.

authorized_project_ids: list[str]

A parameter of the class.

is_archived: bool

A parameter of the class.

authorized_project_idsChanged

A pyqtSignal emitted by instances of the class.

authorized_project_idsReplaced

A pyqtSignal emitted by instances of the class.

creatorChanged

A pyqtSignal emitted by instances of the class.

creatorReplaced

A pyqtSignal emitted by instances of the class.

date_createdChanged

A pyqtSignal emitted by instances of the class.

date_createdReplaced

A pyqtSignal emitted by instances of the class.

date_editedChanged

A pyqtSignal emitted by instances of the class.

date_editedReplaced

A pyqtSignal emitted by instances of the class.

descriptionChanged

A pyqtSignal emitted by instances of the class.

descriptionReplaced

A pyqtSignal emitted by instances of the class.

docstringChanged

A pyqtSignal emitted by instances of the class.

docstringReplaced

A pyqtSignal emitted by instances of the class.

is_archivedChanged

A pyqtSignal emitted by instances of the class.

is_archivedReplaced

A pyqtSignal emitted by instances of the class.

last_editorChanged

A pyqtSignal emitted by instances of the class.

last_editorReplaced

A pyqtSignal emitted by instances of the class.

locationChanged

A pyqtSignal emitted by instances of the class.

locationReplaced

A pyqtSignal emitted by instances of the class.

model_ownerChanged

A pyqtSignal emitted by instances of the class.

model_ownerReplaced

A pyqtSignal emitted by instances of the class.

nameChanged

A pyqtSignal emitted by instances of the class.

nameReplaced

A pyqtSignal emitted by instances of the class.

versionChanged

A pyqtSignal emitted by instances of the class.

versionReplaced

A pyqtSignal emitted by instances of the class.

class schrodinger.application.models.datamodels.configuration.ChildInheritanceMode

Bases: JsonableEnum

The inheritance mode for static inputs (i.e. non-column inputs)

  • FROM_DEFINTION: This var will be inherited from the definition and will

    always match the value from the most recent version of the definition.

  • MUST_SPECIFY: This var has no value, so the child must specify one.

  • FIXED: This var has a value that will be inherited by all children.

  • HIDDEN: Same as FIXED, but is hidden from the user.

  • OVERRIDABLE: This var has a value that will be inherited by the child,

    and the child may override it.

FROM_DEFINITION = 'FROM-DEFINITION'
MUST_SPECIFY = 'MUST-SPECIFY'
FIXED = 'FIXED'
HIDDEN = 'HIDDEN'
OVERRIDABLE = 'OVERRIDABLE'
class schrodinger.application.models.datamodels.configuration.InputConfig(*args, _param_type=<object object>, **kwargs)

Bases: CompoundParam

name: str

A parameter of the class.

val: str

A parameter of the class.

child_inheritance_mode: ChildInheritanceMode

A parameter of the class.

child_inheritance_modeChanged

A pyqtSignal emitted by instances of the class.

child_inheritance_modeReplaced

A pyqtSignal emitted by instances of the class.

nameChanged

A pyqtSignal emitted by instances of the class.

nameReplaced

A pyqtSignal emitted by instances of the class.

valChanged

A pyqtSignal emitted by instances of the class.

valReplaced

A pyqtSignal emitted by instances of the class.

class schrodinger.application.models.datamodels.configuration.ModelConfiguration(*args, _param_type=<object object>, **kwargs)

Bases: CompoundParam

Variables:
  • definition_id – The ID of the model definition on which this configuration is based.

  • config_id – The ID of this model configuration.

  • parent_config_id – The ID of the parent model configuration, if this configuration is a child. None if this is the root configuration.

  • metadata – Metadata for this model configuration.

  • auto_recalculate – Whether or not this model configuration should automatically recalculate when versions change.

  • settings – The settings for this model configuration.

definition_id: str

A parameter of the class.

config_id: str

A parameter of the class.

parent_config_id: str

A parameter of the class.

metadata: ConfigurationMetadata

A parameter of the class.

auto_recalculate: bool

A parameter of the class.

inputs: list[InputConfig]

A parameter of the class.

initConcrete()

Override to customize initialization of concrete params.

auto_recalculateChanged

A pyqtSignal emitted by instances of the class.

auto_recalculateReplaced

A pyqtSignal emitted by instances of the class.

config_idChanged

A pyqtSignal emitted by instances of the class.

config_idReplaced

A pyqtSignal emitted by instances of the class.

definition_idChanged

A pyqtSignal emitted by instances of the class.

definition_idReplaced

A pyqtSignal emitted by instances of the class.

inputsChanged

A pyqtSignal emitted by instances of the class.

inputsReplaced

A pyqtSignal emitted by instances of the class.

metadataChanged

A pyqtSignal emitted by instances of the class.

metadataReplaced

A pyqtSignal emitted by instances of the class.

parent_config_idChanged

A pyqtSignal emitted by instances of the class.

parent_config_idReplaced

A pyqtSignal emitted by instances of the class.