48 lines
1.3 KiB
Markdown
48 lines
1.3 KiB
Markdown
<!--
|
|
Description: Project documentation for setup, deployment, and operational guidance.
|
|
Inside functions: N/A - documentation content.
|
|
Developer : Qin Yue @ 2026
|
|
Organization : OptiHK Limited
|
|
-->
|
|
# mxpic_EDA
|
|
The EDA coding for the layout for optihk
|
|
# requirements
|
|
flask
|
|
|
|
## Build-Time Router Stack
|
|
|
|
Login, dashboard, canvas editing, YAML generation, and PDK browsing run without
|
|
importing `mxpic_router` or `mxpic_forge`. Build actions require `mxpic_router`
|
|
and Nazca. When `mxpic_forge.Route` is unavailable, routing falls back to
|
|
Nazca `interconnects.Interconnect`; SVG preview generation also requires
|
|
`gdstk`.
|
|
|
|
## PDK and Technology Roots
|
|
|
|
PDK component assets and `technology.yml` manifests are loaded from the same
|
|
role-scoped PDK roots. Normal users and developers use
|
|
`MXPIC_PDK_PUBLIC_ROOT` or `../opt_pdk_public/foundries`; managers use
|
|
`MXPIC_PDK_ATLAS_ROOT` or `../opt_pdk_atlas/foundries`.
|
|
|
|
## Runtime Database Root
|
|
|
|
Runtime data is not stored inside this repository. Move the existing `database`
|
|
folder beside `mxpic_EDA` and rename it:
|
|
|
|
```text
|
|
mxpic_EDA_database
|
|
```
|
|
|
|
Default runtime data path:
|
|
|
|
```text
|
|
../mxpic_EDA_database
|
|
```
|
|
|
|
The app fails fast if this folder is missing so debugging cannot silently create
|
|
or modify tracked database files. For nonstandard deployments, set:
|
|
|
|
```text
|
|
MXPIC_DATABASE_ROOT=<path-to-mxpic_EDA_database>
|
|
```
|