SQuADDS 0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
SQuADDS-0.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023 Sadman Ahmed Shanto
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
SQuADDS-0.0/PKG-INFO ADDED
@@ -0,0 +1,102 @@
1
+ Metadata-Version: 2.1
2
+ Name: SQuADDS
3
+ Version: 0.0
4
+ Summary: Our project introduces an open-source database of programmatically generated and experimentally validated superconducting quantum device designs, accessible through a user-friendly interface, significantly lowering the entry barrier for research in this field.
5
+ Home-page: https://github.com/LFL-Lab/SQuADDS
6
+ Author: Sadman Ahmed Shanto
7
+ Author-email: shanto@usc.edu
8
+ Classifier: Programming Language :: Python :: 3
9
+ Classifier: License :: OSI Approved :: MIT License
10
+ Classifier: Operating System :: OS Independent
11
+ Description-Content-Type: text/markdown
12
+ License-File: LICENSE
13
+
14
+ # ![Under Development](https://img.shields.io/badge/Status-Under%20Development-yellow) SQuADDS:
15
+
16
+ > :warning: **This project is currently under active development. Features and documentation may be incomplete.**
17
+
18
+ The SQuADDS (Superconducting Qubit And Device Design and Simulation) Database Project is an open-source resource aimed at advancing research in superconducting quantum device designs. It provides a robust workflow for generating and simulating superconducting quantum device designs, facilitating the accurate prediction of Hamiltonian parameters across a wide range of design geometries.
19
+
20
+ Paper Link: [SQuADDS: A Database for Superconducting Quantum Device Design and Simulation](https://)
21
+ Website Link: [SQuADDS](https://sadmanahmedshanto.com/SQuADDS/)
22
+
23
+ ## Table of Contents
24
+
25
+ - [Setup](#setup)
26
+ - [Features](#features)
27
+ - [Usage](#usage)
28
+ - [Contributing](#contributing)
29
+ - [License](#license)
30
+ - [Contact](#contact)
31
+
32
+ ---
33
+
34
+ ## Setup
35
+
36
+ Install using pip:
37
+
38
+ ```bash
39
+ pip install SQuADDS
40
+ ```
41
+
42
+ Install from source:
43
+
44
+ ### Prerequisites
45
+ - [Python 3.7+](https://www.python.org/downloads/)
46
+ - [pip](https://pip.pypa.io/en/stable/installing/)
47
+ - [Git](https://git-scm.com/downloads)
48
+
49
+ ### Installation
50
+
51
+ 1. Clone the repository.
52
+ ```bash
53
+ git clone
54
+ ```
55
+ 2. Install the required packages.
56
+ ```bash
57
+ pip install -r requirements.txt
58
+ ```
59
+ 3. Run the setup script.
60
+ ```bash
61
+ python setup.py install
62
+ ```
63
+
64
+ ## Features
65
+
66
+ - **Data-Driven Interpolation**: Utilizes a comprehensive database for interpolating Hamiltonian parameters, ensuring high precision in predictions.
67
+ - **User-Specified Target Parameters**: Allows users to define target parameters such as qubit anharmonicity, coupling strength, resonator linewidth, and frequency.
68
+ - **Experimental Validation**: Includes experimentally measured data for enhancing the reliability and accuracy of the simulations.
69
+ - **Open-Source Collaboration**: Encourages contributions from the community, expanding the database and refining the simulation models.
70
+
71
+ ## Tutorials
72
+ - [Tutorial 1: Getting Started with SQuADDS](https://sadmanahmedshanto.com/SQuADDS/tutorials/Tutorial-1_getting_started_with_SQuADDS.html)
73
+ - [Tutorial 2: Contributing to the SQuADDS Database](https://sadmanahmedshanto.com/SQuADDS/tutorials/Tutorial-2_Contributing_to_SQuADDS.html)
74
+
75
+
76
+ ## Contributing
77
+
78
+ Contributions are welcome! If you have improvements or additions to the database, please follow these steps:
79
+
80
+ - Fork the repository.
81
+ - Create a new branch for your feature.
82
+ - Add your contributions.
83
+ - Submit a pull request with a clear description of your changes.
84
+
85
+ ## License
86
+
87
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
88
+
89
+
90
+ ## Contact
91
+ For inquiries or support, please contact [Sadman Ahmed Shanto](mailto:shanto@usc.edu).
92
+
93
+ ---
94
+
95
+ ## Next Release:
96
+
97
+ - [ ] More tutorials/examples/explanations on the website
98
+ - [ ] Contribution via HuggingFace Hub API
99
+ - [ ] More data points to existing configurations
100
+ - [ ] Contribute data points to new configurations
101
+
102
+ ---
SQuADDS-0.0/README.md ADDED
@@ -0,0 +1,89 @@
1
+ # ![Under Development](https://img.shields.io/badge/Status-Under%20Development-yellow) SQuADDS:
2
+
3
+ > :warning: **This project is currently under active development. Features and documentation may be incomplete.**
4
+
5
+ The SQuADDS (Superconducting Qubit And Device Design and Simulation) Database Project is an open-source resource aimed at advancing research in superconducting quantum device designs. It provides a robust workflow for generating and simulating superconducting quantum device designs, facilitating the accurate prediction of Hamiltonian parameters across a wide range of design geometries.
6
+
7
+ Paper Link: [SQuADDS: A Database for Superconducting Quantum Device Design and Simulation](https://)
8
+ Website Link: [SQuADDS](https://sadmanahmedshanto.com/SQuADDS/)
9
+
10
+ ## Table of Contents
11
+
12
+ - [Setup](#setup)
13
+ - [Features](#features)
14
+ - [Usage](#usage)
15
+ - [Contributing](#contributing)
16
+ - [License](#license)
17
+ - [Contact](#contact)
18
+
19
+ ---
20
+
21
+ ## Setup
22
+
23
+ Install using pip:
24
+
25
+ ```bash
26
+ pip install SQuADDS
27
+ ```
28
+
29
+ Install from source:
30
+
31
+ ### Prerequisites
32
+ - [Python 3.7+](https://www.python.org/downloads/)
33
+ - [pip](https://pip.pypa.io/en/stable/installing/)
34
+ - [Git](https://git-scm.com/downloads)
35
+
36
+ ### Installation
37
+
38
+ 1. Clone the repository.
39
+ ```bash
40
+ git clone
41
+ ```
42
+ 2. Install the required packages.
43
+ ```bash
44
+ pip install -r requirements.txt
45
+ ```
46
+ 3. Run the setup script.
47
+ ```bash
48
+ python setup.py install
49
+ ```
50
+
51
+ ## Features
52
+
53
+ - **Data-Driven Interpolation**: Utilizes a comprehensive database for interpolating Hamiltonian parameters, ensuring high precision in predictions.
54
+ - **User-Specified Target Parameters**: Allows users to define target parameters such as qubit anharmonicity, coupling strength, resonator linewidth, and frequency.
55
+ - **Experimental Validation**: Includes experimentally measured data for enhancing the reliability and accuracy of the simulations.
56
+ - **Open-Source Collaboration**: Encourages contributions from the community, expanding the database and refining the simulation models.
57
+
58
+ ## Tutorials
59
+ - [Tutorial 1: Getting Started with SQuADDS](https://sadmanahmedshanto.com/SQuADDS/tutorials/Tutorial-1_getting_started_with_SQuADDS.html)
60
+ - [Tutorial 2: Contributing to the SQuADDS Database](https://sadmanahmedshanto.com/SQuADDS/tutorials/Tutorial-2_Contributing_to_SQuADDS.html)
61
+
62
+
63
+ ## Contributing
64
+
65
+ Contributions are welcome! If you have improvements or additions to the database, please follow these steps:
66
+
67
+ - Fork the repository.
68
+ - Create a new branch for your feature.
69
+ - Add your contributions.
70
+ - Submit a pull request with a clear description of your changes.
71
+
72
+ ## License
73
+
74
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
75
+
76
+
77
+ ## Contact
78
+ For inquiries or support, please contact [Sadman Ahmed Shanto](mailto:shanto@usc.edu).
79
+
80
+ ---
81
+
82
+ ## Next Release:
83
+
84
+ - [ ] More tutorials/examples/explanations on the website
85
+ - [ ] Contribution via HuggingFace Hub API
86
+ - [ ] More data points to existing configurations
87
+ - [ ] Contribute data points to new configurations
88
+
89
+ ---
@@ -0,0 +1,102 @@
1
+ Metadata-Version: 2.1
2
+ Name: SQuADDS
3
+ Version: 0.0
4
+ Summary: Our project introduces an open-source database of programmatically generated and experimentally validated superconducting quantum device designs, accessible through a user-friendly interface, significantly lowering the entry barrier for research in this field.
5
+ Home-page: https://github.com/LFL-Lab/SQuADDS
6
+ Author: Sadman Ahmed Shanto
7
+ Author-email: shanto@usc.edu
8
+ Classifier: Programming Language :: Python :: 3
9
+ Classifier: License :: OSI Approved :: MIT License
10
+ Classifier: Operating System :: OS Independent
11
+ Description-Content-Type: text/markdown
12
+ License-File: LICENSE
13
+
14
+ # ![Under Development](https://img.shields.io/badge/Status-Under%20Development-yellow) SQuADDS:
15
+
16
+ > :warning: **This project is currently under active development. Features and documentation may be incomplete.**
17
+
18
+ The SQuADDS (Superconducting Qubit And Device Design and Simulation) Database Project is an open-source resource aimed at advancing research in superconducting quantum device designs. It provides a robust workflow for generating and simulating superconducting quantum device designs, facilitating the accurate prediction of Hamiltonian parameters across a wide range of design geometries.
19
+
20
+ Paper Link: [SQuADDS: A Database for Superconducting Quantum Device Design and Simulation](https://)
21
+ Website Link: [SQuADDS](https://sadmanahmedshanto.com/SQuADDS/)
22
+
23
+ ## Table of Contents
24
+
25
+ - [Setup](#setup)
26
+ - [Features](#features)
27
+ - [Usage](#usage)
28
+ - [Contributing](#contributing)
29
+ - [License](#license)
30
+ - [Contact](#contact)
31
+
32
+ ---
33
+
34
+ ## Setup
35
+
36
+ Install using pip:
37
+
38
+ ```bash
39
+ pip install SQuADDS
40
+ ```
41
+
42
+ Install from source:
43
+
44
+ ### Prerequisites
45
+ - [Python 3.7+](https://www.python.org/downloads/)
46
+ - [pip](https://pip.pypa.io/en/stable/installing/)
47
+ - [Git](https://git-scm.com/downloads)
48
+
49
+ ### Installation
50
+
51
+ 1. Clone the repository.
52
+ ```bash
53
+ git clone
54
+ ```
55
+ 2. Install the required packages.
56
+ ```bash
57
+ pip install -r requirements.txt
58
+ ```
59
+ 3. Run the setup script.
60
+ ```bash
61
+ python setup.py install
62
+ ```
63
+
64
+ ## Features
65
+
66
+ - **Data-Driven Interpolation**: Utilizes a comprehensive database for interpolating Hamiltonian parameters, ensuring high precision in predictions.
67
+ - **User-Specified Target Parameters**: Allows users to define target parameters such as qubit anharmonicity, coupling strength, resonator linewidth, and frequency.
68
+ - **Experimental Validation**: Includes experimentally measured data for enhancing the reliability and accuracy of the simulations.
69
+ - **Open-Source Collaboration**: Encourages contributions from the community, expanding the database and refining the simulation models.
70
+
71
+ ## Tutorials
72
+ - [Tutorial 1: Getting Started with SQuADDS](https://sadmanahmedshanto.com/SQuADDS/tutorials/Tutorial-1_getting_started_with_SQuADDS.html)
73
+ - [Tutorial 2: Contributing to the SQuADDS Database](https://sadmanahmedshanto.com/SQuADDS/tutorials/Tutorial-2_Contributing_to_SQuADDS.html)
74
+
75
+
76
+ ## Contributing
77
+
78
+ Contributions are welcome! If you have improvements or additions to the database, please follow these steps:
79
+
80
+ - Fork the repository.
81
+ - Create a new branch for your feature.
82
+ - Add your contributions.
83
+ - Submit a pull request with a clear description of your changes.
84
+
85
+ ## License
86
+
87
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
88
+
89
+
90
+ ## Contact
91
+ For inquiries or support, please contact [Sadman Ahmed Shanto](mailto:shanto@usc.edu).
92
+
93
+ ---
94
+
95
+ ## Next Release:
96
+
97
+ - [ ] More tutorials/examples/explanations on the website
98
+ - [ ] Contribution via HuggingFace Hub API
99
+ - [ ] More data points to existing configurations
100
+ - [ ] Contribute data points to new configurations
101
+
102
+ ---
@@ -0,0 +1,23 @@
1
+ LICENSE
2
+ README.md
3
+ setup.py
4
+ SQuADDS.egg-info/PKG-INFO
5
+ SQuADDS.egg-info/SOURCES.txt
6
+ SQuADDS.egg-info/dependency_links.txt
7
+ SQuADDS.egg-info/requires.txt
8
+ SQuADDS.egg-info/top_level.txt
9
+ squadds/__init__.py
10
+ squadds/core/__init__.py
11
+ squadds/core/analysis.py
12
+ squadds/core/db.py
13
+ squadds/core/design_patterns.py
14
+ squadds/core/globals.py
15
+ squadds/core/metrics.py
16
+ squadds/core/selector.py
17
+ squadds/core/utils.py
18
+ squadds/database/__init__.py
19
+ squadds/database/checker.py
20
+ squadds/database/config.py
21
+ squadds/database/contributor.py
22
+ squadds/database/reader.py
23
+ squadds/database/utils.py
@@ -0,0 +1,10 @@
1
+ datasets==2.15.0
2
+ huggingface_hub==0.19.4
3
+ numpy==1.26.2
4
+ pandas==1.5.3
5
+ pandasai==1.5.11
6
+ pymongo==4.5.0
7
+ python-dotenv==1.0.0
8
+ scqubits==3.3.0
9
+ setuptools==65.5.1
10
+ tabulate==0.9.0
@@ -0,0 +1 @@
1
+ squadds
SQuADDS-0.0/setup.cfg ADDED
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
SQuADDS-0.0/setup.py ADDED
@@ -0,0 +1,23 @@
1
+ from setuptools import setup, find_packages
2
+
3
+ # Read requirements from the requirements.txt file
4
+ with open('requirements.txt') as f:
5
+ required = f.read().splitlines()
6
+
7
+ setup(
8
+ name='SQuADDS',
9
+ version='0.0',
10
+ packages=find_packages(),
11
+ description='Our project introduces an open-source database of programmatically generated and experimentally validated superconducting quantum device designs, accessible through a user-friendly interface, significantly lowering the entry barrier for research in this field.',
12
+ long_description=open('README.md').read(),
13
+ long_description_content_type='text/markdown',
14
+ author='Sadman Ahmed Shanto',
15
+ author_email='shanto@usc.edu',
16
+ url='https://github.com/LFL-Lab/SQuADDS',
17
+ install_requires=required,
18
+ classifiers=[
19
+ 'Programming Language :: Python :: 3',
20
+ 'License :: OSI Approved :: MIT License',
21
+ 'Operating System :: OS Independent',
22
+ ],
23
+ )
@@ -0,0 +1,12 @@
1
+ import os
2
+
3
+ __version__ = '0.1.0'
4
+ __license__ = "MIT License"
5
+ __copyright__ = 'Sadman Ahmed Shanto, Eli Levenson-Falk 2023'
6
+ __author__ = 'Sadman Ahmed Shanto, Eli Levenson-Falk'
7
+ __status__ = "Development"
8
+ __repo_path__ = os.path.dirname(os.path.abspath(__file__))
9
+ __library_path__ = os.path.join(__repo_path__, "library")
10
+
11
+
12
+ from squadds.core.db import SQuADDS_DB
@@ -0,0 +1,3 @@
1
+ from .utils import *
2
+ from .design_patterns import *
3
+ from .analysis import *