7.1.1.5. citrine.resources package
7.1.1.5.1. Submodules
- citrine.resources.analysis_workflow module
AnalysisWorkflowCollection
AnalysisWorkflowCollection.archive()
AnalysisWorkflowCollection.build()
AnalysisWorkflowCollection.delete()
AnalysisWorkflowCollection.get()
AnalysisWorkflowCollection.list()
AnalysisWorkflowCollection.list_all()
AnalysisWorkflowCollection.list_archived()
AnalysisWorkflowCollection.rebuild()
AnalysisWorkflowCollection.register()
AnalysisWorkflowCollection.restore()
AnalysisWorkflowCollection.update()
- citrine.resources.api_error module
- citrine.resources.attribute_templates module
AttributeTemplate
AttributeTemplate.add_uid()
AttributeTemplate.all_dependencies()
AttributeTemplate.as_dict()
AttributeTemplate.build()
AttributeTemplate.dump()
AttributeTemplate.from_dict()
AttributeTemplate.get_collection_type()
AttributeTemplate.get_type()
AttributeTemplate.to_link()
AttributeTemplate.audit_info
AttributeTemplate.bounds
AttributeTemplate.collection_dict
AttributeTemplate.dataset
AttributeTemplate.description
AttributeTemplate.name
AttributeTemplate.skip
AttributeTemplate.typ
AttributeTemplate.uid
AttributeTemplateCollection
AttributeTemplateCollection.async_update()
AttributeTemplateCollection.build()
AttributeTemplateCollection.delete()
AttributeTemplateCollection.get()
AttributeTemplateCollection.get_type()
AttributeTemplateCollection.list()
AttributeTemplateCollection.list_by_name()
AttributeTemplateCollection.list_by_tag()
AttributeTemplateCollection.poll_async_update_job()
AttributeTemplateCollection.register()
AttributeTemplateCollection.register_all()
AttributeTemplateCollection.update()
- citrine.resources.audit_info module
- citrine.resources.branch module
Branch
BranchCollection
BranchCollection.archive()
BranchCollection.build()
BranchCollection.data_updates()
BranchCollection.delete()
BranchCollection.get()
BranchCollection.get_by_version_id()
BranchCollection.list()
BranchCollection.list_all()
BranchCollection.list_archived()
BranchCollection.next_version()
BranchCollection.register()
BranchCollection.restore()
BranchCollection.update()
BranchCollection.update_data()
- citrine.resources.catalyst module
- citrine.resources.condition_template module
ConditionTemplate
ConditionTemplate.access_control_dict()
ConditionTemplate.add_uid()
ConditionTemplate.all_dependencies()
ConditionTemplate.as_dict()
ConditionTemplate.build()
ConditionTemplate.dump()
ConditionTemplate.from_dict()
ConditionTemplate.get_collection_type()
ConditionTemplate.get_type()
ConditionTemplate.to_link()
ConditionTemplate.audit_info
ConditionTemplate.collection_dict
ConditionTemplate.dataset
ConditionTemplate.description
ConditionTemplate.name
ConditionTemplate.skip
ConditionTemplate.typ
ConditionTemplate.uid
ConditionTemplateCollection
ConditionTemplateCollection.async_update()
ConditionTemplateCollection.build()
ConditionTemplateCollection.delete()
ConditionTemplateCollection.get()
ConditionTemplateCollection.get_type()
ConditionTemplateCollection.list()
ConditionTemplateCollection.list_by_name()
ConditionTemplateCollection.list_by_tag()
ConditionTemplateCollection.poll_async_update_job()
ConditionTemplateCollection.register()
ConditionTemplateCollection.register_all()
ConditionTemplateCollection.update()
- citrine.resources.data_concepts module
DataConcepts
DataConcepts.add_uid()
DataConcepts.all_dependencies()
DataConcepts.as_dict()
DataConcepts.build()
DataConcepts.dump()
DataConcepts.from_dict()
DataConcepts.get_collection_type()
DataConcepts.get_type()
DataConcepts.to_link()
DataConcepts.audit_info
DataConcepts.collection_dict
DataConcepts.dataset
DataConcepts.skip
DataConcepts.tags
DataConcepts.typ
DataConcepts.uid
DataConcepts.uids
DataConceptsCollection
DataConceptsCollection.async_update()
DataConceptsCollection.build()
DataConceptsCollection.delete()
DataConceptsCollection.get()
DataConceptsCollection.get_type()
DataConceptsCollection.list()
DataConceptsCollection.list_by_name()
DataConceptsCollection.list_by_tag()
DataConceptsCollection.poll_async_update_job()
DataConceptsCollection.register()
DataConceptsCollection.register_all()
DataConceptsCollection.update()
DataConceptsMeta
- citrine.resources.data_objects module
DataObject
DataObject.add_uid()
DataObject.all_dependencies()
DataObject.as_dict()
DataObject.build()
DataObject.dump()
DataObject.from_dict()
DataObject.get_collection_type()
DataObject.get_type()
DataObject.to_link()
DataObject.audit_info
DataObject.collection_dict
DataObject.dataset
DataObject.file_links
DataObject.name
DataObject.notes
DataObject.skip
DataObject.typ
DataObject.uid
DataObjectCollection
DataObjectCollection.async_update()
DataObjectCollection.build()
DataObjectCollection.delete()
DataObjectCollection.get()
DataObjectCollection.get_type()
DataObjectCollection.list()
DataObjectCollection.list_by_attribute_bounds()
DataObjectCollection.list_by_name()
DataObjectCollection.list_by_tag()
DataObjectCollection.poll_async_update_job()
DataObjectCollection.register()
DataObjectCollection.register_all()
DataObjectCollection.update()
DataObjectCollection.validate_templates()
- citrine.resources.data_version_update module
- citrine.resources.dataset module
Dataset
Dataset.access_control_dict()
Dataset.build()
Dataset.delete()
Dataset.delete_contents()
Dataset.dump()
Dataset.gemd_batch_delete()
Dataset.register()
Dataset.register_all()
Dataset.update()
Dataset.condition_templates
Dataset.create_time
Dataset.created_by
Dataset.delete_time
Dataset.deleted
Dataset.deleted_by
Dataset.description
Dataset.files
Dataset.gemd
Dataset.ingestions
Dataset.ingredient_runs
Dataset.ingredient_specs
Dataset.material_runs
Dataset.material_specs
Dataset.material_templates
Dataset.measurement_runs
Dataset.measurement_specs
Dataset.measurement_templates
Dataset.name
Dataset.parameter_templates
Dataset.process_runs
Dataset.process_specs
Dataset.process_templates
Dataset.project_id
Dataset.property_templates
Dataset.public
Dataset.session
Dataset.summary
Dataset.team_id
Dataset.uid
Dataset.unique_name
Dataset.update_time
Dataset.updated_by
DatasetCollection
- citrine.resources.delete module
- citrine.resources.descriptors module
- citrine.resources.design_execution module
DesignExecutionCollection
DesignExecutionCollection.archive()
DesignExecutionCollection.build()
DesignExecutionCollection.delete()
DesignExecutionCollection.get()
DesignExecutionCollection.list()
DesignExecutionCollection.register()
DesignExecutionCollection.restore()
DesignExecutionCollection.trigger()
DesignExecutionCollection.update()
- citrine.resources.design_space module
DefaultDesignSpaceMode
DesignSpaceCollection
DesignSpaceCollection.archive()
DesignSpaceCollection.build()
DesignSpaceCollection.convert_to_hierarchical()
DesignSpaceCollection.create_default()
DesignSpaceCollection.delete()
DesignSpaceCollection.get()
DesignSpaceCollection.list()
DesignSpaceCollection.list_all()
DesignSpaceCollection.list_archived()
DesignSpaceCollection.register()
DesignSpaceCollection.restore()
DesignSpaceCollection.update()
- citrine.resources.design_workflow module
DesignWorkflowCollection
DesignWorkflowCollection.archive()
DesignWorkflowCollection.build()
DesignWorkflowCollection.delete()
DesignWorkflowCollection.get()
DesignWorkflowCollection.list()
DesignWorkflowCollection.list_archived()
DesignWorkflowCollection.register()
DesignWorkflowCollection.restore()
DesignWorkflowCollection.update()
- citrine.resources.experiment_datasource module
CandidateExperimentSnapshot
CandidateExperimentSnapshot.build()
CandidateExperimentSnapshot.dump()
CandidateExperimentSnapshot.candidate_id
CandidateExperimentSnapshot.description
CandidateExperimentSnapshot.name
CandidateExperimentSnapshot.overrides
CandidateExperimentSnapshot.uid
CandidateExperimentSnapshot.updated_time
CandidateExperimentSnapshot.workflow_id
ExperimentDataSource
ExperimentDataSourceCollection
- citrine.resources.file_link module
CsvColumnInfo
FileCollection
FileLink
FileLink.access_control_dict()
FileLink.as_dict()
FileLink.build()
FileLink.dump()
FileLink.from_dict()
FileLink.from_path()
FileLink.created_by
FileLink.created_time
FileLink.description
FileLink.filename
FileLink.mime_type
FileLink.name
FileLink.size
FileLink.skip
FileLink.typ
FileLink.uid
FileLink.url
FileLink.version
FileLink.version_number
FileLinkMeta
SearchFileFilterTypeEnum
- citrine.resources.gemd_resource module
GEMDResourceCollection
GEMDResourceCollection.async_update()
GEMDResourceCollection.batch_delete()
GEMDResourceCollection.build()
GEMDResourceCollection.delete()
GEMDResourceCollection.get()
GEMDResourceCollection.get_type()
GEMDResourceCollection.list()
GEMDResourceCollection.list_by_name()
GEMDResourceCollection.list_by_tag()
GEMDResourceCollection.poll_async_update_job()
GEMDResourceCollection.register()
GEMDResourceCollection.register_all()
GEMDResourceCollection.update()
- citrine.resources.gemtables module
GemTable
GemTableCollection
GemTableCollection.build()
GemTableCollection.build_from_config()
GemTableCollection.delete()
GemTableCollection.get()
GemTableCollection.get_by_build_job()
GemTableCollection.initiate_build()
GemTableCollection.list()
GemTableCollection.list_by_config()
GemTableCollection.list_versions()
GemTableCollection.read()
GemTableCollection.read_to_memory()
GemTableCollection.register()
GemTableCollection.update()
GemTableCollection.table_type
GemTableVersionPaginator
- citrine.resources.generative_design_execution module
GenerativeDesignExecutionCollection
GenerativeDesignExecutionCollection.build()
GenerativeDesignExecutionCollection.delete()
GenerativeDesignExecutionCollection.get()
GenerativeDesignExecutionCollection.list()
GenerativeDesignExecutionCollection.register()
GenerativeDesignExecutionCollection.trigger()
GenerativeDesignExecutionCollection.update()
- citrine.resources.ingestion module
IngestionException
FailedIngestion
FailedIngestion.access_control_dict()
FailedIngestion.build()
FailedIngestion.build_objects()
FailedIngestion.build_objects_async()
FailedIngestion.dump()
FailedIngestion.poll_for_job_completion()
FailedIngestion.status()
FailedIngestion.dataset_id
FailedIngestion.project_id
FailedIngestion.raise_errors
FailedIngestion.session
FailedIngestion.team_id
FailedIngestion.uid
Ingestion
IngestionCollection
IngestionErrorFamily
IngestionErrorLevel
IngestionErrorTrace
IngestionErrorTrace.access_control_dict()
IngestionErrorTrace.build()
IngestionErrorTrace.dump()
IngestionErrorTrace.from_validation_error()
IngestionErrorTrace.column_number
IngestionErrorTrace.dataset_file_id
IngestionErrorTrace.error_type
IngestionErrorTrace.family
IngestionErrorTrace.file_version_uuid
IngestionErrorTrace.level
IngestionErrorTrace.msg
IngestionErrorTrace.row_number
IngestionErrorType
IngestionErrorType.CATEGORICAL_OUTSIDE_BOUNDS_ERROR
IngestionErrorType.COLLIDING_ID
IngestionErrorType.DUPLICATED_MATERIAL
IngestionErrorType.EMPTY_ASPECT_NAME
IngestionErrorType.EXISTING_TEMPLATE_WITH_REAL_BOUNDS
IngestionErrorType.FILE_EXTENSION_NOT_SUPPORTED
IngestionErrorType.INCOMPATIBLE_UNITS
IngestionErrorType.INTEGER_OUTSIDE_BOUNDS_ERROR
IngestionErrorType.INVALID_ANNOTATION
IngestionErrorType.INVALID_BASIS_ON_ASPECT
IngestionErrorType.INVALID_DUPLICATE_NAME
IngestionErrorType.INVALID_FRACTION_ON_ASPECT
IngestionErrorType.INVALID_PROCESS_REFERENCE
IngestionErrorType.INVALID_TYPE_HINT_ON_ASPECT
IngestionErrorType.INVALID_UNITS_ON_ASPECT
IngestionErrorType.MISSING_ASPECT_TYPE
IngestionErrorType.MISSING_RAW_FOR_INGREDIENT
IngestionErrorType.MISSING_TYPE_HEADER
IngestionErrorType.REAL_OUTSIDE_BOUNDS_ERROR
IngestionErrorType.REGISTERING_OBJECTS_ERROR
IngestionErrorType.UNKNOWN_ERROR
IngestionStatus
IngestionStatusType
- citrine.resources.ingredient_run module
IngredientRun
IngredientRun.access_control_dict()
IngredientRun.add_uid()
IngredientRun.all_dependencies()
IngredientRun.as_dict()
IngredientRun.build()
IngredientRun.dump()
IngredientRun.from_dict()
IngredientRun.get_collection_type()
IngredientRun.get_type()
IngredientRun.to_link()
IngredientRun.absolute_quantity
IngredientRun.audit_info
IngredientRun.collection_dict
IngredientRun.dataset
IngredientRun.labels
IngredientRun.mass_fraction
IngredientRun.material
IngredientRun.name
IngredientRun.notes
IngredientRun.number_fraction
IngredientRun.process
IngredientRun.skip
IngredientRun.spec
IngredientRun.template
IngredientRun.typ
IngredientRun.uid
IngredientRun.volume_fraction
IngredientRunCollection
IngredientRunCollection.async_update()
IngredientRunCollection.build()
IngredientRunCollection.delete()
IngredientRunCollection.get()
IngredientRunCollection.get_type()
IngredientRunCollection.list()
IngredientRunCollection.list_by_attribute_bounds()
IngredientRunCollection.list_by_material()
IngredientRunCollection.list_by_name()
IngredientRunCollection.list_by_process()
IngredientRunCollection.list_by_spec()
IngredientRunCollection.list_by_tag()
IngredientRunCollection.poll_async_update_job()
IngredientRunCollection.register()
IngredientRunCollection.register_all()
IngredientRunCollection.update()
IngredientRunCollection.validate_templates()
- citrine.resources.ingredient_spec module
IngredientSpec
IngredientSpec.access_control_dict()
IngredientSpec.add_uid()
IngredientSpec.all_dependencies()
IngredientSpec.as_dict()
IngredientSpec.build()
IngredientSpec.dump()
IngredientSpec.from_dict()
IngredientSpec.get_collection_type()
IngredientSpec.get_type()
IngredientSpec.to_link()
IngredientSpec.absolute_quantity
IngredientSpec.audit_info
IngredientSpec.collection_dict
IngredientSpec.dataset
IngredientSpec.labels
IngredientSpec.mass_fraction
IngredientSpec.material
IngredientSpec.name
IngredientSpec.notes
IngredientSpec.number_fraction
IngredientSpec.process
IngredientSpec.skip
IngredientSpec.template
IngredientSpec.typ
IngredientSpec.uid
IngredientSpec.volume_fraction
IngredientSpecCollection
IngredientSpecCollection.async_update()
IngredientSpecCollection.build()
IngredientSpecCollection.delete()
IngredientSpecCollection.get()
IngredientSpecCollection.get_type()
IngredientSpecCollection.list()
IngredientSpecCollection.list_by_attribute_bounds()
IngredientSpecCollection.list_by_material()
IngredientSpecCollection.list_by_name()
IngredientSpecCollection.list_by_process()
IngredientSpecCollection.list_by_tag()
IngredientSpecCollection.poll_async_update_job()
IngredientSpecCollection.register()
IngredientSpecCollection.register_all()
IngredientSpecCollection.update()
IngredientSpecCollection.validate_templates()
- citrine.resources.material_run module
MaterialRun
MaterialRun.access_control_dict()
MaterialRun.add_uid()
MaterialRun.all_dependencies()
MaterialRun.as_dict()
MaterialRun.build()
MaterialRun.dump()
MaterialRun.from_dict()
MaterialRun.get_collection_type()
MaterialRun.get_type()
MaterialRun.to_link()
MaterialRun.audit_info
MaterialRun.collection_dict
MaterialRun.dataset
MaterialRun.measurements
MaterialRun.name
MaterialRun.notes
MaterialRun.process
MaterialRun.sample_type
MaterialRun.skip
MaterialRun.spec
MaterialRun.template
MaterialRun.typ
MaterialRun.uid
MaterialRunCollection
MaterialRunCollection.async_update()
MaterialRunCollection.build()
MaterialRunCollection.delete()
MaterialRunCollection.get()
MaterialRunCollection.get_by_process()
MaterialRunCollection.get_history()
MaterialRunCollection.get_type()
MaterialRunCollection.list()
MaterialRunCollection.list_by_attribute_bounds()
MaterialRunCollection.list_by_name()
MaterialRunCollection.list_by_spec()
MaterialRunCollection.list_by_tag()
MaterialRunCollection.list_by_template()
MaterialRunCollection.poll_async_update_job()
MaterialRunCollection.register()
MaterialRunCollection.register_all()
MaterialRunCollection.update()
MaterialRunCollection.validate_templates()
- citrine.resources.material_spec module
MaterialSpec
MaterialSpec.access_control_dict()
MaterialSpec.add_uid()
MaterialSpec.all_dependencies()
MaterialSpec.as_dict()
MaterialSpec.build()
MaterialSpec.dump()
MaterialSpec.from_dict()
MaterialSpec.get_collection_type()
MaterialSpec.get_type()
MaterialSpec.to_link()
MaterialSpec.audit_info
MaterialSpec.collection_dict
MaterialSpec.dataset
MaterialSpec.name
MaterialSpec.notes
MaterialSpec.process
MaterialSpec.properties
MaterialSpec.skip
MaterialSpec.template
MaterialSpec.typ
MaterialSpec.uid
MaterialSpecCollection
MaterialSpecCollection.async_update()
MaterialSpecCollection.build()
MaterialSpecCollection.delete()
MaterialSpecCollection.get()
MaterialSpecCollection.get_by_process()
MaterialSpecCollection.get_type()
MaterialSpecCollection.list()
MaterialSpecCollection.list_by_attribute_bounds()
MaterialSpecCollection.list_by_name()
MaterialSpecCollection.list_by_tag()
MaterialSpecCollection.list_by_template()
MaterialSpecCollection.poll_async_update_job()
MaterialSpecCollection.register()
MaterialSpecCollection.register_all()
MaterialSpecCollection.update()
MaterialSpecCollection.validate_templates()
- citrine.resources.material_template module
MaterialTemplate
MaterialTemplate.access_control_dict()
MaterialTemplate.add_uid()
MaterialTemplate.all_dependencies()
MaterialTemplate.as_dict()
MaterialTemplate.build()
MaterialTemplate.dump()
MaterialTemplate.from_dict()
MaterialTemplate.get_collection_type()
MaterialTemplate.get_type()
MaterialTemplate.to_link()
MaterialTemplate.validate_property()
MaterialTemplate.audit_info
MaterialTemplate.collection_dict
MaterialTemplate.dataset
MaterialTemplate.description
MaterialTemplate.name
MaterialTemplate.properties
MaterialTemplate.skip
MaterialTemplate.typ
MaterialTemplate.uid
MaterialTemplateCollection
MaterialTemplateCollection.async_update()
MaterialTemplateCollection.build()
MaterialTemplateCollection.delete()
MaterialTemplateCollection.get()
MaterialTemplateCollection.get_type()
MaterialTemplateCollection.list()
MaterialTemplateCollection.list_by_name()
MaterialTemplateCollection.list_by_tag()
MaterialTemplateCollection.poll_async_update_job()
MaterialTemplateCollection.register()
MaterialTemplateCollection.register_all()
MaterialTemplateCollection.update()
- citrine.resources.measurement_run module
MeasurementRun
MeasurementRun.access_control_dict()
MeasurementRun.add_uid()
MeasurementRun.all_dependencies()
MeasurementRun.as_dict()
MeasurementRun.build()
MeasurementRun.dump()
MeasurementRun.from_dict()
MeasurementRun.get_collection_type()
MeasurementRun.get_type()
MeasurementRun.to_link()
MeasurementRun.audit_info
MeasurementRun.collection_dict
MeasurementRun.conditions
MeasurementRun.dataset
MeasurementRun.material
MeasurementRun.name
MeasurementRun.notes
MeasurementRun.parameters
MeasurementRun.properties
MeasurementRun.skip
MeasurementRun.source
MeasurementRun.spec
MeasurementRun.template
MeasurementRun.typ
MeasurementRun.uid
MeasurementRunCollection
MeasurementRunCollection.async_update()
MeasurementRunCollection.build()
MeasurementRunCollection.delete()
MeasurementRunCollection.get()
MeasurementRunCollection.get_type()
MeasurementRunCollection.list()
MeasurementRunCollection.list_by_attribute_bounds()
MeasurementRunCollection.list_by_material()
MeasurementRunCollection.list_by_name()
MeasurementRunCollection.list_by_spec()
MeasurementRunCollection.list_by_tag()
MeasurementRunCollection.poll_async_update_job()
MeasurementRunCollection.register()
MeasurementRunCollection.register_all()
MeasurementRunCollection.update()
MeasurementRunCollection.validate_templates()
- citrine.resources.measurement_spec module
MeasurementSpec
MeasurementSpec.access_control_dict()
MeasurementSpec.add_uid()
MeasurementSpec.all_dependencies()
MeasurementSpec.as_dict()
MeasurementSpec.build()
MeasurementSpec.dump()
MeasurementSpec.from_dict()
MeasurementSpec.get_collection_type()
MeasurementSpec.get_type()
MeasurementSpec.to_link()
MeasurementSpec.audit_info
MeasurementSpec.collection_dict
MeasurementSpec.conditions
MeasurementSpec.dataset
MeasurementSpec.name
MeasurementSpec.notes
MeasurementSpec.parameters
MeasurementSpec.skip
MeasurementSpec.template
MeasurementSpec.typ
MeasurementSpec.uid
MeasurementSpecCollection
MeasurementSpecCollection.async_update()
MeasurementSpecCollection.build()
MeasurementSpecCollection.delete()
MeasurementSpecCollection.get()
MeasurementSpecCollection.get_type()
MeasurementSpecCollection.list()
MeasurementSpecCollection.list_by_attribute_bounds()
MeasurementSpecCollection.list_by_name()
MeasurementSpecCollection.list_by_tag()
MeasurementSpecCollection.list_by_template()
MeasurementSpecCollection.poll_async_update_job()
MeasurementSpecCollection.register()
MeasurementSpecCollection.register_all()
MeasurementSpecCollection.update()
MeasurementSpecCollection.validate_templates()
- citrine.resources.measurement_template module
MeasurementTemplate
MeasurementTemplate.access_control_dict()
MeasurementTemplate.add_uid()
MeasurementTemplate.all_dependencies()
MeasurementTemplate.as_dict()
MeasurementTemplate.build()
MeasurementTemplate.dump()
MeasurementTemplate.from_dict()
MeasurementTemplate.get_collection_type()
MeasurementTemplate.get_type()
MeasurementTemplate.to_link()
MeasurementTemplate.validate_condition()
MeasurementTemplate.validate_parameter()
MeasurementTemplate.validate_property()
MeasurementTemplate.audit_info
MeasurementTemplate.collection_dict
MeasurementTemplate.conditions
MeasurementTemplate.dataset
MeasurementTemplate.description
MeasurementTemplate.name
MeasurementTemplate.parameters
MeasurementTemplate.properties
MeasurementTemplate.skip
MeasurementTemplate.typ
MeasurementTemplate.uid
MeasurementTemplateCollection
MeasurementTemplateCollection.async_update()
MeasurementTemplateCollection.build()
MeasurementTemplateCollection.delete()
MeasurementTemplateCollection.get()
MeasurementTemplateCollection.get_type()
MeasurementTemplateCollection.list()
MeasurementTemplateCollection.list_by_name()
MeasurementTemplateCollection.list_by_tag()
MeasurementTemplateCollection.poll_async_update_job()
MeasurementTemplateCollection.register()
MeasurementTemplateCollection.register_all()
MeasurementTemplateCollection.update()
- citrine.resources.object_runs module
ObjectRun
ObjectRun.add_uid()
ObjectRun.all_dependencies()
ObjectRun.as_dict()
ObjectRun.build()
ObjectRun.dump()
ObjectRun.from_dict()
ObjectRun.get_collection_type()
ObjectRun.get_type()
ObjectRun.to_link()
ObjectRun.audit_info
ObjectRun.collection_dict
ObjectRun.dataset
ObjectRun.name
ObjectRun.notes
ObjectRun.skip
ObjectRun.spec
ObjectRun.template
ObjectRun.typ
ObjectRun.uid
ObjectRunCollection
ObjectRunCollection.async_update()
ObjectRunCollection.build()
ObjectRunCollection.delete()
ObjectRunCollection.get()
ObjectRunCollection.get_type()
ObjectRunCollection.list()
ObjectRunCollection.list_by_attribute_bounds()
ObjectRunCollection.list_by_name()
ObjectRunCollection.list_by_tag()
ObjectRunCollection.poll_async_update_job()
ObjectRunCollection.register()
ObjectRunCollection.register_all()
ObjectRunCollection.update()
ObjectRunCollection.validate_templates()
- citrine.resources.object_specs module
ObjectSpec
ObjectSpec.add_uid()
ObjectSpec.all_dependencies()
ObjectSpec.as_dict()
ObjectSpec.build()
ObjectSpec.dump()
ObjectSpec.from_dict()
ObjectSpec.get_collection_type()
ObjectSpec.get_type()
ObjectSpec.to_link()
ObjectSpec.audit_info
ObjectSpec.collection_dict
ObjectSpec.dataset
ObjectSpec.name
ObjectSpec.notes
ObjectSpec.skip
ObjectSpec.typ
ObjectSpec.uid
ObjectSpecCollection
ObjectSpecCollection.async_update()
ObjectSpecCollection.build()
ObjectSpecCollection.delete()
ObjectSpecCollection.get()
ObjectSpecCollection.get_type()
ObjectSpecCollection.list()
ObjectSpecCollection.list_by_attribute_bounds()
ObjectSpecCollection.list_by_name()
ObjectSpecCollection.list_by_tag()
ObjectSpecCollection.poll_async_update_job()
ObjectSpecCollection.register()
ObjectSpecCollection.register_all()
ObjectSpecCollection.update()
ObjectSpecCollection.validate_templates()
- citrine.resources.object_templates module
ObjectTemplate
ObjectTemplate.add_uid()
ObjectTemplate.all_dependencies()
ObjectTemplate.as_dict()
ObjectTemplate.build()
ObjectTemplate.dump()
ObjectTemplate.from_dict()
ObjectTemplate.get_collection_type()
ObjectTemplate.get_type()
ObjectTemplate.to_link()
ObjectTemplate.audit_info
ObjectTemplate.collection_dict
ObjectTemplate.dataset
ObjectTemplate.description
ObjectTemplate.name
ObjectTemplate.skip
ObjectTemplate.typ
ObjectTemplate.uid
ObjectTemplateCollection
ObjectTemplateCollection.async_update()
ObjectTemplateCollection.build()
ObjectTemplateCollection.delete()
ObjectTemplateCollection.get()
ObjectTemplateCollection.get_type()
ObjectTemplateCollection.list()
ObjectTemplateCollection.list_by_name()
ObjectTemplateCollection.list_by_tag()
ObjectTemplateCollection.poll_async_update_job()
ObjectTemplateCollection.register()
ObjectTemplateCollection.register_all()
ObjectTemplateCollection.update()
- citrine.resources.parameter_template module
ParameterTemplate
ParameterTemplate.access_control_dict()
ParameterTemplate.add_uid()
ParameterTemplate.all_dependencies()
ParameterTemplate.as_dict()
ParameterTemplate.build()
ParameterTemplate.dump()
ParameterTemplate.from_dict()
ParameterTemplate.get_collection_type()
ParameterTemplate.get_type()
ParameterTemplate.to_link()
ParameterTemplate.audit_info
ParameterTemplate.collection_dict
ParameterTemplate.dataset
ParameterTemplate.description
ParameterTemplate.name
ParameterTemplate.skip
ParameterTemplate.typ
ParameterTemplate.uid
ParameterTemplateCollection
ParameterTemplateCollection.async_update()
ParameterTemplateCollection.build()
ParameterTemplateCollection.delete()
ParameterTemplateCollection.get()
ParameterTemplateCollection.get_type()
ParameterTemplateCollection.list()
ParameterTemplateCollection.list_by_name()
ParameterTemplateCollection.list_by_tag()
ParameterTemplateCollection.poll_async_update_job()
ParameterTemplateCollection.register()
ParameterTemplateCollection.register_all()
ParameterTemplateCollection.update()
- citrine.resources.predictor module
AsyncDefaultPredictor
AutoConfigureMode
PredictorCollection
PredictorCollection.archive()
PredictorCollection.archive_root()
PredictorCollection.archive_version()
PredictorCollection.build()
PredictorCollection.check_for_update()
PredictorCollection.create_default()
PredictorCollection.create_default_async()
PredictorCollection.delete()
PredictorCollection.get()
PredictorCollection.get_default_async()
PredictorCollection.get_featurized_training_data()
PredictorCollection.is_stale()
PredictorCollection.list()
PredictorCollection.list_all()
PredictorCollection.list_archived()
PredictorCollection.list_archived_versions()
PredictorCollection.list_versions()
PredictorCollection.register()
PredictorCollection.rename()
PredictorCollection.restore()
PredictorCollection.restore_root()
PredictorCollection.restore_version()
PredictorCollection.retrain_stale()
PredictorCollection.root_is_archived()
PredictorCollection.train()
PredictorCollection.update()
- citrine.resources.predictor_evaluation_execution module
PredictorEvaluationExecutionCollection
PredictorEvaluationExecutionCollection.archive()
PredictorEvaluationExecutionCollection.build()
PredictorEvaluationExecutionCollection.delete()
PredictorEvaluationExecutionCollection.get()
PredictorEvaluationExecutionCollection.list()
PredictorEvaluationExecutionCollection.register()
PredictorEvaluationExecutionCollection.restore()
PredictorEvaluationExecutionCollection.trigger()
PredictorEvaluationExecutionCollection.update()
- citrine.resources.predictor_evaluation_workflow module
PredictorEvaluationWorkflowCollection
PredictorEvaluationWorkflowCollection.archive()
PredictorEvaluationWorkflowCollection.build()
PredictorEvaluationWorkflowCollection.create_default()
PredictorEvaluationWorkflowCollection.delete()
PredictorEvaluationWorkflowCollection.get()
PredictorEvaluationWorkflowCollection.list()
PredictorEvaluationWorkflowCollection.register()
PredictorEvaluationWorkflowCollection.restore()
PredictorEvaluationWorkflowCollection.update()
- citrine.resources.process_run module
ProcessRun
ProcessRun.access_control_dict()
ProcessRun.add_uid()
ProcessRun.all_dependencies()
ProcessRun.as_dict()
ProcessRun.build()
ProcessRun.dump()
ProcessRun.from_dict()
ProcessRun.get_collection_type()
ProcessRun.get_type()
ProcessRun.to_link()
ProcessRun.audit_info
ProcessRun.collection_dict
ProcessRun.conditions
ProcessRun.dataset
ProcessRun.ingredients
ProcessRun.name
ProcessRun.notes
ProcessRun.output_material
ProcessRun.parameters
ProcessRun.skip
ProcessRun.source
ProcessRun.spec
ProcessRun.template
ProcessRun.typ
ProcessRun.uid
ProcessRunCollection
ProcessRunCollection.async_update()
ProcessRunCollection.build()
ProcessRunCollection.delete()
ProcessRunCollection.get()
ProcessRunCollection.get_type()
ProcessRunCollection.list()
ProcessRunCollection.list_by_attribute_bounds()
ProcessRunCollection.list_by_name()
ProcessRunCollection.list_by_spec()
ProcessRunCollection.list_by_tag()
ProcessRunCollection.poll_async_update_job()
ProcessRunCollection.register()
ProcessRunCollection.register_all()
ProcessRunCollection.update()
ProcessRunCollection.validate_templates()
- citrine.resources.process_spec module
ProcessSpec
ProcessSpec.access_control_dict()
ProcessSpec.add_uid()
ProcessSpec.all_dependencies()
ProcessSpec.as_dict()
ProcessSpec.build()
ProcessSpec.dump()
ProcessSpec.from_dict()
ProcessSpec.get_collection_type()
ProcessSpec.get_type()
ProcessSpec.to_link()
ProcessSpec.audit_info
ProcessSpec.collection_dict
ProcessSpec.conditions
ProcessSpec.dataset
ProcessSpec.ingredients
ProcessSpec.name
ProcessSpec.notes
ProcessSpec.output_material
ProcessSpec.parameters
ProcessSpec.skip
ProcessSpec.template
ProcessSpec.typ
ProcessSpec.uid
ProcessSpecCollection
ProcessSpecCollection.async_update()
ProcessSpecCollection.build()
ProcessSpecCollection.delete()
ProcessSpecCollection.get()
ProcessSpecCollection.get_type()
ProcessSpecCollection.list()
ProcessSpecCollection.list_by_attribute_bounds()
ProcessSpecCollection.list_by_name()
ProcessSpecCollection.list_by_tag()
ProcessSpecCollection.list_by_template()
ProcessSpecCollection.poll_async_update_job()
ProcessSpecCollection.register()
ProcessSpecCollection.register_all()
ProcessSpecCollection.update()
ProcessSpecCollection.validate_templates()
- citrine.resources.process_template module
ProcessTemplate
ProcessTemplate.access_control_dict()
ProcessTemplate.add_uid()
ProcessTemplate.all_dependencies()
ProcessTemplate.as_dict()
ProcessTemplate.build()
ProcessTemplate.dump()
ProcessTemplate.from_dict()
ProcessTemplate.get_collection_type()
ProcessTemplate.get_type()
ProcessTemplate.to_link()
ProcessTemplate.validate_condition()
ProcessTemplate.validate_parameter()
ProcessTemplate.allowed_labels
ProcessTemplate.allowed_names
ProcessTemplate.audit_info
ProcessTemplate.collection_dict
ProcessTemplate.conditions
ProcessTemplate.dataset
ProcessTemplate.description
ProcessTemplate.name
ProcessTemplate.parameters
ProcessTemplate.skip
ProcessTemplate.typ
ProcessTemplate.uid
ProcessTemplateCollection
ProcessTemplateCollection.async_update()
ProcessTemplateCollection.build()
ProcessTemplateCollection.delete()
ProcessTemplateCollection.get()
ProcessTemplateCollection.get_type()
ProcessTemplateCollection.list()
ProcessTemplateCollection.list_by_name()
ProcessTemplateCollection.list_by_tag()
ProcessTemplateCollection.poll_async_update_job()
ProcessTemplateCollection.register()
ProcessTemplateCollection.register_all()
ProcessTemplateCollection.update()
- citrine.resources.project module
Project
Project.access_control_dict()
Project.build()
Project.dump()
Project.gemd_batch_delete()
Project.get_team_id_from_project_id()
Project.list_members()
Project.owned_dataset_ids()
Project.publish()
Project.pull_in_resource()
Project.un_publish()
Project.branches
Project.condition_templates
Project.created_at
Project.datasets
Project.description
Project.descriptors
Project.design_spaces
Project.design_workflows
Project.gemd
Project.generative_design_executions
Project.ingredient_runs
Project.ingredient_specs
Project.material_runs
Project.material_specs
Project.material_templates
Project.measurement_runs
Project.measurement_specs
Project.measurement_templates
Project.name
Project.parameter_templates
Project.predictor_evaluation_executions
Project.predictor_evaluation_workflows
Project.predictors
Project.process_runs
Project.process_specs
Project.process_templates
Project.property_templates
Project.status
Project.table_configs
Project.tables
Project.team_id
Project.uid
ProjectCollection
- citrine.resources.project_member module
- citrine.resources.project_roles module
- citrine.resources.property_template module
PropertyTemplate
PropertyTemplate.access_control_dict()
PropertyTemplate.add_uid()
PropertyTemplate.all_dependencies()
PropertyTemplate.as_dict()
PropertyTemplate.build()
PropertyTemplate.dump()
PropertyTemplate.from_dict()
PropertyTemplate.get_collection_type()
PropertyTemplate.get_type()
PropertyTemplate.to_link()
PropertyTemplate.audit_info
PropertyTemplate.collection_dict
PropertyTemplate.dataset
PropertyTemplate.description
PropertyTemplate.name
PropertyTemplate.skip
PropertyTemplate.typ
PropertyTemplate.uid
PropertyTemplateCollection
PropertyTemplateCollection.async_update()
PropertyTemplateCollection.build()
PropertyTemplateCollection.delete()
PropertyTemplateCollection.get()
PropertyTemplateCollection.get_type()
PropertyTemplateCollection.list()
PropertyTemplateCollection.list_by_name()
PropertyTemplateCollection.list_by_tag()
PropertyTemplateCollection.poll_async_update_job()
PropertyTemplateCollection.register()
PropertyTemplateCollection.register_all()
PropertyTemplateCollection.update()
- citrine.resources.report module
- citrine.resources.response module
- citrine.resources.sample_design_space_execution module
SampleDesignSpaceExecutionCollection
SampleDesignSpaceExecutionCollection.build()
SampleDesignSpaceExecutionCollection.delete()
SampleDesignSpaceExecutionCollection.get()
SampleDesignSpaceExecutionCollection.list()
SampleDesignSpaceExecutionCollection.register()
SampleDesignSpaceExecutionCollection.trigger()
SampleDesignSpaceExecutionCollection.update()
- citrine.resources.status_detail module
- citrine.resources.table_config module
TableBuildAlgorithm
TableConfig
TableConfig.access_control_dict()
TableConfig.add_all_ingredients()
TableConfig.add_all_ingredients_in_output()
TableConfig.add_columns()
TableConfig.build()
TableConfig.dump()
TableConfig.columns
TableConfig.config_uid
TableConfig.datasets
TableConfig.description
TableConfig.gemd_query
TableConfig.generation_algorithm
TableConfig.name
TableConfig.rows
TableConfig.uid
TableConfig.variables
TableConfig.version_number
TableConfig.version_uid
TableConfigCollection
TableConfigCollection.build()
TableConfigCollection.default_for_material()
TableConfigCollection.delete()
TableConfigCollection.from_query()
TableConfigCollection.get()
TableConfigCollection.get_for_table()
TableConfigCollection.list()
TableConfigCollection.preview()
TableConfigCollection.register()
TableConfigCollection.update()
TableConfigInitiator
TableFromGemdQueryAlgorithm
- citrine.resources.team module
Team
Team.access_control_dict()
Team.add_user()
Team.build()
Team.dump()
Team.gemd_batch_delete()
Team.get_member()
Team.list_members()
Team.me()
Team.owned_dataset_ids()
Team.remove_user()
Team.share()
Team.un_share()
Team.update_user_action()
Team.analyses
Team.condition_templates
Team.created_at
Team.dataset_ids
Team.datasets
Team.description
Team.gemd
Team.ingredient_runs
Team.ingredient_specs
Team.material_runs
Team.material_specs
Team.material_templates
Team.measurement_runs
Team.measurement_specs
Team.measurement_templates
Team.module_ids
Team.name
Team.parameter_templates
Team.process_runs
Team.process_specs
Team.process_templates
Team.projects
Team.property_templates
Team.table_definition_ids
Team.table_ids
Team.uid
TeamCollection
TeamMember
TeamResourceIDs
- citrine.resources.templates module
Template
TemplateCollection
TemplateCollection.async_update()
TemplateCollection.build()
TemplateCollection.delete()
TemplateCollection.get()
TemplateCollection.get_type()
TemplateCollection.list()
TemplateCollection.list_by_name()
TemplateCollection.list_by_tag()
TemplateCollection.poll_async_update_job()
TemplateCollection.register()
TemplateCollection.register_all()
TemplateCollection.update()
- citrine.resources.user module