Skip to content

Models

Fabrication process model definitions and configurations.

This module automatically discovers and loads all model definitions from Python files in the models/ directory.

Fab

Bases: BaseModel

Represents a fabrication process in the PreFab model library.

Attributes:

Name Type Description
foundry str

The name of the foundry where the fabrication process takes place.
process str

The specific process used in the fabrication.
Source code in prefab/models/base.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
class Fab(BaseModel):
    """
    Represents a fabrication process in the PreFab model library.

    Attributes
    ----------
    foundry : str
        The name of the foundry where the fabrication process takes place.
    process : str
        The specific process used in the fabrication.
    """

    foundry: str
    process: str

Model

Bases: BaseModel

Represents a model of a fabrication process including versioning and dataset detail.

Attributes:

Name Type Description
fab Fab

An instance of the Fab class representing the fabrication details.
version str

The version identifier of the model.
version_date date

The release date of this version of the model.
dataset str

The identifier for the dataset used in this model.
dataset_date date

The date when the dataset was last updated or released.
tag str

An optional tag for additional categorization or notes.

Methods:

Name Description
to_json

Serializes the model instance to a JSON formatted string.
Source code in prefab/models/base.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
class Model(BaseModel):
    """
    Represents a model of a fabrication process including versioning and dataset detail.

    Attributes
    ----------
    fab : Fab
        An instance of the Fab class representing the fabrication details.
    version : str
        The version identifier of the model.
    version_date : date
        The release date of this version of the model.
    dataset : str
        The identifier for the dataset used in this model.
    dataset_date : date
        The date when the dataset was last updated or released.
    tag : str
        An optional tag for additional categorization or notes.

    Methods
    -------
    to_json()
        Serializes the model instance to a JSON formatted string.
    """

    fab: Fab
    version: str
    version_date: date
    dataset: str
    dataset_date: date
    tag: str

    def to_json(self):
        return json.dumps(self.model_dump(), default=str)