Metadata-Version: 2.1
Name: dodata
Version: 0.1.4
Summary: Software Development Kit - SDK for DoData
Author-email: DoPlayDo <contact@doplaydo.com>
License: The MIT License (MIT)
        
        Copyright (c) 2023 DoPlayDo
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas
Requires-Dist: pillow
Requires-Dist: psycopg2
Requires-Dist: pydantic<3,>=2
Requires-Dist: pydantic-settings
Requires-Dist: requests
Requires-Dist: sqlmodel>=0.0.14
Requires-Dist: tqdm
Requires-Dist: klayout
Provides-Extra: demos
Requires-Dist: gdsfactory[cad]==7.9.2; extra == "demos"
Requires-Dist: jupyterlab; extra == "demos"
Provides-Extra: dev
Requires-Dist: ruff; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: towncrier; extra == "dev"
Requires-Dist: tbump; extra == "dev"
Requires-Dist: pytest_regressions; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Provides-Extra: docs
Requires-Dist: jupyter-book; extra == "docs"
Requires-Dist: jupytext; extra == "docs"
Requires-Dist: matplotlib; extra == "docs"
Provides-Extra: maintainer
Requires-Dist: eralchemy2; extra == "maintainer"
Requires-Dist: types-cachetools; extra == "maintainer"
Requires-Dist: types-requests; extra == "maintainer"
Requires-Dist: types-requests; extra == "maintainer"
Requires-Dist: types-setuptools; extra == "maintainer"
Requires-Dist: types-docutils; extra == "maintainer"
Requires-Dist: types-Pygments; extra == "maintainer"
Requires-Dist: pylsp-mypy; extra == "maintainer"
Requires-Dist: python-lsp-server[all]; extra == "maintainer"
Requires-Dist: python-lsp-ruff; extra == "maintainer"

# DoData python library 0.1.4

## Installation

We only support Python 3.11, and recommend [VSCode](https://code.visualstudio.com/) IDE.

You will need [Anaconda python](https://www.anaconda.com/download/).

After installing python, open Anaconda Prompt as Administrator and install gdstk, psycopg2 and the rest of the dependencies using pip.

![anaconda prompt](https://i.imgur.com/eKk2bbs.png)

```
conda install -c conda-forge psycopg2 -y
conda install -c conda-forge gdstk -y
pip install "dodata[demos]" --upgrade
```

## Setup

Make sure you create an `.env` file in your working directory.

```
dodata_url = 'https://your.dodata.url.here'
dodata_user = 'dodata_user'
dodata_password = 'dodata_web_password'
dodata_db = 'your.dodata.database.url.here'
dodata_db_user = "db_username_here"
dodata_db_password = "db_password_here"
dodata_db_name = "dodata"
data_db_port = 5432
debug = False
```

The `.env` file can be in the same directory run the notebooks from or in a parent directory.

## Run notebooks

For running the notebooks you can use [VSCode](https://gdsfactory.github.io/gdsfactory/notebooks/_3_vscode.html) or JupyterLab.

- For VSCode make sure you use the same conda python interpreter where you installed the packages [see](https://gdsfactory.github.io/gdsfactory/notebooks/_3_vscode.html)
- For JupyterLab you can launch `jupyter-lab` from the same terminal where you run the installation.

Then, make sure you run the notebooks in order:

- `1_generate_layout`: generate GDS layout and CSV device manifest with device coordinates, settings and analysis.
- `2_generate_measurement_data`: generate CSV measurement data.
- `3_upload_measurements`: Upload wafer definitions and measurement data.
- `4_download_data`: Download analysis using conditional.
- `5_delete`: Delete data.
