deploy: 2709d41

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: f1fe2f5a596a323f829de52842541239
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/apidocs/index.rst.txt

@@ -0,0 +1,9 @@
+API Reference
+=============
+
+This section provides detailed documentation for all modules, classes, functions, and other members of the SQuADDS project.
+
+.. toctree::
+   :maxdepth: 2
+
+   ../modules

_sources/explanations/index.rst.txt

@@ -0,0 +1,10 @@
+Explanations
+============
+
+List of Topics
+--------------
+
+1. **Topic Name 1** - Brief description of the topic.
+2. **Topic Name 2** - Another brief description.
+
+... and so on for each topic.

_sources/getting_started.rst.txt

@@ -0,0 +1,28 @@
+Getting Started with SQuADDS
+============================
+
+.. image:: https://img.shields.io/badge/-Setup-blue
+   :alt: Setup
+
+Installation
+------------
+
+1. **Install Qiskit-Metal**: 
+   See `here <https://qiskit.org/documentation/metal/installation.html>`_.
+
+2. **Clone Repository**: 
+   Navigate to your chosen directory and clone the repository.
+
+   .. code-block:: bash
+
+      cd <REPO PATH>
+      git clone https://github.com/shanto268/SQuADDS
+
+3. **Install Dependencies**: 
+   Activate your Qiskit Metal conda environment and install dependencies.
+
+   .. code-block:: bash
+
+      conda activate <QISKIT METAL ENV>
+      cd SQuADDS
+      pip install .

_sources/how_to/index.rst.txt

@@ -0,0 +1,9 @@
+How-to Guides
+=============
+
+List of Guides
+--------------
+
+1. **Guide Name 1** - Brief description of what the guide covers.
+2. **Guide Name 2** - Another brief description.
+

_sources/index.rst.txt

@@ -0,0 +1,36 @@
+.. SQuADDS documentation master file, created by
+   sphinx-quickstart on Wed Sep  6 09:35:51 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to SQuADDS's documentation!
+===================================
+
+Overview
+========
+
+SQuADDS: a Superconducting Qubit And Device Design and Simulation database
+---------------------------------------------------------------------------------------------------
+
+This open-source platform offers a rich collection of quantum device designs, primed for personalization. Seamlessly integrated with Qiskit Metal, each design is simulation-ready with advanced electromagnetic solvers. We ensure a dependable simulation process, with many designs backed by real-world testing. Navigate and adapt designs effortlessly through our intuitive interface, paving the way for researchers to innovate new device categories.
+
+
+.. toctree::
+   :hidden:
+
+   Documentation Home <self>
+   Getting Started <getting_started>
+   Tutorials <tutorials/index>
+   How-to Guides <how_to/index>
+   API Reference <apidocs/index>
+   Explanations <explanations/index>
+   Release Notes <release_notes>
+   GitHub <https://github.com/shanto268/SQuADDS>
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

_sources/modules.rst.txt

@@ -0,0 +1,8 @@
+SQuADDS
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   setup
+   squadds

_sources/release_notes.rst.txt

@@ -0,0 +1,10 @@
+Release Notes
+=============
+
+Version 0.0.1 (2023-09-06)
+--------------------
+
+* **MVP Version**
+  - Feature 1 description.
+  - Feature 2 description.
+

_sources/setup.rst.txt

@@ -0,0 +1,7 @@
+setup module
+============
+
+.. automodule:: setup
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/squadds.core.rst.txt

@@ -0,0 +1,29 @@
+squadds.core package
+====================
+
+Submodules
+----------
+
+squadds.core.globals module
+---------------------------
+
+.. automodule:: squadds.core.globals
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+squadds.core.utils module
+-------------------------
+
+.. automodule:: squadds.core.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: squadds.core
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/squadds.database.rst.txt

@@ -0,0 +1,61 @@
+squadds.database package
+========================
+
+Submodules
+----------
+
+squadds.database.checker module
+-------------------------------
+
+.. automodule:: squadds.database.checker
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+squadds.database.config module
+------------------------------
+
+.. automodule:: squadds.database.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+squadds.database.contributor module
+-----------------------------------
+
+.. automodule:: squadds.database.contributor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+squadds.database.db module
+--------------------------
+
+.. automodule:: squadds.database.db
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+squadds.database.reader module
+------------------------------
+
+.. automodule:: squadds.database.reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+squadds.database.utils module
+-----------------------------
+
+.. automodule:: squadds.database.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: squadds.database
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/squadds.rst.txt

@@ -0,0 +1,19 @@
+squadds package
+===============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   squadds.core
+   squadds.database
+
+Module contents
+---------------
+
+.. automodule:: squadds
+   :members:
+   :undoc-members:
+   :show-inheritance:

_sources/tutorials/Tutorial-1_getting_started_with_SQuADDS.ipynb.txt

@@ -0,0 +1,103 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%load_ext autoreload\n",
+    "%autoreload 2"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Obtaining file:///Users/shanto/LFL/SQuADDS/SQuADDS\n",
+      "  Preparing metadata (setup.py) ... \u001b[?25ldone\n",
+      "\u001b[?25hInstalling collected packages: SQuADDS\n",
+      "  Attempting uninstall: SQuADDS\n",
+      "    Found existing installation: SQuADDS 0.1\n",
+      "    Uninstalling SQuADDS-0.1:\n",
+      "      Successfully uninstalled SQuADDS-0.1\n",
+      "  Running setup.py develop for SQuADDS\n",
+      "Successfully installed SQuADDS-0.1\n"
+     ]
+    }
+   ],
+   "source": [
+    "!pip install -e ../."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## HuggingFace\n",
+    "\n",
+    "- [HuggingFace](https://huggingface.co/)\n",
+    "\n",
+    "### Creating an Account\n",
+    "\n",
+    "Follow the instructions here - [HuggingFace: Sign Up](https://huggingface.co/join) - to create an account.\n",
+    "\n",
+    "Once you have created an account, you can get your API key from the [settings page](https://huggingface.co/settings/token).\n",
+    "\n",
+    "Please update the `HUGGINGFACE_API_KEY` variable in the `.env` file with your API key or execute the following code to set the environment variable."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "API key already exists in .env file.\n"
+     ]
+    }
+   ],
+   "source": [
+    "from squadds.core.utils import set_huggingface_api_key\n",
+    "\n",
+    "set_huggingface_api_key()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}