gdsfactoryhub ¶

DoData SDK.

Modules:

Name	Description
`api_client`	API client for DoData SDK.
`client`	DoDataClient module for creating and managing DoData API and Query clients.
`columns`	PostgREST columns definitions.
`errors`	Module for defining custom exceptions for the DoData library.
`helpers`	Dodata helpers module.
`query_client`	Query Client for DoData.
`schemas`	Defines the data models for the application, including device data, wafers, dies, cells, and projects.
`utils`	Utilities for interacting with the DoData API.

Classes:

Name	Description
`Analysis`	Analysis model.
`DeviceData`	Device data model.
`DeviceDataType`	Device data types.
`DoDataError`	Base class for all DoData exceptions.
`ExtractionRule`	Defines a rule for filtering cells.
`FunctionRunResult`	Result of a function run.
`FunctionRunStatus`	Status of a function run.
`FunctionTargetModel`	Target models for functions.
`GDSFactoryHubClient`	A client for interacting with DoData API and Query services.
`MatplotlibPlotSpec`	Matplotlib plot specification for device data visualization.
`Project`	Project model.

Functions:

Name	Description
`create_client`	Create a DoDataClient instance with the provided API and Query URLs and key.
`create_client_from_env`	Create a DoDataClient instance using URLs from environment variables.
`df_from_bytes`	Convert bytes to a DataFrame.
`get_function_path`	Get the file path of a function.
`get_module_path`	Get the file path of a module.
`parallel`	Run a function in parallel over a list of items.
`suppress_api_error`	Context manager to suppress DoDataError and print the error message.

Analysis ¶

Bases: BaseModel

Analysis model.

DeviceData ¶

Bases: BaseModel

Device data model.

Attributes:

Name	Type	Description
`cell`	`Cell`	Return the cell associated with this device data.
`project`	`Project`	Return the project associated with this device data.
`wafer`	`Wafer \| None`	Return the wafer associated with this device data.

cell `property` ¶

cell: Cell

Return the cell associated with this device data.

project `property` ¶

project: Project

Return the project associated with this device data.

wafer `property` ¶

wafer: Wafer | None

Return the wafer associated with this device data.

DeviceDataType ¶

Bases: StrEnum

Device data types.

DoDataError ¶

DoDataError(message: str)

Bases: Exception

Base class for all DoData exceptions.

ExtractionRule ¶

Bases: BaseModel

Defines a rule for filtering cells.

FunctionRunResult ¶

Bases: BaseModel

Result of a function run.

Methods:

Name	Description
`is_successful`	Check if the function run was successful.
`output`	Return the output of the function run.
`summary_plot`	Display the summary plot of the function run.

is_successful ¶

is_successful() -> bool

Check if the function run was successful.

output ¶

output() -> str | None

Return the output of the function run.

summary_plot ¶

summary_plot() -> None

Display the summary plot of the function run.

FunctionRunStatus ¶

Bases: StrEnum

Status of a function run.

FunctionTargetModel ¶

Bases: StrEnum

Target models for functions.

GDSFactoryHubClient ¶

GDSFactoryHubClient(api_url: str, query_url: str, key: str, *, project_id: str = '')

A client for interacting with DoData API and Query services.

Methods:

Name	Description
`api`	Return the ApiClient instance.
`query`	Return the QueryClient instance.
`utils`	Return the Utils instance.

api ¶

api() -> ApiClient

Return the ApiClient instance.

query ¶

query() -> QueryClient

Return the QueryClient instance.

utils ¶

utils() -> Utils

Return the Utils instance.

MatplotlibPlotSpec ¶

Bases: BaseModel

Matplotlib plot specification for device data visualization.

Project ¶

Bases: BaseModel

Project model.

create_client ¶

create_client(
    api_url: str, query_url: str, key: str, *, project_id: str = ""
) -> GDSFactoryHubClient

Create a DoDataClient instance with the provided API and Query URLs and key.

create_client_from_env ¶

create_client_from_env(*, project_id: str = '') -> GDSFactoryHubClient

Create a DoDataClient instance using URLs from environment variables.

Environment variables

GDSFACTORY_HUB_API_URL: URL for the API client GDSFACTORY_HUB_QUERY_URL: URL for the query client GDSFACTORY_HUB_KEY: Key for both the api client and query client

df_from_bytes ¶

df_from_bytes(bts: bytes) -> DataFrame

Convert bytes to a DataFrame.

get_function_path ¶

get_function_path(func: Callable) -> Path

Get the file path of a function.

get_module_path ¶

get_module_path(module: ModuleType) -> Path

Get the file path of a module.

parallel ¶

parallel(
    f: Callable[[A], B], *, items: list[A], n_workers: int | None = None
) -> list[B]

Run a function in parallel over a list of items.

suppress_api_error ¶

suppress_api_error() -> Generator[None, None, None]

Context manager to suppress DoDataError and print the error message.

Wafer Analysis

Full Reference

gdsfactoryhub ¶

Analysis ¶

DeviceData ¶

cell `property` ¶

project `property` ¶

wafer `property` ¶

DeviceDataType ¶

DoDataError ¶

ExtractionRule ¶

FunctionRunResult ¶

is_successful ¶

output ¶

summary_plot ¶

FunctionRunStatus ¶

FunctionTargetModel ¶

GDSFactoryHubClient ¶

api ¶

query ¶

utils ¶

MatplotlibPlotSpec ¶

Project ¶

create_client ¶

create_client_from_env ¶

df_from_bytes ¶

get_function_path ¶

get_module_path ¶

parallel ¶

suppress_api_error ¶

On This Page

Full Reference

gdsfactoryhub ¶

Analysis ¶

DeviceData ¶

cell property ¶

project property ¶

wafer property ¶

DeviceDataType ¶

DoDataError ¶

ExtractionRule ¶

FunctionRunResult ¶

is_successful ¶

output ¶

summary_plot ¶

FunctionRunStatus ¶

FunctionTargetModel ¶

GDSFactoryHubClient ¶

api ¶

query ¶

utils ¶

MatplotlibPlotSpec ¶

Project ¶

create_client ¶

create_client_from_env ¶

df_from_bytes ¶

get_function_path ¶

get_module_path ¶

parallel ¶

suppress_api_error ¶

On This Page

cell `property` ¶

project `property` ¶

wafer `property` ¶