website info updated.

LFL-Lab · Dec 20, 2023 · de9dd61 · de9dd61
1 parent 2709d41
commit de9dd61
Show file tree

Hide file tree

Showing 9 changed files with 285 additions and 88 deletions.
diff --git a/docs/source/developer/index.rst b/docs/source/developer/index.rst
@@ -0,0 +1,36 @@
+.. SQuADDS
+   Copyright (C) 2023, Sadman Ahmed Shanto & Eli Levenson-Falk
+
+.. _developers:
+
+.. note::
+
+   Everyone is welcome to contribute to SQuADDS. Please see review the following section for more information or contact us!
+
+
+Contribution Items
+==================
+
+| **Bug Reports** - Please report any bugs you find in the code or documentation by opening an issue on GitHub.
+| **Feature Requests** - If you have an idea for a new feature, please open an issue on GitHub.
+| **Pull Requests** - We welcome pull requests from the community. If you submit a pull request, please be patient as we review your work. If you have any questions about contributing, please contact us!
+| **Documentation** - We welcome contributions to the documentation. If you find any typos or errors, please open an issue on GitHub.
+| **Implementation of Next Release** - If you would like to help in implementing the next version of SQuADDS, please look at `In the Works<https://github.com/shanto268/SQuADDS?tab=readme-ov-file#next-release>`_
+
+
+Developers
+===========
+
+| `Sadman Ahmed Shanto <https:sadmanahmedshanto.com>`_ (University of Southern California)
+
+
+.. _developers-contributors:
+
+Contributors
+============
+
+
+| **Eli Levenson-Falk** (University of Southern California) - Eternal Guidance Provider 🙏🏽
+| **Andre Kuo** (University of Southern California) - Code contributor
+| **Clark Miyamoto** (New York University) - Code contributor
+| **Madison Howard** (California Institute of Tech) - Bug Hunter
diff --git a/docs/source/explanations/index.rst b/docs/source/explanations/index.rst
diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -7,22 +7,36 @@ Getting Started with SQuADDS
 Installation
 ------------
 
-1. **Install Qiskit-Metal**: 
-   See `here <https://qiskit.org/documentation/metal/installation.html>`_.
+SQuADDS can be installed using pip.
 
-2. **Clone Repository**: 
+.. code-block:: bash
+
+   pip install SQuADDS
+
+Alternatively, you can install SQuADDS from source.
+
+1. **Clone Repository**: 
    Navigate to your chosen directory and clone the repository.
 
    .. code-block:: bash
 
-      cd <REPO PATH>
+      cd <REPO-PATH>
       git clone https://github.com/shanto268/SQuADDS
 
-3. **Install Dependencies**: 
+2. **Install Dependencies**: 
    Activate your Qiskit Metal conda environment and install dependencies.
 
    .. code-block:: bash
 
-      conda activate <QISKIT METAL ENV>
+      conda activate <YOUR-ENV>
       cd SQuADDS
       pip install .
+
+
+FAQ
+---
+
+**Q:** Placeholder?
+
+**A:** Placeholder.
+
diff --git a/docs/source/how_to/index.rst b/docs/source/how_to/index.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -12,25 +12,39 @@ 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.
-
+SQuADDS is an open-source platform aimed at speeding up the design loop in the creation of superconducting quantum hardware. This tool bridges the gap between theoretical design and practical implementation, providing researchers and engineers with a well-characterized starting point for the development of device. SQuADDS enables rapid generation of "best-guess" and validated "pre-simulated" designs, underpinned by a vast repository of experimentally validated design and simulation parameters. SQuADDS aims to lowers the barrier to entry for research groups seeking to make a new class of devices by providing them a well-characterized starting point from which to refine their designs.
 
 .. 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>
+   Release Logs<release_notes>
+   Developer Notes<developer/index>
+   References<references/index>
    GitHub <https://github.com/shanto268/SQuADDS>
 
 
+Citation
+--------
+
+If you use SQuADDS in your research, please support its continued development and maintenance. Use of scqubits in research publications is appropriately acknowledged by citing:
+
+.. code-block:: latex
+
+    @article{SQuADDS,
+        title={SQuADDS: A validated design database and simulation workflow for superconducting qubit design},
+        author={Sadman Ahmed Shanto, Andre Kuo, Clark Miyamoto, Haimeng Zhang, Vivek Maurya, Evangelos Vlachos, Malida Hecht, Chung Wa Shum and Eli Levenson-Falk},
+        journal={arXiv preprint arXiv:},
+        year={2023}
+    }
+
+
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
+* :ref:`search`
diff --git a/docs/source/references/index.rst b/docs/source/references/index.rst
@@ -0,0 +1,9 @@
+Explanations
+============
+
+List of Topics
+--------------
+
+1. **HuggingFace** - Brief description of the topic.
+2. **** - Another brief description.
+
diff --git a/docs/source/release_notes.rst b/docs/source/release_notes.rst
@@ -1,10 +1,21 @@
 Release Notes
 =============
 
-Version 0.0.1 (2023-09-06)
+Version 0.1.0 (2023-12-20)
 --------------------
 
 * **MVP Version**
-  - Feature 1 description.
-  - Feature 2 description.
+
+  - Database hosted on `HuggingFac<https://huggingface.co/datasets/SQuADDS/SQuADDS_DB>`_
+
+  - Pre-simulated data on TransmonCross, Cavity with Claw and Couplers only.
+
+  - Closest pre-simulated design and interpolated design retrieval implemented
+
+  - Interpolation logic based on our `paper<https://arxiv.org/>`_
+
+  - Tutorials on basic usage, contribution, and simulation added
+
+  - pypi package created
+
 
diff --git a/tutorials/Tutorial-1_getting_started_with_SQuADDS.ipynb b/tutorials/Tutorial-1_getting_started_with_SQuADDS.ipynb
@@ -71,6 +71,111 @@
     "set_huggingface_api_key()"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": 15,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from datasets import get_dataset_config_names\n",
+    "from datasets import load_dataset\n",
+    "\n",
+    "configs = get_dataset_config_names(\"SQuADDS/SQuADDS_DB\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 13,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "['qubit-TransmonCross-cap_matrix',\n",
+       " 'cavity_claw-RouterMeander-eigenmode',\n",
+       " 'coupler-NCap-cap_matrix']"
+      ]
+     },
+     "execution_count": 13,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "configs"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 22,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "DatasetDict({\n",
+       "    train: Dataset({\n",
+       "        features: ['notes', 'design', 'contributor', 'sim_results', 'sim_options'],\n",
+       "        num_rows: 1934\n",
+       "    })\n",
+       "})"
+      ]
+     },
+     "execution_count": 22,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "qubit_data = load_dataset(\"SQuADDS/SQuADDS_DB\", configs[0])\n",
+    "qubit_data"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 28,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "notes has keys:\n",
+      "design has keys:\n",
+      "\tdesign_options\n",
+      "\tdesign_tool\n",
+      "contributor has keys:\n",
+      "\tPI\n",
+      "\tdate_created\n",
+      "\tgroup\n",
+      "\tinstitution\n",
+      "\tuploader\n",
+      "sim_results has keys:\n",
+      "\tclaw_to_claw\n",
+      "\tclaw_to_ground\n",
+      "\tcross_to_claw\n",
+      "\tcross_to_cross\n",
+      "\tcross_to_ground\n",
+      "\tground_to_ground\n",
+      "\tunits\n",
+      "sim_options has keys:\n",
+      "\trenderer_options\n",
+      "\tsetup\n",
+      "\tsimulator\n"
+     ]
+    }
+   ],
+   "source": [
+    "# print all the nested keys of qubit_data[\"train\"][0]\n",
+    "for key in qubit_data[\"train\"][0].keys():\n",
+    "    try:\n",
+    "        print(f\"{key} has keys:\")\n",
+    "        for k in qubit_data[\"train\"][0][key].keys():\n",
+    "            print(f\"\\t{k}\")\n",
+    "    except:\n",
+    "        pass"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,