prefab 1.3.0__py3-none-any.whl → 1.4.1__py3-none-any.whl

{prefab-1.3.0.dist-info → prefab-1.4.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prefab
-Version: 1.3.0
+Version: 1.4.1
 Summary: Artificial nanofabrication of integrated photonic circuits using deep learning
 Project-URL: Homepage, https://prefabphotonics.com
 Project-URL: Repository, https://github.com/PreFab-Photonics/PreFab
@@ -518,6 +518,7 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.9
 Requires-Dist: autograd
 Requires-Dist: gdstk>=0.9.55
+Requires-Dist: ipykernel>=6.31.0
 Requires-Dist: matplotlib
 Requires-Dist: numpy
 Requires-Dist: opencv-python-headless
@@ -527,17 +528,21 @@ Requires-Dist: requests
 Requires-Dist: scikit-image
 Requires-Dist: scipy
 Requires-Dist: toml
-Requires-Dist: tqdm
+Provides-Extra: dev
+Requires-Dist: jupyter; extra == 'dev'
+Requires-Dist: jupyterlab; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs; extra == 'docs'
+Requires-Dist: mkdocs-material; extra == 'docs'
+Requires-Dist: mkdocstrings[python]; extra == 'docs'
 Description-Content-Type: text/markdown
 
 # PreFab
 
-![PreFab logo](https://github.com/PreFab-Photonics/PreFab/blob/main/docs/assets/logo.png?raw=true)
+![PreFab logo](https://github.com/PreFab-Photonics/PreFab/blob/main/docs/assets/prefab-logo.png?raw=true)
 
 PreFab is a _virtual nanofabrication environment_ that leverages **deep learning** and **computer vision** to predict and correct for structural variations in integrated photonic devices during nanofabrication.
 
-> **Try Rosette**: Want a more visual experience? Try [Rosette](https://rosette.dev) - our new layout tool with PreFab models built in, designed for rapid chip design.
-
 ## Prediction
 
 PreFab predicts process-induced structural variations, including corner rounding, loss of small lines and islands, filling of narrow holes and channels, sidewall angle deviations, and stochastic effects. This allows designers to rapidly prototype and evaluate expected performance pre-fabrication.
@@ -550,57 +555,38 @@ PreFab corrects device designs to ensure that the fabricated outcome closely mat
 
 ![Example of PreFab correction](https://github.com/PreFab-Photonics/PreFab/blob/main/docs/assets/promo_c.png?raw=true)
 
-## Models
-
-Each photonic nanofabrication process requires unique models, which are regularly updated with the latest data. The current models include (see the full list in [`docs/models.md`](https://github.com/PreFab-Photonics/PreFab/blob/main/docs/models.md)):
-
-| Foundry | Process | Latest Version    | Latest Dataset   | Model Name  |
-| ------- | ------- | ----------------- | ---------------- | ----------- |
-| ANT     | NanoSOI | ANF1 (May 6 2024) | d10 (Jun 8 2024) | ANT_NanoSOI_ANF1_d10 |
-| ANT     | SiN     | ANF1 (May 6 2024) | d1 (Jan 31 2024) | ANT_SiN_ANF1_d1 |
-
-> _New models are to be regularly added. Usage may change. For additional foundry and process models, feel free to [contact us](mailto:hi@prefabphotonics.com) or raise an issue._
-
 ## Installation
 
-Install PreFab via pip:
+Install PreFab using pip:
 
 ```sh
 pip install prefab
 ```
 
-Or clone the repository and install in development mode:
+For contributors who wish to make changes to the source code:
 
 ```sh
+# Install uv (if not already installed)
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Clone and set up the project
 git clone https://github.com/PreFab-Photonics/PreFab.git
 cd PreFab
-pip install -e .
+uv sync
 ```
 
 ## Getting Started
 
-### Account setup
+Before you can make PreFab requests, you will need to [create an account](https://www.prefabphotonics.com/auth/signup).
 
-Before you can make PreFab requests, you will need to [create an account](https://www.prefabphotonics.com/login).
-
-To link your account, you will need an token. You can do this by running the following command in your terminal. This will open a browser window where you can log in and authenticate your token.
+To link your account, run the following command to authenticate your token:
 
 ```sh
 prefab setup
 ```
 
-### Guides
-
-Visit [`/docs/examples`](https://github.com/PreFab-Photonics/PreFab/tree/main/docs/examples) or our [docs](https://docs.prefabphotonics.com/) to get started with your first predictions.
-
-## Performance and Usage
-
-PreFab models are hosted on a [serverless cloud platform](https://modal.com/). Please keep in mind:
-
-- 🐢 Default CPU inference may be slower.
-- 🥶 The first prediction using optional GPU inference may take longer due to cold start server loading. Subsequent predictions will be faster.
-- 😊 Please be considerate of usage. Start with small tasks and limit usage during the initial stages. Thank you!
+Visit [`/docs/examples`](https://github.com/PreFab-Photonics/PreFab/tree/main/docs/examples) or our [documentation](https://docs.prefabphotonics.com/) to get started with your first predictions.
 
 ## License
 
-This project is licensed under the LGPL-2.1 license. © 2025 PreFab Photonics.
+LGPL-2.1 © PreFab Photonics

prefab-1.4.1.dist-info/RECORD

@@ -0,0 +1,17 @@
+prefab/__init__.py,sha256=f9FN73XE4ufrKEDyy5rGQW2sWWH-8Y4C_7FYwO946Rs,425
+prefab/__main__.py,sha256=M5ulRfgSMdPjeHPoMGQ3P86zFMJDII5I18NGrpFUcsM,3458
+prefab/compare.py,sha256=aX7nr9tznSebYeeztvqIPz57npnJ4-iUeKEedrZdksE,3676
+prefab/device.py,sha256=1O6vTOq4wQRGVYvFWLH0uj1XhhYCfnDnIapDEYnBKHw,47996
+prefab/geometry.py,sha256=-nTaGjdw3KN1SVoyvqdcrE2GJP7OqPF6ivUhrO78rUk,11244
+prefab/predict.py,sha256=066X_SnSIHPqaPMbk0Yn_yX_KBfUc9yxrsmP_k56FU0,19015
+prefab/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+prefab/read.py,sha256=5BmvFemobA72urxs4j2VZRVvanZZGu1mDB1Uh-epyvI,8635
+prefab/shapes.py,sha256=mRGwsPS-A9XsW3jgvUuMCEeNv9BLXsEnJkytlIHUAKE,28802
+prefab/models/__init__.py,sha256=rRrjcOcHPcob98Coksc0tbvYcXbm6SoLEb-Md233Jvo,1391
+prefab/models/base.py,sha256=t4VNMsOztPedj3kN5fZ1-4tk0SRHWrMuqnIVHztsCs4,1514
+prefab/models/evaluation.py,sha256=2_Klui6tY8xPvOSVD8VpZCVAnT1RX15FONqWG-_x-J8,484
+prefab-1.4.1.dist-info/METADATA,sha256=miTQTlHxSgZn57wzltpGpAZ4PgUBW-hVSWmxmSDGqCA,33880
+prefab-1.4.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+prefab-1.4.1.dist-info/entry_points.txt,sha256=h1_A9O9F3NAIoKXD1RPb3Eo-WCSiHhMB_AnagBi6XTQ,48
+prefab-1.4.1.dist-info/licenses/LICENSE,sha256=IMF9i4xIpgCADf0U-V1cuf9HBmqWQd3qtI3FSuyW4zE,26526
+prefab-1.4.1.dist-info/RECORD,,

{prefab-1.3.0.dist-info → prefab-1.4.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any

prefab/models.py

@@ -1,114 +0,0 @@
-"""Models for the PreFab library."""
-
-import json
-from datetime import date
-
-from pydantic import BaseModel
-
-
-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.
-    material : str
-        The material used in the fabrication process.
-    technology : str
-        The technology used in the fabrication process.
-    thickness : int
-        The thickness of the material used, measured in nanometers.
-    has_sidewall : bool
-        Indicates whether the fabrication has angled sidewalls.
-    """
-
-    foundry: str
-    process: str
-    material: str
-    technology: str
-    thickness: int
-    has_sidewall: bool
-
-
-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.dict(), default=str)
-
-
-ANT_NanoSOI = Fab(
-    foundry="ANT",
-    process="NanoSOI",
-    material="SOI",
-    technology="E-Beam",
-    thickness=220,
-    has_sidewall=False,
-)
-
-ANT_SiN = Fab(
-    foundry="ANT",
-    process="SiN",
-    material="SiN",
-    technology="E-Beam",
-    thickness=400,
-    has_sidewall=True,
-)
-
-ANT_NanoSOI_ANF1_d10 = Model(
-    fab=ANT_NanoSOI,
-    version="ANF1",
-    version_date=date(2024, 5, 6),
-    dataset="d10",
-    dataset_date=date(2024, 6, 8),
-    tag="",
-)
-
-ANT_SiN_ANF1_d1 = Model(
-    fab=ANT_SiN,
-    version="ANF1",
-    version_date=date(2024, 5, 6),
-    dataset="d1",
-    dataset_date=date(2024, 1, 31),
-    tag="",
-)
-
-models = dict(
-    ANT_NanoSOI=ANT_NanoSOI_ANF1_d10,
-    ANT_NanoSOI_ANF1_d10=ANT_NanoSOI_ANF1_d10,
-    ANT_SiN=ANT_SiN_ANF1_d1,
-    ANT_SiN_ANF1_d1=ANT_SiN_ANF1_d1,
-)

prefab-1.3.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-prefab/__init__.py,sha256=l9aFRS6H9RKpzotuXz_qmSOvW1Fdvo_tlH2vuUOa8VE,425
-prefab/__main__.py,sha256=1eXWiEoG7eetJMm1qRbK2I5MnzuRgKIoQtBeT-Ps8es,3523
-prefab/compare.py,sha256=0Xgp3tFuP4of-ce9Opc19p8i8lIyXkbVGLuwWBaHSeE,3486
-prefab/device.py,sha256=7SiawFa103ebFqii3CWy_vPO6ixigVliO6A58hoOqkU,55414
-prefab/geometry.py,sha256=fvMSJpDAqxWShhKojPGnXdB4otrBn54kbW8uk1T4Wwk,12104
-prefab/models.py,sha256=waPNGtuISyY0f8cz7dnbD451CKYCt8EpPGt-4lSOPNU,2581
-prefab/predict.py,sha256=jtB18QOlPINJRqUZCwnuMOfPuuwE1s2e353X5g3njd4,18349
-prefab/read.py,sha256=WNqC3xENlndzFwXeCF2E7H3Iq2dO_6rPEPZ58DuloqY,16259
-prefab/shapes.py,sha256=58cyXFNh1kEErq2jEbGd3dWSediU1OSmor_FWwc1V8A,25098
-prefab-1.3.0.dist-info/METADATA,sha256=Xvbt_umsD1mZY1S9phLLABxbR18MCuw4disk81IUslY,35025
-prefab-1.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-prefab-1.3.0.dist-info/entry_points.txt,sha256=h1_A9O9F3NAIoKXD1RPb3Eo-WCSiHhMB_AnagBi6XTQ,48
-prefab-1.3.0.dist-info/licenses/LICENSE,sha256=IMF9i4xIpgCADf0U-V1cuf9HBmqWQd3qtI3FSuyW4zE,26526
-prefab-1.3.0.dist-info/RECORD,,