gemd.entity.object.material_run module
- class gemd.entity.object.material_run.MaterialRun(name: str, *, spec: Optional[Union[MaterialSpec, LinkByUID]] = None, process: Optional[Union[ProcessRun, LinkByUID]] = None, sample_type: Union[SampleType, str] = 'unknown', uids: Optional[Mapping[str, str]] = None, tags: Optional[Iterable[str]] = None, notes: Optional[str] = None, file_links: Optional[Union[Iterable[FileLink], FileLink]] = None)
Bases:
BaseObject,HasSpec,HasProcessA material run.
This includes a link to the originating process and soft links to measurements.
- Parameters
name (str, required) – Name of the material run.
uids (Map[str, str], optional) – A collection of unique IDs.
tags (List[str], optional) – Tags are hierarchical strings that store information about an entity. They can be used for filtering and discoverability.
notes (str, optional) – Long-form notes about the material run.
process (ProcessRun) – Process that produces this material.
sample_type (str, optional) – The form of this sample. Optionals are “experimental”, “virtual”, “production”, or “unknown.” Default is “unknown.”
spec (
MaterialSpec) – The material specification of which this is an instance.file_links (List[FileLink], optional) – Links to associated files, with resource paths into the files API.
- add_uid(scope: str, uid: str)
Add a uid.
- Parameters
scope (str) – scope of the uid
uid (str) – Unique identifier
- all_dependencies() Set[Union[BaseEntityType, LinkByUIDType]]
Return a set of all immediate dependencies (no recursion).
- as_dict() Dict[str, Any]
Convert the object to a dictionary.
- Returns
A dictionary representation of the object, where the keys are its fields.
- Return type
dict
- static build(d: Mapping[str, Any]) DictSerializableType
Build an object from a JSON dictionary.
This differs from from_dict in that the values themselves may also be dictionaries corresponding to serialized DictSerializable objects.
- Parameters
d (dict) – The object as a serialized dictionary.
- Returns
The deserialized object.
- Return type
- dump() Dict[str, Any]
Convert the object to a JSON dictionary, so that every entry is serialized.
Uses the json encoder client, so objects with uids are converted to LinkByUID dictionaries.
- Returns
A string representation of the object as a dictionary.
- Return type
str
- classmethod from_dict(d: Mapping[str, Any]) DictSerializableType
Reconstitute the object from a dictionary.
- Parameters
d (dict) – The object as a dictionary of key-value pairs that correspond to the object’s fields.
- Returns
The deserialized object.
- Return type
- to_link(scope: Optional[str] = None, *, allow_fallback: bool = False) LinkByUIDType
Generate a ~gemd.entity.link_by_uid.LinkByUID for this object.
- Parameters
scope (str, optional) – scope of the uid to get
allow_fallback (bool) – whether to grab another scope/id if chosen scope is missing (Default: False).
- Return type
- property file_links: List[FileLink]
Links to associated files, with resource paths into the files API.
- property measurements: List[MeasurementRunType]
Measurements performed on this material.
The link is established by creating the measurement run and settings its material field to this material run.
- property name: str
Name of the object.
- property process: Union[ProcessRun, LinkByUID]
Get the originating process run.
- property sample_type: SampleType
Get the sample type.
- skip = {'_measurements'}
- property spec: Union[HasTemplate, LinkByUID]
A spec, which expresses the anticipated or aspirational behavior of this object.
- property tags: List[str]
A collection of structured labels.
Tags are hierarchical strings that store information about an entity. They can be used for filtering and discoverability.
- property template: Optional[Union[BaseTemplate, LinkByUID]]
Get the template associated with the spec.
- typ = 'material_run'