From 817bb3b4b58c4f5cd1e0e8277e8bcd71613bfd06 Mon Sep 17 00:00:00 2001 From: shanto268 Date: Thu, 21 Dec 2023 12:37:15 +0000 Subject: [PATCH] deploy: 03636c0b406f5298252fe3e4571720b7442f61ee --- .buildinfo | 2 +- _modules/index.html | 243 ------------- _modules/squadds/core/utils.html | 332 ------------------ _sources/getting_started.rst.txt | 4 - ...l-1_getting_started_with_SQuADDS.ipynb.txt | 119 +++++-- ...torial-2_Contributing_to_SQuADDS.ipynb.txt | 81 ++++- _sources/tutorials/index.rst.txt | 1 + genindex.html | 61 ---- getting_started.html | 2 - modules.html | 6 +- objects.inv | Bin 2108 -> 2005 bytes py-modindex.html | 274 --------------- searchindex.js | 2 +- squadds.core.html | 72 +--- squadds.html | 11 +- ...torial-1_getting_started_with_SQuADDS.html | 112 ++++-- ...orial-1_getting_started_with_SQuADDS.ipynb | 119 +++++-- .../Tutorial-2_Contributing_to_SQuADDS.html | 60 +++- .../Tutorial-2_Contributing_to_SQuADDS.ipynb | 81 ++++- 19 files changed, 487 insertions(+), 1095 deletions(-) delete mode 100644 _modules/index.html delete mode 100644 _modules/squadds/core/utils.html delete mode 100644 py-modindex.html diff --git a/.buildinfo b/.buildinfo index 5d96e112..89d19f04 100644 --- a/.buildinfo +++ b/.buildinfo @@ -1,4 +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: 55f1805b28fd84590ae1799408b974b3 +config: ca994d7d76a3b179a85e8b02c96bfa72 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/_modules/index.html b/_modules/index.html deleted file mode 100644 index e0a62f76..00000000 --- a/_modules/index.html +++ /dev/null @@ -1,243 +0,0 @@ - - - - - - - Overview: module code — SQuADDS 0.1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- Table of Contents - -
- - - - - - - - - - -
- - -
-
-
- - -
-
-
- - -
- -
-
-
- -
- - - - -
-
- - -
-
-
- -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/_modules/squadds/core/utils.html b/_modules/squadds/core/utils.html deleted file mode 100644 index a08584d9..00000000 --- a/_modules/squadds/core/utils.html +++ /dev/null @@ -1,332 +0,0 @@ - - - - - - - squadds.core.utils — SQuADDS 0.1.0 documentation - - - - - - - - - - - - - - - - - - - - -
- Table of Contents - -
- - - - - - - - - - -
- - -
-
-
- - -
-
-
- - -
- -
-
-
-
- -

Source code for squadds.core.utils

-import urllib.parse
-import webbrowser
-import getpass
-import os
-from huggingface_hub import HfApi, HfFolder
-from squadds.core.globals import ENV_FILE_PATH
-
-

-[docs]
-def set_huggingface_api_key():
-    """
-    Sets the Hugging Face API key by appending it to the .env file.
-    If the API key already exists in the .env file, it does not add it again.
-    If the Hugging Face token is not found, it raises a ValueError.
-    """
-    # Check if API key already exists
-    if os.path.exists(ENV_FILE_PATH):
-        with open(ENV_FILE_PATH, 'r') as file:
-            existing_keys = file.read()
-            if 'HUGGINGFACE_API_KEY=' in existing_keys:
-                print('API key already exists in .env file.')
-                return
-    
-    # Ask for the new API key
-    api_key = getpass.getpass("Enter your Hugging Face API key: ")
-    # Append the new API key to the .env file
-    with open(ENV_FILE_PATH, 'a') as file:
-        file.write(f'\nHUGGINGFACE_API_KEY={api_key}\n')
-        print('API key added to .env file.')
-
-    api = HfApi()
-    token = HfFolder.get_token()
-    if token is None:
-        raise ValueError("Hugging Face token not found. Please log in using `huggingface-cli login`.")

-
-
-
-
-
-
-
-

-[docs]
-def send_email_via_client(dataset_name, institute, pi_name, date, dataset_link):
-    """
-    Sends an email notification to recipients with the details of the created dataset.
-
-    Args:
-        dataset_name (str): The name of the dataset.
-        institute (str): The name of the institute where the dataset was created.
-        pi_name (str): The name of the principal investigator who created the dataset.
-        date (str): The date when the dataset was created.
-        dataset_link (str): The link to the created dataset.
-
-    Returns:
-        None
-    """
-    recipients = ["shanto@usc.edu", "elevenso@usc.edu"]
-    subject = f"SQuADDS: Dataset Created - {dataset_name} ({date})"
-    body = f"{dataset_name} has been created by {pi_name} at {institute} on {date}.\nHere is the link - {dataset_link}"
-
-    mailto_link = create_mailto_link(recipients, subject, body)
-    webbrowser.open(mailto_link)

-
-
- -
-
- - - - -
-
- - -
-
-
- -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/_sources/getting_started.rst.txt b/_sources/getting_started.rst.txt index 9ed9c0bc..0e0d1a18 100644 --- a/_sources/getting_started.rst.txt +++ b/_sources/getting_started.rst.txt @@ -36,7 +36,3 @@ Alternatively, you can install SQuADDS from source. FAQ --- -**Q:** Placeholder? - -**A:** Placeholder. - diff --git a/_sources/tutorials/Tutorial-1_getting_started_with_SQuADDS.ipynb.txt b/_sources/tutorials/Tutorial-1_getting_started_with_SQuADDS.ipynb.txt index f2de987e..cf5a50aa 100644 --- a/_sources/tutorials/Tutorial-1_getting_started_with_SQuADDS.ipynb.txt +++ b/_sources/tutorials/Tutorial-1_getting_started_with_SQuADDS.ipynb.txt @@ -766,7 +766,7 @@ }, { "cell_type": "code", - "execution_count": 183, + "execution_count": 249, "metadata": {}, "outputs": [], "source": [ @@ -775,7 +775,7 @@ }, { "cell_type": "code", - "execution_count": 184, + "execution_count": 250, "metadata": {}, "outputs": [], "source": [ @@ -784,7 +784,7 @@ }, { "cell_type": "code", - "execution_count": 173, + "execution_count": 251, "metadata": {}, "outputs": [ { @@ -793,7 +793,7 @@ "'qubit'" ] }, - "execution_count": 173, + "execution_count": 251, "metadata": {}, "output_type": "execute_result" } @@ -804,7 +804,7 @@ }, { "cell_type": "code", - "execution_count": 204, + "execution_count": 252, "metadata": {}, "outputs": [ { @@ -1155,7 +1155,7 @@ "[1934 rows x 17 columns]" ] }, - "execution_count": 204, + "execution_count": 252, "metadata": {}, "output_type": "execute_result" } @@ -1165,6 +1165,13 @@ "df" ] }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [] + }, { "cell_type": "markdown", "metadata": {}, @@ -1174,57 +1181,64 @@ }, { "cell_type": "code", - "execution_count": 206, + "execution_count": 309, "metadata": {}, "outputs": [], "source": [ - "db.select_system(\"cavity_claw\")" + "db.unselect_all()" ] }, { "cell_type": "code", - "execution_count": 212, + "execution_count": 310, "metadata": {}, "outputs": [], "source": [ - "db.select_cavity_claw(\"RouteMeander\")" + "db.select_system(\"cavity_claw\")" ] }, { "cell_type": "code", - "execution_count": 219, + "execution_count": 311, "metadata": {}, "outputs": [], "source": [ - "db.select_coupler(\"CLT\")" + "db.select_cavity_claw(\"RouteMeander\")" ] }, { "cell_type": "code", - "execution_count": null, + "execution_count": 312, "metadata": {}, "outputs": [], - "source": [] - }, - { - "cell_type": "markdown", - "metadata": {}, "source": [ - "### Querying for a target qubit-cavity design" + "db.select_coupler(\"CLT\")" ] }, { "cell_type": "code", - "execution_count": 154, + "execution_count": 313, "metadata": {}, - "outputs": [], + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Selected component: cavity_claw\n", + "Selected component name: RouteMeander\n", + "Selected data type: eigenmode\n", + "Selected system: cavity_claw\n", + "Selected coupler: CLT\n" + ] + } + ], "source": [ - "db.select_system([\"qubit\",\"cavity_claw\"])" + "db.show_selections()" ] }, { "cell_type": "code", - "execution_count": 209, + "execution_count": 294, "metadata": {}, "outputs": [ { @@ -1501,14 +1515,67 @@ "[234 rows x 13 columns]" ] }, - "execution_count": 209, + "execution_count": 294, "metadata": {}, "output_type": "execute_result" } ], "source": [ - "df = db.selected_system_df()\n", - "df" + "db.selected_system_df()" + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "### Querying for a target qubit-cavity design" + ] + }, + { + "cell_type": "code", + "execution_count": 314, + "metadata": {}, + "outputs": [], + "source": [ + "db.select_system([\"qubit\",\"cavity_claw\"])" + ] + }, + { + "cell_type": "code", + "execution_count": 315, + "metadata": {}, + "outputs": [], + "source": [ + "db.select_qubit(\"TransmonCross\")\n", + "db.select_cavity_claw(\"RouteMeander\")\n", + "db.select_coupler(\"CLT\")" + ] + }, + { + "cell_type": "code", + "execution_count": 316, + "metadata": {}, + "outputs": [ + { + "name": "stdout", + "output_type": "stream", + "text": [ + "Selected qubit: TransmonCross\n", + "Selected cavity: RouteMeander\n", + "Selected coupler: CLT\n", + "Selected system: ['qubit', 'cavity_claw']\n" + ] + } + ], + "source": [ + "db.show_selections()" ] }, { diff --git a/_sources/tutorials/Tutorial-2_Contributing_to_SQuADDS.ipynb.txt b/_sources/tutorials/Tutorial-2_Contributing_to_SQuADDS.ipynb.txt index f80d123b..c21e8098 100644 --- a/_sources/tutorials/Tutorial-2_Contributing_to_SQuADDS.ipynb.txt +++ b/_sources/tutorials/Tutorial-2_Contributing_to_SQuADDS.ipynb.txt @@ -115,23 +115,18 @@ "- Adding to SQuADDS_DB" ] }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [] - }, { "cell_type": "markdown", "metadata": {}, "source": [ - "## Where we left of in Tutorial 1 - *Contributing to an existing configuration* " + "## Where we left of in Tutorial 1 - *Contributing to an existing configuration* \n", + "\n", + "Format the result from Tutorial 1 to be compatible with SQuADDS." ] }, { "cell_type": "code", - "execution_count": null, + "execution_count": 2, "metadata": {}, "outputs": [], "source": [] @@ -165,6 +160,25 @@ "---" ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Show how to add this new data entry to the SQuADDS database by creating a PR. \n", + "\n", + "1. Code to fork the repo and create a new branch.\n", + "2. Code to add the new data to the chosen configuration.\n", + "3. Code to commit and push the changes.\n", + "4. Code to create a PR." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [] + }, { "cell_type": "markdown", "metadata": {}, @@ -213,6 +227,31 @@ "If all the `sim_results` has the same units you can just use a `\"units\":units` field instead of repeating the unit for each result." ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "### Metadata:\n", + "\n", + "The metadata for the configuration should include \n", + "\n", + "- the name of the configuration\n", + "- a description of the configuration\n", + "- contributors to the configuration\n", + "- device design, design tool and name\n", + "- simulation setup and simulator name\n", + "- simulation code `Simulator`\n", + "- simulation result parameters\n", + "- measured parameters" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Code to help generate portions of the metadata and guide the user to create custom `Simulator` (future release and tutorial)" + ] + }, { "cell_type": "code", "execution_count": null, @@ -258,6 +297,19 @@ "7. **Create a Pull Request**: Go to the Hugging Face Hub, navigate to your fork, and create a pull request for your new branch. The pull request will be reviewed by the dataset maintainers." ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Show \n", + "\n", + "1. Code to fork the repo and create a new branch.\n", + "2. Code to add the new data to a new configuration.\n", + "3. Code to add metadata to the configuration.\n", + "4. Code to commit and push the changes.\n", + "5. Code to create a PR." + ] + }, { "cell_type": "code", "execution_count": null, @@ -279,6 +331,17 @@ "We might have some data that can be appended to an existing dataset in SQuADDS. In this case, we can add to the existing configuration in `SQuADDS_DB` without pushing new entries to the original dataset." ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "1. Code to fork the repo and create a new branch.\n", + "2. Code to add the new data to the chosen configuration.\n", + " - handling contributions (appending code gives uploader name and institute only and notes)\n", + "3. Code to commit and push the changes.\n", + "4. Code to create a PR." + ] + }, { "cell_type": "code", "execution_count": null, diff --git a/_sources/tutorials/index.rst.txt b/_sources/tutorials/index.rst.txt index 84ac037d..6b2635de 100644 --- a/_sources/tutorials/index.rst.txt +++ b/_sources/tutorials/index.rst.txt @@ -6,3 +6,4 @@ Tutorials Tutorial-1_Getting_started_with_SQuADDS.ipynb Tutorial-2_Contributing_to_SQuADDS.ipynb + More Tutorials Coming Soon! \ No newline at end of file diff --git a/genindex.html b/genindex.html index 3baf5fbd..ea7cecf5 100644 --- a/genindex.html +++ b/genindex.html @@ -144,69 +144,8 @@

Index

- C - | M - | S
-

C

- - -
- -

M

- - -
- -

S

- - - -
    -
  • - squadds.core.globals - -
    • -
  • - squadds.core.utils - -
    • -
- diff --git a/getting_started.html b/getting_started.html index 64b06877..3b207ea0 100644 --- a/getting_started.html +++ b/getting_started.html @@ -170,8 +170,6 @@

Installation

FAQ

-

Q: Placeholder?

-

A: Placeholder.

diff --git a/modules.html b/modules.html index 3351bd0b..8a4de249 100644 --- a/modules.html +++ b/modules.html @@ -151,9 +151,9 @@

SQuADDS
  • Subpackages
    • squadds.core package
    • squadds.database package
        diff --git a/objects.inv b/objects.inv index 57bab5c77fa5304852ac34cce1e66c933cb5f703..bcf7c955550a1be567d8a2c1501f4954d8d05744 100644 GIT binary patch delta 1907 zcmV-(2aNc<5Y-QmcYn=x<1`fB_bJ2#4zN&v!Y;d#&Opy$hL&`gWshPjiBBCXwdH2Q zinrjfV#Aa11Uv#)f3{@Hv17X|+Sph3e)mUL(v_tPvWr3%WEW8q($D8<#!<$@SxlBR zM)(T3%^SXr(e>Re`h~7&N|S(|UDN<3K*6bDXoIV8SHMI1LVshnqiK_URR(F{jUl2B zjMK~uGYMG2(`cFVh$T4Ubepv!`-J8e3Ec`(i$0c~q)D*PtrtIfLBok~xr2hLM5mw? zw39Sg;DEcPoJYy}G2%!k`TEK=$c#zKpmu1Ao#S^utdUtrJPfqHV51jY9$^ zk&HH~A5Vksrx_w>;XZ*`k0#2Fi}WUL^wN%w#Uku#*Ulu5}RY zlxABN=FqG4d^HU+V~e37@GGLfa1_zM1}m(%a?)f9eP^)w3psv6Mc z`PKO)`lf98_Us~~Jm1x$qR28D@=<4i#XpfxSkaq=D@-nuN~80DrPO19-Ky-cC}>B5 zC$jdSOcXp8#Q+S5tOd2k{$81C-aQJ;z!U_$j(^#b#F;+~HDyOdZEoGx7%LY^2je8| zg-o}oI^>f)3w0ULA5qI;Yo`PESm7I&>u|zcUb#uZM98S^|OGYh3He$Erb2M~M zKu3`Yt0CfGLxU%%Opo=7tGE@SDy7?Nz0_hDOIFc(kXaU-FwnFbjK@C1 zbAO_d;c|#=mULAhT%Ksj(HW-2j_OR)aVXVrQcA*M30^^{X_d_c@l5l=&Ar6{;%u<_cQ9hqta50=C zSfZOM-YSEP--97~0VV~l9m?YMf|@6M^?z8|={|~G^P}-H+8vT*le&i%5WN9#eM48X zmW_H(D<>p?dOj2TJiej0K9Gv0O}<{k^NPR@knEx{+?!lG%5@XIsVo0cDSs!Fi%)Zf zAc9sC1Y`tJUNl*P;+tOoI0Z0~$?Y(Koo^7ZJmI5+U~b`FYg|KveKFFs{)XHA_J8kR zfB!Lx)pmbKP&>|o(BIxT3TRUOP|?%OpEQ>K9bgm#@5V7nBFX>#&DoMC`91HDiSN9a zAJ8 zy-(<8jsbs{ou8kN;@}5?xG;#~4S$)p{$@VsG(Cv8t)Px27#Kka2jnH<2mK9g6yxtZ z=rKG9co0E~2Pqz;c*b^AeK!2R-1TYmJ8g50>$+H|Dh9ol-_5EVr^O2BIzHHA^Tk&$ z%wJ8XOPX=K&S5=HbNq^szOm7BzTXN5E_d}ST{ytdBbg_pQwtq5H=e&MZ znAa*oaXiWyR^_7n_D_=d@Ees({?mn?Vfa`p2%&K6p!;L39u$=#XGqD(Lk1-$naV>3 zPmrdMuEP;US#463e*EGX>mOfJT(VnX%1h{8f4a(3&#BMpKFwYH4}d>+@SXl4P#o-$ z!!Xb*aekk`T)kDNXzFYJXg&ert%bgj=^yRz9(55!Im-&uHq zfGk2UD>rN}=8=Ml`Vwle?LT(Y0&HTqmu!$+z=mA5k^B_1XM*YHD1VcA{@M;7S6BC3 zOwtK5{9}Zm>n^gzwJsaTHdD5g6EQvp$N7B$R6O-EsAQaBXL>CU$cLKxV5yi_RMe`N zkr%-{31P|Mu-uzEg41*xB@8z42X&9Zd|=9Wng={j2j|JhJ~|yCS(8{ovRtw1DlOD2 zB70baDc(~Y)0N!1M}M$>7bO|SwJc~HyhG#k$z#cbZOOc|B@znlDH2ek)QA$RFh;nR zQ;jpsnR6RZx(KhGZXGV8WgM|}N_Lw=m)jIy+LtIQm(^^=ovstEX;KPWcd!ym=2kqO zRf=v~)9IJoYQ`SDuJzCFf7Wi&Y+2|re0RX6L4oNL4CR7-8f>HWdavDBC@t`J2fl$k za#=hu=hA{l tsO8c~?Ih9z(eWC<$s0#o*K41&oHFUP*fqi~v2u*%SLi(~`wyi;-4H*dv4a2r delta 2011 zcmV<12PF8_54;eNcYnch+cprr`zz2Wowf%kwtCaem6OIZO=?$8bJS2IBw);Y(+Y{zkiB90c@2&bGbQh!VyCEO|}F~^jED-U1` z5!5;GsnBV8uH#c)H=4cf?b>k|nch~oR z2rYwJ2BlM|CsF|RQS;LS!bJQ^(@2f9Ztsrzt@Y!gZGSRZQ|L2FW4c9vQ^V;S2E^3O zw<1v~l&>!A!Hv0xmOY$}!c0Hd*5V1rh{1>?kVnh3K7K76kLqn90zw1|k&R8CQTB|{ zz7?@l_*p;L*7{|^2(ny^UNI??JXY`YDPLl)Xoz7h{EI&fuZfZ{yv>WQhDjtSMGUpN zKc5Hvo`0qw0&^D%+)F5MEjs8%L5V*SN_E-1gaQW2?ty(V5Fn>!Bl~BHG_DUgEy`diU2(a`=>Iv$~u*JBh1 zQAhhYve)E8L0Q%mVqUQ@M`gKvy2HxUCv598FH%vp_n@E+o1#|tCP_&F)bFIrv)?A{ z<$s3lFv19QfrMyIffK4tCD7^F6$nO-J+1bAqev}Pd3k(o_K2;&WkAH^2Mo0z?hJ0a>;y1kJWI*3uS z!s|i2T!aQK)qFZDvrimItpVfVXLL>^nSU&YaI>uI2Fdb7CP#C82akHL51dL39Fc{S zVFSE|(D167PwW|$$%c?}0qQpXh1jLkksE9NkLSnMv}k9;=9>%7eW#^7yT^|XL8ohL z1J2J@^n;ckV`^*7tLKY1Tux^!YP7bkPhCOv--8i)0Y;^)8_Lr4f|@6IwWxjaSbxaR zCkqoL-W|xY&D}!>h~5dhv4N{;#}}KPEJsl+Hg-&I`1z(RVXcW&Hd!?V6g9;;!W&&X z&UF*KX*z#jIDaRd%Wt%$ArP&m6M!)UdD&zc%8$GK`$^TSl1@aR=rfuVewHqnS-964 z*T_IbfR^MczrBHPjk`h> zXjLFo0bK#D3WO>!s{NxU=nIDef5*n-@mT`=C=urdQT_tvSAUvMIm!;Q-+xx3j*XyD z6h<(Po-se@kEv%Ne;?q-=m4PuB2egnLI)H&=MJ>^e*Axh>+|Lh+SWX8=yIW|5qhb( z+g&+9%N5WKd~n3()4yJrzn)B%h;g{i#d<7$oHOEin5#-n#rvvKdNnxON_z^!Pvd&V z`(QcK#U7m7&P<*2@>OBpsDB9MIXS1WC>PZsP(;$hZ%8TmkC}RQ!>2|;C7>b`I%*eWIX$tqpDboIdw*F!nF3qUI*95+YqZR9n#kUx zM0D6ruF_P*nlZSi*&`cBd-OvGylDrNh)8yF41;BYkx*AlQaQF{~TQqx{K@xEo1}PMWs@lLMNM57ZZlke6U>1YAzZ@ z!=BSqa%IQFszU*6 zjH%WMec{}~R3VC=LAO1Zc$s3l&Z6Ds5ORyXA zsMWZ(r_(PNHpm{mCilQF~ZE4~mzB@qEP=M(JgCYd`@I(9cUU#xkI^gdPd?Ut@ zOTnU0Ih)e*FpdQ diff --git a/py-modindex.html b/py-modindex.html deleted file mode 100644 index 8d27ff37..00000000 --- a/py-modindex.html +++ /dev/null @@ -1,274 +0,0 @@ - - - - - - - Python Module Index — SQuADDS 0.1.0 documentation - - - - - - - - - - - - - - - - - - - - -
        - Table of Contents - -
        - - - - - - - - - - -
        - - -
        -
        -
        - - -
        -
        -
        - - -
        - -
        -
        -
        - -
        - - - - -
        -
        - - -
        -
        -
        - -
        -
        -
        -
        -
        - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/searchindex.js b/searchindex.js index e14f7d5d..468cbee4 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["apidocs/index", "developer/index", "getting_started", "index", "modules", "references/index", "release_notes", "setup", "squadds", "squadds.core", "squadds.database", "tutorials/Tutorial-1_getting_started_with_SQuADDS", "tutorials/Tutorial-2_Contributing_to_SQuADDS", "tutorials/index"], "filenames": ["apidocs/index.rst", "developer/index.rst", "getting_started.rst", "index.rst", "modules.rst", "references/index.rst", "release_notes.rst", "setup.rst", "squadds.rst", "squadds.core.rst", "squadds.database.rst", "tutorials/Tutorial-1_getting_started_with_SQuADDS.ipynb", "tutorials/Tutorial-2_Contributing_to_SQuADDS.ipynb", "tutorials/index.rst"], "titles": ["API Reference", "Developer Notes", "Getting Started with SQuADDS", "Welcome to SQuADDS\u2019s documentation!", "SQuADDS", "References", "Release Notes", "setup module", "squadds package", "squadds.core package", "squadds.database package", "Tutorial 1: Getting Started with SQuADDS", "Tutorial 2: Contributing to SQuADDS", "Tutorials"], "terms": {"0": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13], "1": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 13], "thi": [0, 3, 11, 12], "section": [0, 1], "provid": [0, 1, 3, 11, 12], "detail": [0, 9], "document": [0, 1], "all": [0, 12], "modul": [0, 3, 4], "class": [0, 3], "function": 0, "other": 0, "member": 0, "squadd": [0, 1, 13], "project": 0, "setup": [0, 4, 11], "packag": [0, 4, 5, 6, 11, 12], "everyon": 1, "i": [1, 3, 9, 11, 12], "welcom": 1, "pleas": [1, 3, 11], "see": 1, "review": [1, 5, 12], "follow": [1, 11, 12], "more": [1, 12], "inform": [1, 5], "contact": 1, "u": 1, "bug": 1, "report": 1, "ani": [1, 11, 12], "you": [1, 2, 3, 11, 12], "find": [1, 12], "code": [1, 11, 12], "open": [1, 3, 5], "an": [1, 3, 5, 9], "issu": 1, "github": [1, 2, 5], "featur": [1, 11], "request": [1, 12], "If": [1, 3, 9, 12], "have": [1, 11, 12], "idea": 1, "new": [1, 3, 5], "pull": [1, 12], "we": [1, 11], "from": [1, 2, 3, 5, 11, 12], "commun": 1, "submit": 1, "patient": 1, "your": [1, 2, 3, 11, 12], "work": [1, 3, 11], "question": 1, "about": [1, 12], "typo": 1, "error": 1, "implement": [1, 3, 6], "next": 1, "releas": 1, "would": 1, "like": 1, "help": 1, "version": 1, "look": 1, "what": [1, 11], "sadman": [1, 3, 11, 12], "ahm": [1, 3, 11, 12], "shanto": [1, 3, 11, 12], "univers": 1, "southern": 1, "california": 1, "eli": [1, 3, 11, 12], "levenson": [1, 3, 11, 12], "falk": [1, 3, 11, 12], "etern": 1, "guidanc": 1, "andr": [1, 3, 11], "kuo": [1, 3, 11], "clark": [1, 3], "miyamoto": [1, 3], "york": 1, "madison": 1, "howard": 1, "institut": [1, 9, 11, 12], "technologi": [1, 5], "hunter": 1, "can": [2, 11, 12], "us": [2, 3, 12], "pip": [2, 11, 12], "altern": 2, "sourc": [2, 3, 5, 9, 11, 12], "clone": [2, 12], "repositori": [2, 3, 12], "navig": [2, 12], "chosen": [2, 11], "directori": [2, 11, 12], "cd": 2, "repo": 2, "path": 2, "git": [2, 12], "http": [2, 5, 12], "com": [2, 5], "shanto268": 2, "depend": [2, 12], "activ": 2, "qiskit": [2, 5, 11], "metal": [2, 5, 11], "conda": 2, "environ": [2, 11], "env": [2, 9, 11, 12], "q": [2, 5], "placehold": 2, "A": [2, 3, 5, 9], "platform": [3, 11], "aim": 3, "speed": 3, "up": [3, 11], "loop": 3, "creation": 3, "quantum": [3, 5], "hardwar": 3, "tool": [3, 11], "bridg": 3, "gap": 3, "between": 3, "theoret": 3, "practic": [3, 12], "research": 3, "engin": [3, 5], "well": 3, "character": [3, 5], "start": 3, "point": 3, "develop": [3, 11, 12], "enabl": [3, 11], "rapid": 3, "gener": [3, 9], "best": [3, 12], "guess": 3, "valid": 3, "pre": [3, 6], "underpin": 3, "vast": 3, "experiment": [3, 5], "paramet": [3, 9, 11], "lower": 3, "barrier": 3, "entri": [3, 12], "group": [3, 5, 11, 12], "seek": 3, "make": [3, 12], "them": 3, "which": 3, "refin": 3, "hi": 3, "support": 3, "its": 3, "continu": 3, "mainten": 3, "cite": 3, "our": [3, 6, 11], "thank": 3, "articl": 3, "titl": 3, "workflow": 3, "author": 3, "haimeng": 3, "zhang": [3, 5], "vivek": 3, "maurya": [3, 5], "evangelo": 3, "vlacho": 3, "malida": 3, "hecht": 3, "chung": 3, "wa": [3, 9], "shum": 3, "journal": [3, 5], "arxiv": [3, 5], "preprint": 3, "year": 3, "2023": [3, 5, 11, 12], "index": 3, "search": 3, "page": [3, 11], "subpackag": 4, "core": [4, 8, 11], "submodul": [4, 8], "global": [4, 8], "util": [4, 8, 11], "content": 4, "databas": [4, 6, 8], "checker": [4, 8], "config": [4, 8, 11], "contributor": [4, 8, 11, 12], "db": [4, 8, 11], "reader": [4, 8], "avail": [5, 11], "org": 5, "hug": [5, 9, 12], "face": [5, 9, 12], "huggingfac": [5, 6, 12], "co": [5, 12], "minev": 5, "et": 5, "al": 5, "energi": 5, "particip": 5, "quantiz": 5, "josephson": 5, "circuit": [5, 12], "npj": 5, "vol": 5, "7": [5, 11], "pp": 5, "131": 5, "2021": 5, "natur": 5, "publish": 5, "uk": 5, "london": 5, "electrodynam": 5, "cqed": 5, "modular": 5, "quasi": 5, "lump": 5, "model": [5, 11], "2103": 5, "10344": 5, "quant": 5, "ph": 5, "yuan": 5, "comparison": 5, "oscil": 5, "ratio": 5, "method": 5, "design": [5, 6, 12], "two": 5, "dimension": 5, "superconduct": 5, "chip": 5, "entropi": 5, "24": 5, "6": [5, 11], "792": 5, "2022": 5, "mdpi": 5, "awslab": 5, "palac": 5, "3d": 5, "finit": 5, "element": [5, 12], "solver": [5, 11], "comput": 5, "electromagnet": 5, "koch": 5, "charg": 5, "insensit": 5, "qubit": 5, "deriv": [5, 11, 12], "cooper": 5, "pair": 5, "box": 5, "physic": 5, "76": 5, "4": [5, 11], "042319": 5, "2007": 5, "ap": 5, "yan": 5, "framework": 5, "optim": 5, "2020": 5, "2006": 5, "04130": 5, "krantz": 5, "": [5, 11, 12], "guid": 5, "appli": 5, "2": [5, 11, 13], "2019": 5, "aip": 5, "groszkowski": 5, "j": 5, "scqubit": 5, "python": [5, 12], "5": [5, 11], "583": 5, "verein": 5, "zur": 5, "f\u00f6rderung": 5, "de": 5, "access": 5, "publizieren": 5, "den": 5, "quantenwissenschaften": 5, "aumann": 5, "circuitq": 5, "toolbox": 5, "9": 5, "093012": 5, "iop": 5, "nois": 5, "suppress": 5, "through": [5, 11], "demand": 5, "caviti": [5, 6], "cool": 5, "control": 5, "bulletin": 5, "american": 5, "societi": 5, "liu": 5, "dissip": 5, "On": [5, 12], "shillito": 5, "dynam": 5, "transmon": 5, "ioniz": 5, "18": 5, "3": [5, 11], "034031": 5, "besedin": 5, "p": 5, "menushenkov": 5, "qualiti": 5, "factor": 5, "transmiss": 5, "line": 5, "coupl": 5, "coplanar": 5, "waveguid": 5, "reson": 5, "epj": 5, "16": 5, "2018": 5, "springeropen": 5, "mcdaniel": 5, "simul": [5, 6, 12], "guidelin": [5, 12], "wideband": 5, "ground": 5, "back": [5, 12], "ieee": 5, "20th": 5, "wireless": 5, "microwav": 5, "confer": 5, "wamicon": 5, "driven": 5, "reset": 5, "2310": 5, "16785": 5, "cond": 5, "mat": 5, "tanamoto": 5, "classic": 5, "spice": 5, "express": 5, "034501": 5, "huang": 5, "machin": [5, 12], "learn": [5, 11], "electron": 5, "autom": 5, "survei": 5, "acm": 5, "transact": 5, "system": 5, "26": 5, "46": 5, "jiang": 5, "deep": 5, "neural": 5, "network": 5, "evalu": 5, "photon": 5, "devic": [5, 11], "materi": 5, "8": [5, 11], "679": 5, "700": 5, "feng": 5, "artifici": 5, "aid": 5, "The": [5, 9, 11, 12], "state": 5, "art": 5, "theori": 5, "techniqu": 5, "70": 5, "11": 5, "4597": 5, "4619": 5, "nov": 5, "nugraha": 5, "shao": 5, "base": [5, 6], "predict": 5, "march": 5, "meet": 5, "la": 5, "vega": 5, "nevada": 5, "10": [5, 11], "virtual": 5, "20": [5, 11], "22": 5, "b73": 5, "00007": 5, "multivalu": 5, "invers": 5, "applic": 5, "filter": 5, "66": 5, "3781": 5, "3797": 5, "aug": 5, "willsch": 5, "observ": 5, "harmon": 5, "tunnel": 5, "junction": 5, "2302": 5, "09192": 5, "sep": 5, "kerman": 5, "effici": 5, "numer": 5, "complex": 5, "2010": 5, "14929": 5, "menk": 5, "Its": 5, "local": [5, 12], "coupler": [5, 6, 11], "mar": 5, "rajabzadeh": 5, "analysi": 5, "arbitrari": 5, "accompani": 5, "sqcircuit": 5, "1118": 5, "mvp": 6, "host": [6, 11], "data": [6, 11], "transmoncross": [6, 11], "claw": 6, "onli": 6, "closest": [6, 11], "interpol": [6, 11], "retriev": 6, "logic": 6, "paper": 6, "tutori": 6, "basic": [6, 11, 12], "usag": [6, 11], "contribut": [6, 11, 13], "ad": [6, 12], "pypi": 6, "creat": [6, 9, 12], "create_mailto_link": [8, 9], "send_email_via_cli": [8, 9], "set_huggingface_api_kei": [8, 9, 11], "recipi": 9, "subject": 9, "bodi": 9, "mailto": 9, "link": 9, "given": 9, "list": 9, "email": 9, "address": 9, "str": 9, "return": 9, "type": 9, "dataset_nam": [9, 12], "pi_nam": [9, 12], "date": 9, "dataset_link": 9, "send": 9, "notif": 9, "dataset": [9, 11, 12], "name": [9, 11], "where": 9, "princip": 9, "investig": 9, "who": 9, "when": 9, "none": [9, 11], "set": [9, 11], "api": 9, "kei": [9, 11], "append": [9, 11, 12], "file": [9, 11, 12], "alreadi": [9, 11, 12], "exist": [9, 11], "doe": 9, "add": [9, 12], "again": 9, "token": 9, "found": [9, 11, 12], "rais": 9, "valueerror": 9, "In": [11, 12], "walk": 11, "some": [11, 12], "By": 11, "end": 11, "abl": 11, "hamiltonian": 11, "em": 11, "34": 11, "load_ext": [11, 12], "autoreload": [11, 12], "extens": [11, 12], "load": [11, 12], "To": [11, 12], "reload": [11, 12], "reload_ext": [11, 12], "35": 11, "instal": [11, 12], "e": [11, 12], "obtain": [11, 12], "user": [11, 12], "lfl": [11, 12], "prepar": [11, 12], "metadata": [11, 12], "py": [11, 12], "done": [11, 12], "collect": [11, 12], "attempt": [11, 12], "uninstal": [11, 12], "successfulli": [11, 12], "run": [11, 12], "sinc": 11, "need": [11, 12], "compani": 11, "larg": 11, "number": 11, "nlp": 11, "thei": [11, 12], "also": 11, "own": 11, "instruct": 11, "here": 11, "sign": 11, "onc": 11, "updat": [11, 12], "huggingface_api_kei": 11, "variabl": [11, 12], "execut": [11, 12], "import": [11, 12], "command": [11, 12], "termin": 11, "cli": 11, "prompt": 11, "enter": 11, "usernam": 11, "password": 11, "log": 11, "check": 11, "statu": 11, "whoami": 11, "librari": [11, 12], "37": 11, "get_dataset_config_nam": 11, "load_dataset": 11, "squadds_db": [11, 12], "39": 11, "compon": 11, "component_nam": 11, "data_typ": 11, "split": 11, "print": 11, "cavity_claw": 11, "routermeand": 11, "ncap": 11, "cap_matrix": 11, "eigenmod": 11, "qubit_data": 11, "while": 11, "possibl": 11, "directli": 11, "simpl": 11, "easier": 11, "161": 11, "162": 11, "83": 11, "view_dataset": 11, "routemeand": 11, "88": 11, "get_dataset_info": 11, "pi": [11, 12], "valu": 11, "dtype": 11, "string": 11, "id": 11, "date_cr": [11, 12], "upload": [11, 12], "design_opt": [11, 12], "design_tool": [11, 12], "note": 11, "sim_opt": [11, 12], "renderer_opt": 11, "sim_result": [11, 12], "claw_to_claw": 11, "float64": 11, "claw_to_ground": 11, "cross_to_claw": 11, "cross_to_cross": 11, "cross_to_ground": 11, "ground_to_ground": 11, "unit": [11, 12], "descript": 11, "citat": 11, "homepag": 11, "size": 11, "byte": 11, "9700839": 11, "87": 11, "coupler_typ": 11, "cavity_frequ": 11, "kappa": 11, "879111": 11, "205": 11, "get_dataset": 11, "aedt_hfss_capacit": 11, "aedt_hfss_induct": 11, "phd": 11, "09": 11, "142547": 11, "usc": 11, "94": 11, "97421": 11, "90": 11, "86585": 11, "73363": 11, "158": 11, "40783": 11, "311": 11, "25590": 11, "nh": 11, "cj": 11, "lj": 11, "10nh": 11, "_rj": 11, "design_nam": 11, "auto_increase_solution_ord": 11, "true": 11, "ansi": 11, "hfss": 11, "25": 11, "153123": 11, "82": 11, "44280": 11, "79": 11, "19378": 11, "93820": 11, "188": 11, "15089": 11, "333": 11, "52997": 11, "76412": 11, "80": 11, "18130": 11, "16131": 11, "104": 11, "35340": 11, "237": 11, "02548": 11, "153126": 11, "103": 11, "37057": 11, "97": 11, "22405": 11, "77590": 11, "174": 11, "13928": 11, "335": 11, "31609": 11, "68": 11, "92854": 11, "65": 11, "68607": 11, "87375": 11, "120": 11, "03923": 11, "240": 11, "34085": 11, "1929": 11, "106": 11, "43025": 11, "101": 11, "53197": 11, "45645": 11, "46380": 11, "340": 11, "62919": 11, "1930": 11, "142549": 11, "121": 11, "10943": 11, "112": 11, "62570": 11, "95178": 11, "187": 11, "43537": 11, "367": 11, "34003": 11, "1931": 11, "144": 11, "56289": 11, "136": 11, "36810": 11, "65968": 11, "172": 11, "14561": 11, "372": 11, "39970": 11, "1932": 11, "76413": 11, "78116": 11, "48795": 11, "56": 11, "75230": 11, "166": 11, "57383": 11, "1933": 11, "58": 11, "45749": 11, "55": 11, "50796": 11, "54396": 11, "62": 11, "01000": 11, "42140": 11, "1934": 11, "row": 11, "17": [11, 12], "column": 11, "108": 11, "get_config": 11, "109": 11, "view_contributors_of": 11, "view_all_contributor": 11, "183": 11, "select_system": 11, "184": 11, "select_qubit": 11, "173": 11, "selected_system": 11, "204": 11, "df": 11, "selected_system_df": 11, "206": 11, "212": 11, "select_cavity_claw": 11, "219": 11, "select_coupl": 11, "clt": 11, "154": 11, "209": 11, "claw_opt": 11, "connection_pad": 11, "readout": 11, "12": 11, "01": 11, "170608": 11, "353550e": 11, "161106": 11, "598429": 11, "hz": 11, "basis_ord": 11, "max_delta_f": 11, "05": 11, "max_p": 11, "04": 11, "124953": 11, "399241e": 11, "268412": 11, "116632": 11, "204334": 11, "694845e": 11, "255873": 11, "654612": 11, "08": 11, "173545": 11, "616574e": 11, "30459": 11, "761161": 11, "986835e": 11, "208304": 11, "221064": 11, "229": 11, "949469e": 11, "126438": 11, "881378": 11, "230": 11, "805442e": 11, "291439": 11, "656224": 11, "231": 11, "06": 11, "224829": 11, "597444e": 11, "587144": 11, "918000": 11, "232": 11, "116894e": 11, "209744": 11, "544864": 11, "233": 11, "145996e": 11, "155139": 11, "565546": 11, "234": 11, "13": 11, "let": 11, "do": [11, 12], "quick": 11, "recap": 11, "got": 11, "how": 11, "part": [11, 12], "copyright": [11, 12], "under": [11, 12], "mit": [11, 12], "mayobtain": [11, 12], "copi": [11, 12], "txt": [11, 12], "root": [11, 12], "tree": [11, 12], "modif": [11, 12], "must": [11, 12], "retain": [11, 12], "thiscopyright": [11, 12], "notic": [11, 12], "modifi": [11, 12], "carri": [11, 12], "indicatingthat": [11, 12], "been": [11, 12], "alter": [11, 12], "origin": [11, 12], "go": 12, "over": 12, "cover": 12, "topic": 12, "node": 12, "86": 12, "14": 12, "order": 12, "yourself": 12, "track": 12, "give": 12, "credit": 12, "group_nam": 12, "user_nam": 12, "Or": 12, "cell": 12, "create_contributor_info": 12, "fork": 12, "so": 12, "checkout": 12, "branch": 12, "might": 12, "b": 12, "add_to_configur": 12, "necessari": 12, "sure": 12, "maintain": 12, "specif": 12, "format": 12, "requir": 12, "commit": 12, "push": 12, "chang": 12, "m": 12, "y": 12, "against": 12, "mai": 12, "possess": 12, "current": 12, "includ": 12, "case": 12, "But": 12, "befor": 12, "compat": 12, "refer": 12, "want": 12, "json": 12, "AT": 12, "least": 12, "field": 12, "mani": 12, "supplementari": 12, "design_tool_nam": 12, "sim_setup_opt": 12, "simulator_nam": 12, "result1": 12, "sim_result1": 12, "unit1": 12, "result2": 12, "sim_result2": 12, "unit2": 12, "yyyi": 12, "mm": 12, "dd": 12, "hhmmss": 12, "ha": 12, "same": 12, "just": 12, "instead": 12, "repeat": 12, "each": 12, "result": 12, "hub": 12, "your_usernam": 12, "It": 12, "good": 12, "new_configur": 12, "involv": 12, "ones": 12, "builder": 12, "script": 12, "defin": 12, "clear": 12, "messag": 12, "x": 12, "without": 12}, "objects": {"squadds": [[9, 0, 0, "-", "core"]], "squadds.core": [[9, 0, 0, "-", "globals"], [9, 0, 0, "-", "utils"]], "squadds.core.utils": [[9, 1, 1, "", "create_mailto_link"], [9, 1, 1, "", "send_email_via_client"], [9, 1, 1, "", "set_huggingface_api_key"]]}, "objtypes": {"0": "py:module", "1": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"]}, "titleterms": {"api": [0, 11], "refer": [0, 5], "develop": 1, "note": [1, 6], "contribut": [1, 12], "item": 1, "contributor": [1, 10], "get": [2, 11], "start": [2, 11], "squadd": [2, 3, 4, 8, 9, 10, 11, 12], "instal": 2, "faq": 2, "welcom": 3, "": 3, "document": 3, "overview": 3, "superconduct": 3, "qubit": [3, 11], "And": 3, "devic": 3, "design": [3, 11], "simul": [3, 11], "databas": [3, 10, 11, 12], "citat": 3, "indic": 3, "tabl": 3, "releas": 6, "version": 6, "0": 6, "1": [6, 11, 12], "2023": 6, "12": 6, "20": 6, "setup": [7, 12], "modul": [7, 8, 9, 10], "packag": [8, 9, 10], "subpackag": 8, "content": [8, 9, 10], "core": 9, "submodul": [9, 10], "global": 9, "util": [9, 10], "checker": 10, "config": 10, "db": 10, "reader": 10, "tutori": [11, 12, 13], "huggingfac": 11, "creat": 11, "an": [11, 12], "account": 11, "login": 11, "access": 11, "us": 11, "anlyz": 11, "make": 11, "system": 11, "out": 11, "circuit": 11, "qed": 11, "element": 11, "queri": 11, "target": 11, "caviti": 11, "best": 11, "guess": 11, "next": 11, "step": 11, "licens": [11, 12], "2": 12, "inform": 12, "understand": 12, "terminologi": 12, "structur": 12, "where": 12, "we": 12, "left": 12, "exist": 12, "configur": 12, "how": 12, "new": 12, "data": 12, "process": 12, "build": 12, "top": 12, "other": 12, "work": 12}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "nbsphinx": 4, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"API Reference": [[0, "api-reference"]], "Developer Notes": [[1, "developer-notes"]], "Contribution Items": [[1, "contribution-items"]], "Developers": [[1, "developers"]], "Contributors": [[1, "contributors"]], "Getting Started with SQuADDS": [[2, "getting-started-with-squadds"]], "Installation": [[2, "installation"]], "FAQ": [[2, "faq"]], "Welcome to SQuADDS\u2019s documentation!": [[3, "welcome-to-squadds-s-documentation"]], "Overview": [[3, "overview"]], "SQuADDS: a Superconducting Qubit And Device Design and Simulation database": [[3, "squadds-a-superconducting-qubit-and-device-design-and-simulation-database"]], "Citation": [[3, "citation"]], "Indices and tables": [[3, "indices-and-tables"]], "SQuADDS": [[4, "squadds"]], "References": [[5, "references"]], "Release Notes": [[6, "release-notes"]], "Version 0.1.0 (2023-12-20)": [[6, "version-0-1-0-2023-12-20"]], "setup module": [[7, "setup-module"]], "squadds package": [[8, "squadds-package"]], "Subpackages": [[8, "subpackages"]], "Module contents": [[8, "module-contents"], [9, "module-squadds.core"], [10, "module-contents"]], "squadds.core package": [[9, "squadds-core-package"]], "Submodules": [[9, "submodules"], [10, "submodules"]], "squadds.core.globals module": [[9, "module-squadds.core.globals"]], "squadds.core.utils module": [[9, "module-squadds.core.utils"]], "squadds.database package": [[10, "squadds-database-package"]], "squadds.database.checker module": [[10, "squadds-database-checker-module"]], "squadds.database.config module": [[10, "squadds-database-config-module"]], "squadds.database.contributor module": [[10, "squadds-database-contributor-module"]], "squadds.database.db module": [[10, "squadds-database-db-module"]], "squadds.database.reader module": [[10, "squadds-database-reader-module"]], "squadds.database.utils module": [[10, "squadds-database-utils-module"]], "Tutorial 1: Getting Started with SQuADDS": [[11, "Tutorial-1:-Getting-Started-with-SQuADDS"]], "HuggingFace \ud83e\udd17": [[11, "HuggingFace-\ud83e\udd17"]], "Creating an Account": [[11, "Creating-an-Account"]], "Login": [[11, "Login"]], "Accessing the SQuADDS Database using the HuggingFace API": [[11, "Accessing-the-SQuADDS-Database-using-the-HuggingFace-API"]], "Using the SQuADDS API to access and anlyze the database": [[11, "Using-the-SQuADDS-API-to-access-and-anlyze-the-database"]], "Making Systems out of Circuit QED Elements": [[11, "Making-Systems-out-of-Circuit-QED-Elements"]], "Querying for the a target qubit design": [[11, "Querying-for-the-a-target-qubit-design"]], "Querying for a target cavity design": [[11, "Querying-for-a-target-cavity-design"]], "Querying for a target qubit-cavity design": [[11, "Querying-for-a-target-qubit-cavity-design"]], "Simulating the \u201cbest-guess\u201d design": [[11, "Simulating-the-%22best-guess%22-design"]], "Next Steps\u2026": [[11, "Next-Steps..."]], "License": [[11, "License"], [12, "License"]], "Tutorial 2: Contributing to SQuADDS": [[12, "Tutorial-2:-Contributing-to-SQuADDS"]], "Contribution Information Setup": [[12, "Contribution-Information-Setup"]], "Understanding the terminology and database structure": [[12, "Understanding-the-terminology-and-database-structure"]], "Where we left of in Tutorial 1 - Contributing to an existing configuration": [[12, "Where-we-left-of-in-Tutorial-1---Contributing-to-an-existing-configuration"]], "How to contribute to an existing configuration:": [[12, "How-to-contribute-to-an-existing-configuration:"]], "Contributing a New Configuration": [[12, "Contributing-a-New-Configuration"]], "Data Processing:": [[12, "Data-Processing:"]], "How to contribute a new configuration:": [[12, "How-to-contribute-a-new-configuration:"]], "Building on top of others works": [[12, "Building-on-top-of-others-works"]], "Tutorials": [[13, "tutorials"]]}, "indexentries": {"create_mailto_link() (in module squadds.core.utils)": [[9, "squadds.core.utils.create_mailto_link"]], "module": [[9, "module-squadds.core"], [9, "module-squadds.core.globals"], [9, "module-squadds.core.utils"]], "send_email_via_client() (in module squadds.core.utils)": [[9, "squadds.core.utils.send_email_via_client"]], "set_huggingface_api_key() (in module squadds.core.utils)": [[9, "squadds.core.utils.set_huggingface_api_key"]], "squadds.core": [[9, "module-squadds.core"]], "squadds.core.globals": [[9, "module-squadds.core.globals"]], "squadds.core.utils": [[9, "module-squadds.core.utils"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["apidocs/index", "developer/index", "getting_started", "index", "modules", "references/index", "release_notes", "setup", "squadds", "squadds.core", "squadds.database", "tutorials/Tutorial-1_getting_started_with_SQuADDS", "tutorials/Tutorial-2_Contributing_to_SQuADDS", "tutorials/index"], "filenames": ["apidocs/index.rst", "developer/index.rst", "getting_started.rst", "index.rst", "modules.rst", "references/index.rst", "release_notes.rst", "setup.rst", "squadds.rst", "squadds.core.rst", "squadds.database.rst", "tutorials/Tutorial-1_getting_started_with_SQuADDS.ipynb", "tutorials/Tutorial-2_Contributing_to_SQuADDS.ipynb", "tutorials/index.rst"], "titles": ["API Reference", "Developer Notes", "Getting Started with SQuADDS", "Welcome to SQuADDS\u2019s documentation!", "SQuADDS", "References", "Release Notes", "setup module", "squadds package", "squadds.core package", "squadds.database package", "Tutorial 1: Getting Started with SQuADDS", "Tutorial 2: Contributing to SQuADDS", "Tutorials"], "terms": {"0": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13], "1": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 13], "thi": [0, 3, 11, 12], "section": [0, 1], "provid": [0, 1, 3, 11, 12], "detail": 0, "document": [0, 1], "all": [0, 12], "modul": [0, 3, 4], "class": [0, 3], "function": 0, "other": 0, "member": 0, "squadd": [0, 1, 13], "project": 0, "setup": [0, 4, 11], "packag": [0, 4, 5, 6, 11, 12], "everyon": 1, "i": [1, 3, 11, 12], "welcom": 1, "pleas": [1, 3, 11], "see": 1, "review": [1, 5, 12], "follow": [1, 11, 12], "more": [1, 12], "inform": [1, 5], "contact": 1, "u": 1, "bug": 1, "report": 1, "ani": [1, 11, 12], "you": [1, 2, 3, 11, 12], "find": [1, 12], "code": [1, 11, 12], "open": [1, 3, 5], "an": [1, 3, 5], "issu": 1, "github": [1, 2, 5], "featur": [1, 11], "request": [1, 12], "If": [1, 3, 12], "have": [1, 11, 12], "idea": 1, "new": [1, 3, 5], "pull": [1, 12], "we": [1, 11], "from": [1, 2, 3, 5, 11, 12], "commun": 1, "submit": 1, "patient": 1, "your": [1, 2, 3, 11, 12], "work": [1, 3, 11], "question": 1, "about": [1, 12], "typo": 1, "error": 1, "implement": [1, 3, 6], "next": 1, "releas": [1, 12], "would": 1, "like": 1, "help": [1, 12], "version": 1, "look": 1, "what": [1, 11], "sadman": [1, 3, 11, 12], "ahm": [1, 3, 11, 12], "shanto": [1, 3, 11, 12], "univers": 1, "southern": 1, "california": 1, "eli": [1, 3, 11, 12], "levenson": [1, 3, 11, 12], "falk": [1, 3, 11, 12], "etern": 1, "guidanc": 1, "andr": [1, 3, 11], "kuo": [1, 3, 11], "clark": [1, 3], "miyamoto": [1, 3], "york": 1, "madison": 1, "howard": 1, "institut": [1, 11, 12], "technologi": [1, 5], "hunter": 1, "can": [2, 11, 12], "us": [2, 3, 12], "pip": [2, 11, 12], "altern": 2, "sourc": [2, 3, 5, 11, 12], "clone": [2, 12], "repositori": [2, 3, 12], "navig": [2, 12], "chosen": [2, 11, 12], "directori": [2, 11, 12], "cd": 2, "repo": [2, 12], "path": 2, "git": [2, 12], "http": [2, 5, 12], "com": [2, 5], "shanto268": 2, "depend": [2, 12], "activ": 2, "qiskit": [2, 5, 11], "metal": [2, 5, 11], "conda": 2, "environ": [2, 11], "env": [2, 11, 12], "platform": [3, 11], "aim": 3, "speed": 3, "up": [3, 11], "loop": 3, "creation": 3, "quantum": [3, 5], "hardwar": 3, "tool": [3, 11, 12], "bridg": 3, "gap": 3, "between": 3, "theoret": 3, "practic": [3, 12], "research": 3, "engin": [3, 5], "well": 3, "character": [3, 5], "start": 3, "point": 3, "develop": [3, 11, 12], "enabl": [3, 11], "rapid": 3, "gener": [3, 12], "best": [3, 12], "guess": 3, "valid": 3, "pre": [3, 6], "underpin": 3, "vast": 3, "experiment": [3, 5], "paramet": [3, 11, 12], "lower": 3, "barrier": 3, "entri": [3, 12], "group": [3, 5, 11, 12], "seek": 3, "make": [3, 12], "them": 3, "which": 3, "refin": 3, "hi": 3, "support": 3, "its": 3, "continu": 3, "mainten": 3, "cite": 3, "our": [3, 6, 11], "thank": 3, "articl": 3, "titl": 3, "A": [3, 5], "workflow": 3, "author": 3, "haimeng": 3, "zhang": [3, 5], "vivek": 3, "maurya": [3, 5], "evangelo": 3, "vlacho": 3, "malida": 3, "hecht": 3, "chung": 3, "wa": 3, "shum": 3, "journal": [3, 5], "arxiv": [3, 5], "preprint": 3, "year": 3, "2023": [3, 5, 11, 12], "index": 3, "search": 3, "page": [3, 11], "subpackag": 4, "core": [4, 8, 11], "submodul": [4, 8], "global": [4, 8], "util": [4, 8, 11], "content": 4, "databas": [4, 6, 8], "checker": [4, 8], "config": [4, 8, 11], "contributor": [4, 8, 11, 12], "db": [4, 8, 11], "reader": [4, 8], "avail": [5, 11], "org": 5, "hug": [5, 12], "face": [5, 12], "huggingfac": [5, 6, 12], "co": [5, 12], "minev": 5, "et": 5, "al": 5, "energi": 5, "particip": 5, "quantiz": 5, "josephson": 5, "circuit": [5, 12], "npj": 5, "vol": 5, "7": [5, 11], "pp": 5, "131": 5, "2021": 5, "natur": 5, "publish": 5, "uk": 5, "london": 5, "electrodynam": 5, "cqed": 5, "modular": 5, "quasi": 5, "lump": 5, "model": [5, 11], "2103": 5, "10344": 5, "quant": 5, "ph": 5, "yuan": 5, "comparison": 5, "oscil": 5, "ratio": 5, "method": 5, "design": [5, 6, 12], "two": 5, "dimension": 5, "superconduct": 5, "chip": 5, "entropi": 5, "24": 5, "6": [5, 11], "792": 5, "2022": 5, "mdpi": 5, "awslab": 5, "palac": 5, "3d": 5, "finit": 5, "element": [5, 12], "solver": [5, 11], "comput": 5, "electromagnet": 5, "koch": 5, "charg": 5, "insensit": 5, "qubit": 5, "deriv": [5, 11, 12], "cooper": 5, "pair": 5, "box": 5, "physic": 5, "76": 5, "4": [5, 11], "042319": 5, "2007": 5, "ap": 5, "yan": 5, "framework": 5, "optim": 5, "2020": 5, "2006": 5, "04130": 5, "krantz": 5, "": [5, 11, 12], "guid": [5, 12], "appli": 5, "2": [5, 11, 13], "2019": 5, "aip": 5, "groszkowski": 5, "j": 5, "scqubit": 5, "python": [5, 12], "5": [5, 11], "583": 5, "verein": 5, "zur": 5, "f\u00f6rderung": 5, "de": 5, "access": 5, "publizieren": 5, "den": 5, "quantenwissenschaften": 5, "aumann": 5, "circuitq": 5, "toolbox": 5, "9": 5, "093012": 5, "iop": 5, "nois": 5, "suppress": 5, "through": [5, 11], "demand": 5, "caviti": [5, 6], "cool": 5, "control": 5, "bulletin": 5, "american": 5, "societi": 5, "liu": 5, "dissip": 5, "On": [5, 12], "shillito": 5, "dynam": 5, "transmon": 5, "ioniz": 5, "18": 5, "3": [5, 11], "034031": 5, "besedin": 5, "p": 5, "menushenkov": 5, "qualiti": 5, "factor": 5, "transmiss": 5, "line": 5, "coupl": 5, "coplanar": 5, "waveguid": 5, "reson": 5, "epj": 5, "16": 5, "2018": 5, "springeropen": 5, "mcdaniel": 5, "simul": [5, 6, 12], "guidelin": [5, 12], "wideband": 5, "ground": 5, "back": [5, 12], "ieee": 5, "20th": 5, "wireless": 5, "microwav": 5, "confer": 5, "wamicon": 5, "driven": 5, "reset": 5, "2310": 5, "16785": 5, "cond": 5, "mat": 5, "tanamoto": 5, "classic": 5, "spice": 5, "express": 5, "034501": 5, "huang": 5, "machin": [5, 12], "learn": [5, 11], "electron": 5, "autom": 5, "survei": 5, "acm": 5, "transact": 5, "system": 5, "26": 5, "46": 5, "jiang": 5, "deep": 5, "neural": 5, "network": 5, "evalu": 5, "photon": 5, "devic": [5, 11, 12], "materi": 5, "8": [5, 11], "679": 5, "700": 5, "feng": 5, "artifici": 5, "aid": 5, "The": [5, 11, 12], "state": 5, "art": 5, "theori": 5, "techniqu": 5, "70": 5, "11": 5, "4597": 5, "4619": 5, "nov": 5, "nugraha": 5, "q": 5, "shao": 5, "base": [5, 6], "predict": 5, "march": 5, "meet": 5, "la": 5, "vega": 5, "nevada": 5, "10": [5, 11], "virtual": 5, "20": [5, 11], "22": 5, "b73": 5, "00007": 5, "multivalu": 5, "invers": 5, "applic": 5, "filter": 5, "66": 5, "3781": 5, "3797": 5, "aug": 5, "willsch": 5, "observ": 5, "harmon": 5, "tunnel": 5, "junction": 5, "2302": 5, "09192": 5, "sep": 5, "kerman": 5, "effici": 5, "numer": 5, "complex": 5, "2010": 5, "14929": 5, "menk": 5, "Its": 5, "local": [5, 12], "coupler": [5, 6, 11], "mar": 5, "rajabzadeh": 5, "analysi": 5, "arbitrari": 5, "accompani": 5, "sqcircuit": 5, "1118": 5, "mvp": 6, "host": [6, 11], "data": [6, 11], "transmoncross": [6, 11], "claw": 6, "onli": [6, 12], "closest": [6, 11], "interpol": [6, 11], "retriev": 6, "logic": 6, "paper": 6, "tutori": 6, "basic": [6, 11, 12], "usag": [6, 11], "contribut": [6, 11, 13], "ad": [6, 12], "pypi": 6, "creat": [6, 12], "In": [11, 12], "walk": 11, "some": [11, 12], "By": 11, "end": 11, "abl": 11, "hamiltonian": 11, "em": 11, "34": 11, "load_ext": [11, 12], "autoreload": [11, 12], "extens": [11, 12], "alreadi": [11, 12], "load": [11, 12], "To": [11, 12], "reload": [11, 12], "reload_ext": [11, 12], "35": 11, "instal": [11, 12], "e": [11, 12], "obtain": [11, 12], "file": [11, 12], "user": [11, 12], "lfl": [11, 12], "prepar": [11, 12], "metadata": 11, "py": [11, 12], "done": [11, 12], "collect": [11, 12], "attempt": [11, 12], "uninstal": [11, 12], "found": [11, 12], "exist": 11, "successfulli": [11, 12], "run": [11, 12], "sinc": 11, "need": [11, 12], "kei": 11, "compani": 11, "larg": 11, "number": 11, "nlp": 11, "dataset": [11, 12], "thei": [11, 12], "also": 11, "own": 11, "instruct": 11, "here": 11, "sign": 11, "onc": 11, "set": 11, "updat": [11, 12], "huggingface_api_kei": 11, "variabl": [11, 12], "execut": [11, 12], "import": [11, 12], "set_huggingface_api_kei": 11, "command": [11, 12], "termin": 11, "cli": 11, "prompt": 11, "enter": 11, "usernam": 11, "password": 11, "log": 11, "check": 11, "statu": 11, "whoami": 11, "librari": [11, 12], "37": 11, "get_dataset_config_nam": 11, "load_dataset": 11, "squadds_db": [11, 12], "39": 11, "compon": 11, "component_nam": 11, "data_typ": 11, "append": [11, 12], "split": 11, "print": 11, "cavity_claw": 11, "routermeand": 11, "ncap": 11, "cap_matrix": 11, "eigenmod": 11, "qubit_data": 11, "while": 11, "possibl": 11, "directli": 11, "simpl": 11, "easier": 11, "161": 11, "162": 11, "83": 11, "view_dataset": 11, "name": [11, 12], "routemeand": 11, "88": 11, "get_dataset_info": 11, "pi": [11, 12], "valu": 11, "dtype": 11, "string": 11, "id": 11, "none": 11, "date_cr": [11, 12], "upload": [11, 12], "design_opt": [11, 12], "design_tool": [11, 12], "note": [11, 12], "sim_opt": [11, 12], "renderer_opt": 11, "sim_result": [11, 12], "claw_to_claw": 11, "float64": 11, "claw_to_ground": 11, "cross_to_claw": 11, "cross_to_cross": 11, "cross_to_ground": 11, "ground_to_ground": 11, "unit": [11, 12], "descript": [11, 12], "citat": 11, "homepag": 11, "size": 11, "byte": 11, "9700839": 11, "87": 11, "coupler_typ": 11, "cavity_frequ": 11, "kappa": 11, "879111": 11, "205": 11, "get_dataset": 11, "aedt_hfss_capacit": 11, "aedt_hfss_induct": 11, "phd": 11, "09": 11, "142547": 11, "usc": 11, "94": 11, "97421": 11, "90": 11, "86585": 11, "73363": 11, "158": 11, "40783": 11, "311": 11, "25590": 11, "nh": 11, "cj": 11, "lj": 11, "10nh": 11, "_rj": 11, "design_nam": 11, "auto_increase_solution_ord": 11, "true": 11, "ansi": 11, "hfss": 11, "25": 11, "153123": 11, "82": 11, "44280": 11, "79": 11, "19378": 11, "93820": 11, "188": 11, "15089": 11, "333": 11, "52997": 11, "76412": 11, "80": 11, "18130": 11, "16131": 11, "104": 11, "35340": 11, "237": 11, "02548": 11, "153126": 11, "103": 11, "37057": 11, "97": 11, "22405": 11, "77590": 11, "174": 11, "13928": 11, "335": 11, "31609": 11, "68": 11, "92854": 11, "65": 11, "68607": 11, "87375": 11, "120": 11, "03923": 11, "240": 11, "34085": 11, "1929": 11, "106": 11, "43025": 11, "101": 11, "53197": 11, "45645": 11, "46380": 11, "340": 11, "62919": 11, "1930": 11, "142549": 11, "121": 11, "10943": 11, "112": 11, "62570": 11, "95178": 11, "187": 11, "43537": 11, "367": 11, "34003": 11, "1931": 11, "144": 11, "56289": 11, "136": 11, "36810": 11, "65968": 11, "172": 11, "14561": 11, "372": 11, "39970": 11, "1932": 11, "76413": 11, "78116": 11, "48795": 11, "56": 11, "75230": 11, "166": 11, "57383": 11, "1933": 11, "58": 11, "45749": 11, "55": 11, "50796": 11, "54396": 11, "62": 11, "01000": 11, "42140": 11, "1934": 11, "row": 11, "17": [11, 12], "column": 11, "108": 11, "get_config": 11, "109": 11, "view_contributors_of": 11, "view_all_contributor": 11, "249": 11, "select_system": 11, "250": 11, "select_qubit": 11, "251": 11, "selected_system": 11, "252": 11, "df": 11, "selected_system_df": 11, "309": 11, "unselect_al": 11, "310": 11, "select_cavity_claw": 11, "312": 11, "select_coupl": 11, "clt": 11, "313": 11, "show_select": 11, "select": 11, "type": 11, "294": 11, "claw_opt": 11, "connection_pad": 11, "readout": 11, "12": 11, "01": 11, "170608": 11, "353550e": 11, "161106": 11, "598429": 11, "hz": 11, "basis_ord": 11, "max_delta_f": 11, "05": 11, "max_p": 11, "04": 11, "124953": 11, "399241e": 11, "268412": 11, "116632": 11, "204334": 11, "694845e": 11, "255873": 11, "654612": 11, "08": 11, "173545": 11, "616574e": 11, "30459": 11, "761161": 11, "986835e": 11, "208304": 11, "221064": 11, "229": 11, "949469e": 11, "126438": 11, "881378": 11, "230": 11, "805442e": 11, "291439": 11, "656224": 11, "231": 11, "06": 11, "224829": 11, "597444e": 11, "587144": 11, "918000": 11, "232": 11, "116894e": 11, "209744": 11, "544864": 11, "233": 11, "145996e": 11, "155139": 11, "565546": 11, "234": 11, "13": 11, "314": 11, "315": 11, "316": 11, "let": 11, "do": [11, 12], "quick": 11, "recap": 11, "got": 11, "how": 11, "part": [11, 12], "copyright": [11, 12], "under": [11, 12], "mit": [11, 12], "mayobtain": [11, 12], "copi": [11, 12], "txt": [11, 12], "root": [11, 12], "tree": [11, 12], "modif": [11, 12], "must": [11, 12], "retain": [11, 12], "thiscopyright": [11, 12], "notic": [11, 12], "modifi": [11, 12], "carri": [11, 12], "indicatingthat": [11, 12], "been": [11, 12], "alter": [11, 12], "origin": [11, 12], "go": 12, "over": 12, "cover": 12, "topic": 12, "node": 12, "86": 12, "14": 12, "order": 12, "yourself": 12, "track": 12, "give": 12, "credit": 12, "group_nam": 12, "pi_nam": 12, "user_nam": 12, "Or": 12, "cell": 12, "create_contributor_info": 12, "format": 12, "result": 12, "compat": 12, "fork": 12, "so": 12, "checkout": 12, "branch": 12, "might": 12, "b": 12, "add_to_configur": 12, "add": 12, "necessari": 12, "sure": 12, "maintain": 12, "specif": 12, "requir": 12, "commit": 12, "push": 12, "chang": 12, "m": 12, "y": 12, "against": 12, "show": 12, "pr": 12, "mai": 12, "possess": 12, "current": 12, "includ": 12, "case": 12, "But": 12, "befor": 12, "refer": 12, "want": 12, "json": 12, "AT": 12, "least": 12, "field": 12, "mani": 12, "supplementari": 12, "design_tool_nam": 12, "sim_setup_opt": 12, "simulator_nam": 12, "result1": 12, "sim_result1": 12, "unit1": 12, "result2": 12, "sim_result2": 12, "unit2": 12, "yyyi": 12, "mm": 12, "dd": 12, "hhmmss": 12, "ha": 12, "same": 12, "just": 12, "instead": 12, "repeat": 12, "each": 12, "should": 12, "measur": 12, "portion": 12, "custom": 12, "futur": 12, "hub": 12, "your_usernam": 12, "dataset_nam": 12, "It": 12, "good": 12, "new_configur": 12, "involv": 12, "ones": 12, "builder": 12, "script": 12, "defin": 12, "clear": 12, "messag": 12, "x": 12, "without": 12, "handl": 12}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"api": [0, 11], "refer": [0, 5], "develop": 1, "note": [1, 6], "contribut": [1, 12], "item": 1, "contributor": [1, 10], "get": [2, 11], "start": [2, 11], "squadd": [2, 3, 4, 8, 9, 10, 11, 12], "instal": 2, "faq": 2, "welcom": 3, "": 3, "document": 3, "overview": 3, "superconduct": 3, "qubit": [3, 11], "And": 3, "devic": 3, "design": [3, 11], "simul": [3, 11], "databas": [3, 10, 11, 12], "citat": 3, "indic": 3, "tabl": 3, "releas": 6, "version": 6, "0": 6, "1": [6, 11, 12], "2023": 6, "12": 6, "20": 6, "setup": [7, 12], "modul": [7, 8, 9, 10], "packag": [8, 9, 10], "subpackag": 8, "content": [8, 9, 10], "core": 9, "submodul": [9, 10], "global": 9, "util": [9, 10], "checker": 10, "config": 10, "db": 10, "reader": 10, "tutori": [11, 12, 13], "huggingfac": 11, "creat": 11, "an": [11, 12], "account": 11, "login": 11, "access": 11, "us": 11, "anlyz": 11, "make": 11, "system": 11, "out": 11, "circuit": 11, "qed": 11, "element": 11, "queri": 11, "target": 11, "caviti": 11, "best": 11, "guess": 11, "next": 11, "step": 11, "licens": [11, 12], "2": 12, "inform": 12, "understand": 12, "terminologi": 12, "structur": 12, "where": 12, "we": 12, "left": 12, "exist": 12, "configur": 12, "how": 12, "new": 12, "data": 12, "process": 12, "metadata": 12, "build": 12, "top": 12, "other": 12, "work": 12}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "nbsphinx": 4, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"API Reference": [[0, "api-reference"]], "Developer Notes": [[1, "developer-notes"]], "Contribution Items": [[1, "contribution-items"]], "Developers": [[1, "developers"]], "Contributors": [[1, "contributors"]], "Getting Started with SQuADDS": [[2, "getting-started-with-squadds"]], "Installation": [[2, "installation"]], "FAQ": [[2, "faq"]], "Welcome to SQuADDS\u2019s documentation!": [[3, "welcome-to-squadds-s-documentation"]], "Overview": [[3, "overview"]], "SQuADDS: a Superconducting Qubit And Device Design and Simulation database": [[3, "squadds-a-superconducting-qubit-and-device-design-and-simulation-database"]], "Citation": [[3, "citation"]], "Indices and tables": [[3, "indices-and-tables"]], "SQuADDS": [[4, "squadds"]], "References": [[5, "references"]], "Release Notes": [[6, "release-notes"]], "Version 0.1.0 (2023-12-20)": [[6, "version-0-1-0-2023-12-20"]], "setup module": [[7, "setup-module"]], "squadds package": [[8, "squadds-package"]], "Subpackages": [[8, "subpackages"]], "Module contents": [[8, "module-contents"], [9, "module-contents"], [10, "module-contents"]], "squadds.core package": [[9, "squadds-core-package"]], "Submodules": [[9, "submodules"], [10, "submodules"]], "squadds.core.globals module": [[9, "squadds-core-globals-module"]], "squadds.core.utils module": [[9, "squadds-core-utils-module"]], "squadds.database package": [[10, "squadds-database-package"]], "squadds.database.checker module": [[10, "squadds-database-checker-module"]], "squadds.database.config module": [[10, "squadds-database-config-module"]], "squadds.database.contributor module": [[10, "squadds-database-contributor-module"]], "squadds.database.db module": [[10, "squadds-database-db-module"]], "squadds.database.reader module": [[10, "squadds-database-reader-module"]], "squadds.database.utils module": [[10, "squadds-database-utils-module"]], "Tutorial 1: Getting Started with SQuADDS": [[11, "Tutorial-1:-Getting-Started-with-SQuADDS"]], "HuggingFace \ud83e\udd17": [[11, "HuggingFace-\ud83e\udd17"]], "Creating an Account": [[11, "Creating-an-Account"]], "Login": [[11, "Login"]], "Accessing the SQuADDS Database using the HuggingFace API": [[11, "Accessing-the-SQuADDS-Database-using-the-HuggingFace-API"]], "Using the SQuADDS API to access and anlyze the database": [[11, "Using-the-SQuADDS-API-to-access-and-anlyze-the-database"]], "Making Systems out of Circuit QED Elements": [[11, "Making-Systems-out-of-Circuit-QED-Elements"]], "Querying for the a target qubit design": [[11, "Querying-for-the-a-target-qubit-design"]], "Querying for a target cavity design": [[11, "Querying-for-a-target-cavity-design"]], "Querying for a target qubit-cavity design": [[11, "Querying-for-a-target-qubit-cavity-design"]], "Simulating the \u201cbest-guess\u201d design": [[11, "Simulating-the-%22best-guess%22-design"]], "Next Steps\u2026": [[11, "Next-Steps..."]], "License": [[11, "License"], [12, "License"]], "Tutorial 2: Contributing to SQuADDS": [[12, "Tutorial-2:-Contributing-to-SQuADDS"]], "Contribution Information Setup": [[12, "Contribution-Information-Setup"]], "Understanding the terminology and database structure": [[12, "Understanding-the-terminology-and-database-structure"]], "Where we left of in Tutorial 1 - Contributing to an existing configuration": [[12, "Where-we-left-of-in-Tutorial-1---Contributing-to-an-existing-configuration"]], "How to contribute to an existing configuration:": [[12, "How-to-contribute-to-an-existing-configuration:"]], "Contributing a New Configuration": [[12, "Contributing-a-New-Configuration"]], "Data Processing:": [[12, "Data-Processing:"]], "Metadata:": [[12, "Metadata:"]], "How to contribute a new configuration:": [[12, "How-to-contribute-a-new-configuration:"]], "Building on top of others works": [[12, "Building-on-top-of-others-works"]], "Tutorials": [[13, "tutorials"]]}, "indexentries": {}}) \ No newline at end of file diff --git a/squadds.core.html b/squadds.core.html index b8b979ae..2e877442 100644 --- a/squadds.core.html +++ b/squadds.core.html @@ -151,63 +151,14 @@

        squadds.core package

        Submodules

        -
        -

        squadds.core.globals module

        +
        +

        squadds.core.globals module

        -
        -

        squadds.core.utils module

        -
        - -

        Create a mailto link with the given recipients, subject, and body.

        -
        -
        Parameters:
        -
          -

        • recipients (list) – A list of email addresses of the recipients.

          • -

        • subject (str) – The subject of the email.

          • -

        • body (str) – The body of the email.

          • -
        -
        -
        Returns:
        -

        The generated mailto link.

        -
        -
        Return type:
        -

        str

        -
        -
        -
        - -
        -
        -squadds.core.utils.send_email_via_client(dataset_name, institute, pi_name, date, dataset_link)[source]
        -

        Sends an email notification to recipients with the details of the created dataset.

        -
        -
        Parameters:
        -
          -

        • dataset_name (str) – The name of the dataset.

          • -

        • institute (str) – The name of the institute where the dataset was created.

          • -

        • pi_name (str) – The name of the principal investigator who created the dataset.

          • -

        • date (str) – The date when the dataset was created.

          • -

        • dataset_link (str) – The link to the created dataset.

          • -
        -
        -
        Returns:
        -

        None

        -
        -
        -
        - -
        -
        -squadds.core.utils.set_huggingface_api_key()[source]
        -

        Sets the Hugging Face API key by appending it to the .env file. -If the API key already exists in the .env file, it does not add it again. -If the Hugging Face token is not found, it raises a ValueError.

        -
        - +
        +

        squadds.core.utils module

        -
        -

        Module contents

        +
        +

        Module contents

        @@ -265,14 +216,9 @@

        Submodulessquadds.core package

      diff --git a/squadds.html b/squadds.html index 3eb6411e..ef94aee2 100644 --- a/squadds.html +++ b/squadds.html @@ -152,14 +152,9 @@

      Subpackagessquadds.core package

    • squadds.database package
        diff --git a/tutorials/Tutorial-1_getting_started_with_SQuADDS.html b/tutorials/Tutorial-1_getting_started_with_SQuADDS.html index 9470f750..47cf2177 100644 --- a/tutorials/Tutorial-1_getting_started_with_SQuADDS.html +++ b/tutorials/Tutorial-1_getting_started_with_SQuADDS.html @@ -761,7 +761,7 @@

        Making Systems out of Circuit QED Elements

        Querying for the a target qubit design

        -
        [183]:
+
        [249]:
 
        
 
        
 
        db.select_system("qubit")
@@ -769,7 +769,7 @@ 
        Querying for the a target qubit design
-
        [184]:
+
        [250]:
 
        
 
        
 
        db.select_qubit("TransmonCross")
@@ -777,7 +777,7 @@ 
        Querying for the a target qubit design
-
        [173]:
+
        [251]:
 
        
 
        
 
        db.selected_system
@@ -785,7 +785,7 @@ 
        Querying for the a target qubit design
-
        [173]:
+
        [251]:
 
        
 
        
 
        
@@ -794,7 +794,7 @@ 
        Querying for the a target qubit design
-
        [204]:
+
        [252]:
 
        
 
        
 
        df = db.selected_system_df()
@@ -803,7 +803,7 @@ 
        Querying for the a target qubit design
-
        [204]:
+
        [252]:
 
        
 
        
 
        
@@ -1070,63 +1070,79 @@ 
        Querying for the a target qubit design
+
        [ ]:
+
        
+
        
+
        
+
        
+
        
+
        
 
 
        
 
        Querying for a target cavity design
        
 
        
-
        [206]:
+
        [309]:
 
        
 
        
-
        db.select_system("cavity_claw")
+
        db.unselect_all()
 
        
 
        
 
        
 
        
-
        [212]:
+
        [310]:
 
        
 
        
-
        db.select_cavity_claw("RouteMeander")
+
        db.select_system("cavity_claw")
 
        
 
        
 
        
 
        
-
        [219]:
+
        [311]:
 
        
 
        
-
        db.select_coupler("CLT")
+
        db.select_cavity_claw("RouteMeander")
 
        
 
        
 
        
 
        
-
        [ ]:
+
        [312]:
 
        
 
        
-
        
+
        db.select_coupler("CLT")
 
        
 
        
 
        
-
        
-
        
-
        Querying for a target qubit-cavity design
        
-
        
-
        [154]:
+
        
+
        [313]:
 
        
 
        
-
        db.select_system(["qubit","cavity_claw"])
+
        db.show_selections()
 
        
 
        
 
        
+
        
+
        
+
        
+
        
+
        +Selected component:  cavity_claw
+Selected component name:  RouteMeander
+Selected data type:  eigenmode
+Selected system:  cavity_claw
+Selected coupler:  CLT
+
        
+
        
 
        
-
        [209]:
+
        [294]:
 
        
 
        
-
        df = db.selected_system_df()
-df
+
        db.selected_system_df()
 
        
 
        
 
        
 
        
-
        [209]:
+
        [294]:
 
        
 
        
 
        
@@ -1345,6 +1361,54 @@ 
        Querying for a target qubit-cavity design
+
        [ ]:
+
        
+
        
+
        
+
        
+
        
+
        
+
        
+
        
+
        Querying for a target qubit-cavity design
        
+
        
+
        [314]:
+
        
+
        
+
        db.select_system(["qubit","cavity_claw"])
+
        
+
        
+
        
+
        
+
        [315]:
+
        
+
        
+
        db.select_qubit("TransmonCross")
+db.select_cavity_claw("RouteMeander")
+db.select_coupler("CLT")
+
        
+
        
+
        
+
        
+
        [316]:
+
        
+
        
+
        db.show_selections()
+
        
+
        
+
        
+
        
+
        
+
        
+
        
+
        +Selected qubit:  TransmonCross
+Selected cavity:  RouteMeander
+Selected coupler:  CLT
+Selected system:  ['qubit', 'cavity_claw']
+
        
+
        
 
        
 
        
 
        Simulating the “best-guess” design
        
diff --git a/tutorials/Tutorial-1_getting_started_with_SQuADDS.ipynb b/tutorials/Tutorial-1_getting_started_with_SQuADDS.ipynb
index f2de987e..cf5a50aa 100644
--- a/tutorials/Tutorial-1_getting_started_with_SQuADDS.ipynb
+++ b/tutorials/Tutorial-1_getting_started_with_SQuADDS.ipynb
@@ -766,7 +766,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 183,
+   "execution_count": 249,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -775,7 +775,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 184,
+   "execution_count": 250,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -784,7 +784,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 173,
+   "execution_count": 251,
    "metadata": {},
    "outputs": [
     {
@@ -793,7 +793,7 @@
        "'qubit'"
       ]
      },
-     "execution_count": 173,
+     "execution_count": 251,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -804,7 +804,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 204,
+   "execution_count": 252,
    "metadata": {},
    "outputs": [
     {
@@ -1155,7 +1155,7 @@
        "[1934 rows x 17 columns]"
       ]
      },
-     "execution_count": 204,
+     "execution_count": 252,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -1165,6 +1165,13 @@
     "df"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -1174,57 +1181,64 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 206,
+   "execution_count": 309,
    "metadata": {},
    "outputs": [],
    "source": [
-    "db.select_system(\"cavity_claw\")"
+    "db.unselect_all()"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 212,
+   "execution_count": 310,
    "metadata": {},
    "outputs": [],
    "source": [
-    "db.select_cavity_claw(\"RouteMeander\")"
+    "db.select_system(\"cavity_claw\")"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 219,
+   "execution_count": 311,
    "metadata": {},
    "outputs": [],
    "source": [
-    "db.select_coupler(\"CLT\")"
+    "db.select_cavity_claw(\"RouteMeander\")"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 312,
    "metadata": {},
    "outputs": [],
-   "source": []
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
    "source": [
-    "### Querying for a target qubit-cavity design"
+    "db.select_coupler(\"CLT\")"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 154,
+   "execution_count": 313,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Selected component:  cavity_claw\n",
+      "Selected component name:  RouteMeander\n",
+      "Selected data type:  eigenmode\n",
+      "Selected system:  cavity_claw\n",
+      "Selected coupler:  CLT\n"
+     ]
+    }
+   ],
    "source": [
-    "db.select_system([\"qubit\",\"cavity_claw\"])"
+    "db.show_selections()"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 209,
+   "execution_count": 294,
    "metadata": {},
    "outputs": [
     {
@@ -1501,14 +1515,67 @@
        "[234 rows x 13 columns]"
       ]
      },
-     "execution_count": 209,
+     "execution_count": 294,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "df = db.selected_system_df()\n",
-    "df"
+    "db.selected_system_df()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Querying for a target qubit-cavity design"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 314,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "db.select_system([\"qubit\",\"cavity_claw\"])"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 315,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "db.select_qubit(\"TransmonCross\")\n",
+    "db.select_cavity_claw(\"RouteMeander\")\n",
+    "db.select_coupler(\"CLT\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 316,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Selected qubit:  TransmonCross\n",
+      "Selected cavity:  RouteMeander\n",
+      "Selected coupler:  CLT\n",
+      "Selected system:  ['qubit', 'cavity_claw']\n"
+     ]
+    }
+   ],
+   "source": [
+    "db.show_selections()"
    ]
   },
   {
diff --git a/tutorials/Tutorial-2_Contributing_to_SQuADDS.html b/tutorials/Tutorial-2_Contributing_to_SQuADDS.html
index 8ce0afe0..8b00d51f 100644
--- a/tutorials/Tutorial-2_Contributing_to_SQuADDS.html
+++ b/tutorials/Tutorial-2_Contributing_to_SQuADDS.html
@@ -232,19 +232,12 @@ 
        Understanding the terminology and database structure
        Structure of SQuADDS_DB
        
 
      • Adding to SQuADDS_DB
        •

      -
      -
      [ ]:
-
      -
      -
      
-
      -
      -

      Where we left of in Tutorial 1 - Contributing to an existing configuration

      +

      Format the result from Tutorial 1 to be compatible with SQuADDS.

      -
      [ ]:
+
      [2]:
 
      
 
      
 
      
@@ -271,6 +264,21 @@ 
      How to contribute to an existing configuration:
+
      Show how to add this new data entry to the SQuADDS database by creating a PR.
      
+
        
+
      1. Code to fork the repo and create a new branch.
        2. 
+
      2. Code to add the new data to the chosen configuration.
        3. 
+
      3. Code to commit and push the changes.
        4. 
+
      4. Code to create a PR.
        5. 
+
      
+
      
+
      [ ]:
+
      
+
      
+
      
+
      
+
      
+
      @@ -306,6 +314,21 @@

      Data Processing:sim_results has the same units you can just use a "units":units field instead of repeating the unit for each result.

      +

      +
      +

      Metadata:

      +

      The metadata for the configuration should include

      +
        +

      • the name of the configuration

        • +

      • a description of the configuration

        • +

      • contributors to the configuration

        • +

      • device design, design tool and name

        • +

      • simulation setup and simulator name

        • +

      • simulation code Simulator

        • +

      • simulation result parameters

        • +

      • measured parameters

        • +
      +

      Code to help generate portions of the metadata and guide the user to create custom Simulator (future release and tutorial)

      [ ]:
      @@ -343,6 +366,14 @@

      How to contribute a new configuration: +

    • Code to fork the repo and create a new branch.

      • +

    • Code to add the new data to a new configuration.

      • +

    • Code to add metadata to the configuration.

      • +

    • Code to commit and push the changes.

      • +

    • Code to create a PR.

      • + 
      [ ]:
      @@ -356,6 +387,16 @@

      How to contribute a new configuration:

      Building on top of others works

      We might have some data that can be appended to an existing dataset in SQuADDS. In this case, we can add to the existing configuration in SQuADDS_DB without pushing new entries to the original dataset.

      +
        +

      1. Code to fork the repo and create a new branch.

        2. +

      2. Code to add the new data to the chosen configuration.

        +
          +

        • handling contributions (appending code gives uploader name and institute only and notes)

          • +
        +
        3. +

      3. Code to commit and push the changes.

        4. +

      4. Code to create a PR.

        5. +
      [ ]:
      @@ -436,6 +477,7 @@

      License

    • Contributing a New Configuration
      • diff --git a/tutorials/Tutorial-2_Contributing_to_SQuADDS.ipynb b/tutorials/Tutorial-2_Contributing_to_SQuADDS.ipynb index f80d123b..c21e8098 100644 --- a/tutorials/Tutorial-2_Contributing_to_SQuADDS.ipynb +++ b/tutorials/Tutorial-2_Contributing_to_SQuADDS.ipynb @@ -115,23 +115,18 @@ "- Adding to SQuADDS_DB" ] }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [] - }, { "cell_type": "markdown", "metadata": {}, "source": [ - "## Where we left of in Tutorial 1 - *Contributing to an existing configuration* " + "## Where we left of in Tutorial 1 - *Contributing to an existing configuration* \n", + "\n", + "Format the result from Tutorial 1 to be compatible with SQuADDS." ] }, { "cell_type": "code", - "execution_count": null, + "execution_count": 2, "metadata": {}, "outputs": [], "source": [] @@ -165,6 +160,25 @@ "---" ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Show how to add this new data entry to the SQuADDS database by creating a PR. \n", + "\n", + "1. Code to fork the repo and create a new branch.\n", + "2. Code to add the new data to the chosen configuration.\n", + "3. Code to commit and push the changes.\n", + "4. Code to create a PR." + ] + }, + { + "cell_type": "code", + "execution_count": null, + "metadata": {}, + "outputs": [], + "source": [] + }, { "cell_type": "markdown", "metadata": {}, @@ -213,6 +227,31 @@ "If all the `sim_results` has the same units you can just use a `\"units\":units` field instead of repeating the unit for each result." ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "### Metadata:\n", + "\n", + "The metadata for the configuration should include \n", + "\n", + "- the name of the configuration\n", + "- a description of the configuration\n", + "- contributors to the configuration\n", + "- device design, design tool and name\n", + "- simulation setup and simulator name\n", + "- simulation code `Simulator`\n", + "- simulation result parameters\n", + "- measured parameters" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Code to help generate portions of the metadata and guide the user to create custom `Simulator` (future release and tutorial)" + ] + }, { "cell_type": "code", "execution_count": null, @@ -258,6 +297,19 @@ "7. **Create a Pull Request**: Go to the Hugging Face Hub, navigate to your fork, and create a pull request for your new branch. The pull request will be reviewed by the dataset maintainers." ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "Show \n", + "\n", + "1. Code to fork the repo and create a new branch.\n", + "2. Code to add the new data to a new configuration.\n", + "3. Code to add metadata to the configuration.\n", + "4. Code to commit and push the changes.\n", + "5. Code to create a PR." + ] + }, { "cell_type": "code", "execution_count": null, @@ -279,6 +331,17 @@ "We might have some data that can be appended to an existing dataset in SQuADDS. In this case, we can add to the existing configuration in `SQuADDS_DB` without pushing new entries to the original dataset." ] }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "1. Code to fork the repo and create a new branch.\n", + "2. Code to add the new data to the chosen configuration.\n", + " - handling contributions (appending code gives uploader name and institute only and notes)\n", + "3. Code to commit and push the changes.\n", + "4. Code to create a PR." + ] + }, { "cell_type": "code", "execution_count": null,