| Name | qnngds JSON |
| Version |
3.4.1
JSON |
| download |
| home_page | None |
| Summary | The QNN library for creating gds files |
| upload_time | 2024-10-28 15:09:09 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| 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. |
| keywords |
phidl
nanowire_electronics
nanofabrication
gds
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
gdspy
phidl
pre-commit
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# QNNGDS
## Description
QNNGDS is a toolbox built on top of phidl for device design in the QNN group.
The package is built so that any person wanting to create a new design can do it
easily and quickly. It offers various devices, circuits, and test structures
used and designed in the [QNN group](https://qnn-rle.mit.edu/). The package
hierarchy is thought as follows:
- **Design**: contains classes from which a complete design can be built. The class
inputs are the basic parameters of the chip. Its methods are pre-built cells
and tools for distributing and managing the cells over the chip.
- **Cells**: is a library of cells pre-built, that are called by the Design's
classes. Each cell contains a text, border marks and an experiment
(circuits, devices, or tests) connected to pads for external connection.
- **Circuits**: is a library of circuits made of devices.
- **Devices**: is a library of basic devices like nTron, hTron, nanowires, resistors etc...
- **Tests**: is a library of test structures that help through the fabrication process and
characterization.
- **Geometries**: contains useful shapes/geometries that are not available in
Phidl or has been adapted from it for special use cases.
- **Utilities**: contains useful tools for building cells and circuits.
Below is an example of the modules used to build a design.
## 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)
Raw data
{
"_id": null,
"home_page": null,
"name": "qnngds",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "\"A. Jacquillat\" <audrey01@mit.edu>",
"keywords": "phidl, nanowire_electronics, nanofabrication, gds",
"author": null,
"author_email": "\"A. Jacquillat\" <audrey01@mit.edu>, \"A. Jacquillat\" <audrey.jacquillat@gmail.com>, \"R. Foster\" <reedf@mit.edu>, \"E. Batson\" <emmabat@mit.edu>",
"download_url": "https://files.pythonhosted.org/packages/62/89/636488480521314ba9253b962269e3399996ca06b6a7416434b98c0ab262/qnngds-3.4.1.tar.gz",
"platform": null,
"description": "# QNNGDS\n\n## Description\nQNNGDS is a toolbox built on top of phidl for device design in the QNN group.\n\nThe package is built so that any person wanting to create a new design can do it\neasily and quickly. It offers various devices, circuits, and test structures\nused and designed in the [QNN group](https://qnn-rle.mit.edu/). The package\nhierarchy is thought as follows:\n\n\n\n- **Design**: contains classes from which a complete design can be built. The class\n inputs are the basic parameters of the chip. Its methods are pre-built cells\n and tools for distributing and managing the cells over the chip.\n\n - **Cells**: is a library of cells pre-built, that are called by the Design's\n classes. Each cell contains a text, border marks and an experiment\n (circuits, devices, or tests) connected to pads for external connection.\n\n - **Circuits**: is a library of circuits made of devices.\n\n - **Devices**: is a library of basic devices like nTron, hTron, nanowires, resistors etc...\n\n - **Tests**: is a library of test structures that help through the fabrication process and\n characterization.\n\n - **Geometries**: contains useful shapes/geometries that are not available in\n Phidl or has been adapted from it for special use cases.\n\n - **Utilities**: contains useful tools for building cells and circuits.\n\nBelow is an example of the modules used to build a design.\n\n\n\n\n## Getting Started\n### Installing\n- Make sure [gdspy](https://pypi.org/project/gdspy/) is installed\n- Install qnngds package with 'pip install qnngds'\n\n### Dependencies\n- [phidl](https://pypi.org/project/phidl/)\n- [scipy](https://pypi.org/project/scipy/)\n\n## License\nThis project is licensed under the MIT License - see the LICENSE.txt file for details\n\n## [Documentation](https://qnngds.readthedocs.io/en/latest/)\n- [API](https://qnngds.readthedocs.io/en/latest/api.html)\n- [Tutorials](https://qnngds.readthedocs.io/en/latest/tutorials.html)\n\n## How to contribute\n- [Developer's documentation](https://qnngds-dev.readthedocs.io/en/latest)\n",
"bugtrack_url": null,
"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. ",
"summary": "The QNN library for creating gds files",
"version": "3.4.1",
"project_urls": {
"Documentation": "https://qnngds.readthedocs.io/en/latest/",
"Homepage": "https://github.com/qnngroup/qnngds",
"How_to_contribute": "https://qnngds-dev.readthedocs.io/en/latest/",
"Issues": "https://github.com/qnngroup/qnngds/issues"
},
"split_keywords": [
"phidl",
" nanowire_electronics",
" nanofabrication",
" gds"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "580a8109074c7adbf4aabacfb6e75757bc1143aae2a41f6d66fc7fce85bd6e50",
"md5": "a532fb1db293ecd8086053d2cbcd7dd5",
"sha256": "1ce6b2a012abda76edcf448bff25dfcc4c2219b9e836746b4efa27b02d0a5de9"
},
"downloads": -1,
"filename": "qnngds-3.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a532fb1db293ecd8086053d2cbcd7dd5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 37637,
"upload_time": "2024-10-28T15:09:08",
"upload_time_iso_8601": "2024-10-28T15:09:08.711683Z",
"url": "https://files.pythonhosted.org/packages/58/0a/8109074c7adbf4aabacfb6e75757bc1143aae2a41f6d66fc7fce85bd6e50/qnngds-3.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6289636488480521314ba9253b962269e3399996ca06b6a7416434b98c0ab262",
"md5": "894746ea6a3d48e5caf8e1f0e238287a",
"sha256": "aea8fda40347bb08a57f0c368ea035874896ba83f77401ae6167aa6cfd2119e4"
},
"downloads": -1,
"filename": "qnngds-3.4.1.tar.gz",
"has_sig": false,
"md5_digest": "894746ea6a3d48e5caf8e1f0e238287a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 34801,
"upload_time": "2024-10-28T15:09:09",
"upload_time_iso_8601": "2024-10-28T15:09:09.882987Z",
"url": "https://files.pythonhosted.org/packages/62/89/636488480521314ba9253b962269e3399996ca06b6a7416434b98c0ab262/qnngds-3.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-28 15:09:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qnngroup",
"github_project": "qnngds",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "gdspy",
"specs": []
},
{
"name": "phidl",
"specs": []
},
{
"name": "pre-commit",
"specs": []
}
],
"lcname": "qnngds"
}
