citrine.informatics.design_spaces.design_space module
Tools for working with design spaces.
- class citrine.informatics.design_spaces.design_space.DesignSpace
Bases:
PolymorphicSerializable
[DesignSpace
],AsynchronousObject
A Citrine Design Space describes the set of materials that can be made.
Abstract type that returns the proper type given a serialized dict.
- classmethod build(data: dict) SelfType
Build the underlying type.
- failed() bool
Whether the backend process has completed unsuccessfully.
- classmethod get_type(data) Type[Serializable]
Return the subtype.
- in_progress() bool
Whether the backend process is in progress.
- succeeded() bool
Whether the backend process has completed successfully.
- static wrap_instance(subspace_data: dict) dict
Insert a serialized embedded design space into an entity envelope.
This facilitates deserialization.
- description = None
- property is_locked: bool
If is_locked is true, edits to the design space will be rejected.
- lock_time = None
date and time at which the resource was locked, if it is locked
- Type:
Optional[datetime]
- locked_by = None
id of the user whose action cause the design space to be locked, if it is locked
- Type:
Optional[UUID]
- name = None
- property sample_design_space_executions
Start a Sample Design Space Execution using the current Design Space.
- uid = None
Citrine Platform unique identifier
- Type:
Optional[UUID]