performance
- class DataExchange
Bases:
CommonBaseModelRepresents the data exchange information in a model.
- model_identifier
The identifier of the model.
- Type:
Optional[str]
- inputs
The list of input variables.
- Type:
Optional[List[Any]]
- outputs
The list of output variables.
- Type:
Optional[List[Any]]
Attributes:
__setattr__ handlers.
- __pydantic_setattr_handlers__: ClassVar[Dict[str, Callable[[BaseModel, str, Any], None]]] = {}
__setattr__ handlers. Memoizing the handlers leads to a dramatic performance improvement in __setattr__
- class ModelDescription
Bases:
CommonBaseModelRepresents the model description.
- specification_version
The specification version.
- Type:
Optional[str]
- model_name
The name of the model.
- Type:
Optional[str]
- guid
The globally unique identifier of the model.
- Type:
Optional[str]
- generation_tool
The tool used to generate the model.
- Type:
Optional[str]
- generation_date_and_time
The date and time when the model was generated.
- Type:
Optional[datetime]
- data_exchange
The data exchange information.
- Type:
Optional[DataExchange]
- license
The license of the model.
- Type:
Optional[str]
- copyright
The copyright information.
- Type:
Optional[str]
- author
The author of the model.
- Type:
Optional[str]
- version
The version of the model.
- Type:
Optional[str]
- description
A description of the model.
- Type:
Optional[str]
Attributes:
__setattr__ handlers.
- __pydantic_setattr_handlers__: ClassVar[Dict[str, Callable[[BaseModel, str, Any], None]]] = {}
__setattr__ handlers. Memoizing the handlers leads to a dramatic performance improvement in __setattr__
- class Discipline
Bases:
CommonBaseModelRepresents a specific discipline within engineering or scientific fields, organizing associated tools, models, and methodologies.
This class facilitates structured access to and management of discipline-specific resources, enhancing the organization and efficiency of engineering and scientific projects.
- name
The name of the discipline, providing a clear identifier for categorization and reference.
- Type:
Optional[str]
- description
A brief description of the discipline and its scope.
- Type:
Optional[str]
- tools
A list of tools and models associated with the discipline, detailing the available resources for conducting analyses or simulations.
- Type:
Optional[List[ModelDescription]]
- metadata
Additional metadata providing further context or details about the discipline and its associated resources.
- Type:
Optional[Metadata]
Methods:
validate_name(value)Validate the 'name' field to ensure it is not empty and contains only alphanumeric characters, underscores, and spaces.
add_tool(tool)Add a new tool or model to the discipline, expanding the set of resources available for analysis and design.
Attributes:
__setattr__ handlers.
- classmethod validate_name(value)
Validate the ‘name’ field to ensure it is not empty and contains only alphanumeric characters, underscores, and spaces.
- Parameters:
value (str) – The name of the discipline being validated.
- Returns:
The validated name.
- Raises:
ValueError – If the name is empty, contains invalid characters, or is not a string.
- Return type:
str
- add_tool(tool)
Add a new tool or model to the discipline, expanding the set of resources available for analysis and design.
- Parameters:
tool (ModelDescription) – The tool or model to be added.
- Return type:
None
- __pydantic_setattr_handlers__: ClassVar[Dict[str, Callable[[BaseModel, str, Any], None]]] = {}
__setattr__ handlers. Memoizing the handlers leads to a dramatic performance improvement in __setattr__
Classes
Represents the data exchange information in a model. |
|
Represents a specific discipline within engineering or scientific fields, organizing associated tools, models, and methodologies. |
|
Represents the model description. |