Metadata-Version: 2.1
Name: qnngds
Version: 1.0.4
Summary: The QNN library for creating gds files
Keywords: phidl nanowire_electronics nanofabrication gds
Author-Email: A. Jacquillat <audrey01@mit.edu>, A. Jacquillat <audrey.jacquillat@gmail.com>, R. Foster <reedf@mit.edu>
Maintainer-Email: A. Jacquillat <audrey01@mit.edu>
License: Copyright (c) 2016 The Python Packaging Authority (PyPA)
        
        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
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Project-URL: Homepage, https://github.com/qnngroup/qnngds
Project-URL: Issues, https://github.com/qnngroup/qnngds/issues
Project-URL: Documentation, https://qnngds.readthedocs.io/en/latest/
Project-URL: How_to_contribute, https://qnngds-dev.readthedocs.io/en/latest/
Requires-Python: >=3.8
Requires-Dist: phidl
Requires-Dist: scipy
Description-Content-Type: text/markdown

# QNNGDS

## Description
QNNGDS is a toolbox built on top of phidl for device design in the QNN group.
It is made for helping in the design of gds files. The package is composed of 5 main modules:
- design (contains pre-built cells, ready to be added to a design)
- utilities (contains useful functions for building a new cell)
- geometries (contains test structures and geometry tools)
- circuits (contains circuits made of devices)
- devices (contains devices like ntron, htron, snspd)

## Getting Started
### Installing
- Make sure [gdspy](https://pypi.org/project/gdspy/) is installed
- Install qnngds package with 'pip install qnngds'

### Dependencies
- [phidl](https://pypi.org/project/phidl/)
- [scipy](https://pypi.org/project/scipy/)

## License
This project is licensed under the MIT License - see the LICENSE.txt file for details

## [Documentation](https://qnngds.readthedocs.io/en/latest/)
- [API](https://qnngds.readthedocs.io/en/latest/api.html)
- [Tutorials](https://qnngds.readthedocs.io/en/latest/tutorials.html)

## How to contribute
- [Developer's documentation](https://qnngds-dev.readthedocs.io/en/latest)
