diff --git a/.buildinfo b/.buildinfo
index 2af21714..7dfedd8c 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: 69bd74117eb5471e37b12f45c4ed163c
+config: 37c07ce07270caeb6c6cb14b689c36bc
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
index cbfb3415..00368c87 100644
--- a/_sources/index.rst.txt
+++ b/_sources/index.rst.txt
@@ -30,7 +30,8 @@ SQuADDS is an open-source platform aimed at speeding up the design loop in the c
 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:
+Hi there! If you use SQuADDS in your research, please support its continued development and maintenance by citing our work. Thank you!
+
 
 .. code-block:: latex
 
diff --git a/index.html b/index.html
index bacd5173..5f152b78 100644
--- a/index.html
+++ b/index.html
@@ -150,7 +150,7 @@ <h2>SQuADDS: a Superconducting Qubit And Device Design and Simulation database<a
 </section>
 <section id="citation">
 <h2>Citation<a class="headerlink" href="#citation" title="Link to this heading">¶</a></h2>
-<p>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:</p>
+<p>Hi there! If you use SQuADDS in your research, please support its continued development and maintenance by citing our work. Thank you!</p>
 <div class="highlight-latex notranslate"><div class="highlight"><pre><span></span>@article<span class="nb">{</span>SQuADDS,
     title=<span class="nb">{</span>SQuADDS: A validated design database and simulation workflow for superconducting qubit design<span class="nb">}</span>,
     author=<span class="nb">{</span>Sadman Ahmed Shanto, Andre Kuo, Clark Miyamoto, Haimeng Zhang, Vivek Maurya, Evangelos Vlachos, Malida Hecht, Chung Wa Shum and Eli Levenson-Falk<span class="nb">}</span>,
diff --git a/searchindex.js b/searchindex.js
index f100348d..36896d1a 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": {"thi": [0, 3, 10, 12], "section": [0, 1], "provid": [0, 1, 3, 12], "detail": [0, 9], "document": [0, 1], "all": [0, 11, 12], "modul": [0, 3, 4, 12], "class": [0, 3, 10], "function": [0, 10], "other": [0, 12], "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, 10, 12], "welcom": 1, "pleas": [1, 3, 11], "see": 1, "review": [1, 5, 12], "follow": [1, 11, 12], "more": [1, 12], "inform": [1, 5, 10], "contact": 1, "u": 1, "bug": 1, "report": 1, "ani": [1, 10, 12], "you": [1, 2, 3, 11, 12], "find": 1, "code": [1, 11, 12], "open": [1, 3, 5, 12], "an": [1, 3, 5, 9], "issu": 1, "github": [1, 2, 5], "featur": [1, 11], "request": [1, 12], "If": [1, 3, 9, 10, 12], "have": [1, 11, 12], "idea": 1, "new": [1, 3, 5, 10], "pull": [1, 12], "we": [1, 12], "from": [1, 2, 3, 5, 10, 11, 12], "commun": 1, "submit": 1, "patient": 1, "your": [1, 2, 3, 11, 12], "work": [1, 12], "question": 1, "about": [1, 12], "typo": 1, "error": 1, "implement": [1, 3, 6, 10], "next": 1, "releas": 1, "would": 1, "like": 1, "help": 1, "version": 1, "look": 1, "In": [1, 12], "http": [1, 2, 5, 12], "com": [1, 2, 5], "shanto268": [1, 2], "tab": 1, "readm": 1, "ov": 1, "file": [1, 9, 10, 11, 12], "sadman": [1, 3], "ahm": [1, 3], "shanto": [1, 3, 11, 12], "univers": 1, "southern": 1, "california": 1, "eli": [1, 3], "levenson": [1, 3], "falk": [1, 3], "etern": 1, "guidanc": 1, "andr": [1, 3], "kuo": [1, 3], "clark": [1, 3], "miyamoto": [1, 3], "york": 1, "madison": 1, "howard": 1, "institut": [1, 9, 10, 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, 10, 12], "clone": [2, 12], "repositori": [2, 3, 10, 12], "navig": [2, 12], "chosen": 2, "directori": [2, 10, 12], "cd": 2, "repo": 2, "path": [2, 10, 12], "git": [2, 12], "depend": [2, 12], "activ": 2, "qiskit": [2, 5, 12], "metal": [2, 5, 12], "conda": 2, "environ": [2, 11], "env": [2, 9, 10, 11, 12], "q": [2, 5], "placehold": 2, "A": [2, 3, 5, 9], "platform": 3, "aim": 3, "speed": 3, "up": [3, 11], "loop": 3, "creation": [3, 10], "quantum": [3, 5], "hardwar": 3, "tool": 3, "bridg": 3, "gap": 3, "between": 3, "theoret": 3, "practic": [3, 12], "research": 3, "engin": [3, 5], "well": 3, "character": [3, 5], "start": [3, 13], "point": 3, "develop": [3, 11, 12], "enabl": 3, "rapid": 3, "gener": [3, 9, 10, 12], "best": [3, 12], "guess": 3, "valid": [3, 10, 12], "pre": [3, 6], "underpin": 3, "vast": 3, "experiment": [3, 5], "paramet": 3, "lower": 3, "barrier": 3, "entri": 3, "group": [3, 5, 10, 11, 12], "seek": 3, "make": [3, 12], "them": 3, "which": 3, "refin": 3, "support": 3, "its": 3, "continu": 3, "mainten": 3, "scqubit": [3, 5], "public": 3, "appropri": 3, "acknowledg": 3, "cite": 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], "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, 12], "databas": [4, 6, 8], "checker": [4, 8], "config": [4, 8, 11, 12], "contributor": [4, 8, 11, 12], "db": [4, 8], "reader": [4, 8], "avail": 5, "org": 5, "hug": [5, 9, 10, 12], "face": [5, 9, 10, 12], "huggingfac": [5, 6, 10, 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, 12], "1": [5, 12, 13], "pp": 5, "131": 5, "2021": 5, "natur": [5, 10], "publish": 5, "uk": 5, "london": 5, "electrodynam": 5, "cqed": 5, "modular": 5, "quasi": 5, "lump": 5, "model": 5, "2103": 5, "10344": 5, "quant": 5, "ph": 5, "yuan": 5, "comparison": 5, "oscil": 5, "ratio": 5, "method": [5, 10], "design": [5, 6, 11, 12], "two": 5, "dimension": 5, "superconduct": 5, "chip": 5, "entropi": 5, "24": 5, "6": 5, "792": 5, "2022": 5, "mdpi": 5, "awslab": 5, "palac": 5, "3d": 5, "finit": 5, "element": [5, 12], "solver": 5, "comput": [5, 12], "electromagnet": 5, "koch": 5, "charg": 5, "insensit": 5, "qubit": [5, 11, 12], "deriv": 5, "cooper": 5, "pair": 5, "box": 5, "physic": 5, "76": 5, "4": [5, 11, 12], "042319": 5, "2007": 5, "ap": 5, "yan": 5, "framework": 5, "optim": 5, "2020": 5, "2006": 5, "04130": 5, "krantz": 5, "": [5, 12], "guid": 5, "appli": 5, "2": [5, 11, 13], "2019": 5, "aip": 5, "groszkowski": 5, "j": 5, "python": [5, 12], "5": 5, "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, "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, 12], "034031": 5, "besedin": 5, "p": 5, "menushenkov": 5, "qualiti": 5, "factor": 5, "transmiss": 5, "line": [5, 12], "coupl": 5, "coplanar": 5, "waveguid": 5, "reson": 5, "epj": 5, "16": 5, "2018": 5, "springeropen": 5, "mcdaniel": 5, "simul": [5, 6, 11, 12], "guidelin": [5, 12], "wideband": 5, "ground": 5, "back": 5, "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, "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, "materi": 5, "8": [5, 12], "679": 5, "700": 5, "feng": 5, "artifici": 5, "aid": 5, "The": [5, 9, 10, 12], "state": 5, "art": 5, "theori": 5, "techniqu": 5, "70": 5, "11": [5, 11], "4597": 5, "4619": 5, "nov": 5, "nugraha": 5, "shao": 5, "base": [5, 6, 10, 12], "predict": 5, "march": 5, "meet": 5, "la": 5, "vega": 5, "nevada": 5, "10": [5, 12], "virtual": 5, "20": 5, "22": [5, 11], "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, 12], "mar": 5, "rajabzadeh": 5, "analysi": 5, "arbitrari": 5, "accompani": 5, "sqcircuit": 5, "1118": 5, "mvp": 6, "host": 6, "data": [6, 10], "transmoncross": [6, 11, 12], "claw": 6, "onli": 6, "closest": 6, "interpol": 6, "retriev": [6, 10], "logic": 6, "our": 6, "paper": 6, "tutori": 6, "basic": 6, "usag": 6, "contribut": [6, 8, 10, 13], "ad": 6, "pypi": 6, "creat": [6, 9, 10, 12], "create_mailto_link": [8, 9], "send_email_via_cli": [8, 9], "set_huggingface_api_kei": [8, 9, 11], "check": [8, 10], "squadds_db_config": [8, 10], "check_for_api_kei": [8, 10], "create_dataset_nam": [8, 10], "create_dataset_repositori": [8, 10], "get_dataset_link": [8, 10], "upload_dataset": [8, 10], "upload_dataset_no_valid": [8, 10], "copy_files_to_new_loc": [8, 10], "create_contributor_info": [8, 10, 12], "generate_file_nam": [8, 10], "recipi": 9, "subject": 9, "bodi": 9, "mailto": 9, "link": [9, 10], "given": [9, 10], "arg": [9, 10], "list": [9, 10, 12], "email": 9, "address": 9, "str": [9, 10], "return": [9, 10], "dataset_nam": [9, 10, 12], "pi_nam": [9, 10, 12], "date": [9, 10], "dataset_link": [9, 10], "send": 9, "notif": 9, "dataset": [9, 10, 11, 12], "name": [9, 10], "where": [9, 10, 12], "princip": [9, 10], "investig": [9, 10], "who": 9, "when": 9, "none": [9, 10], "set": [9, 11, 12], "api": [9, 10, 11, 12], "kei": [9, 10, 11], "append": [9, 12], "alreadi": [9, 10, 11, 12], "exist": [9, 10, 11], "doe": 9, "add": [9, 12], "again": 9, "token": [9, 10], "found": [9, 10, 11, 12], "rais": [9, 10, 12], "valueerror": [9, 10], "object": 10, "helper": 10, "circuit_el": 10, "element_nam": 10, "result_typ": 10, "kwarg": 10, "builderconfig": 10, "squadds_db": [10, 11, 12], "data_fil": 10, "repres": 10, "upload": [10, 11, 12], "attribut": 10, "dataset_fil": 10, "pi": [10, 11, 12], "hfapi": 10, "presenc": 10, "uniqu": 10, "without": 10, "compon": 10, "data_typ": 10, "data_natur": 10, "data_sourc": 10, "type": 10, "option": 10, "default": 10, "doesn": 10, "t": [10, 11], "notimplementederror": [10, 12], "data_path": 10, "new_path": 10, "copi": 10, "locat": 10, "contain": 10, "prompt": 10, "user": [10, 11, 12], "updat": [10, 11, 12], "enter": 10, "It": [10, 12], "input": 10, "correspond": 10, "field": [10, 12], "confirm": 10, "whether": 10, "overwrit": 10, "valu": 10, "ar": 10, "empti": 10, "load_ext": [11, 12], "autoreload": [11, 12], "instal": [11, 12], "e": [11, 12], "obtain": [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], "0": [11, 12], "successfulli": [11, 12], "run": [11, 12], "instruct": 11, "here": 11, "sign": 11, "onc": 11, "huggingface_api_kei": 11, "variabl": [11, 12], "execut": [11, 12], "import": [11, 12], "15": [11, 12], "get_dataset_config_nam": 11, "load_dataset": [11, 12], "13": 11, "39": [11, 12], "cap_matrix": [11, 12], "cavity_claw": [11, 12], "routermeand": 11, "eigenmod": [11, 12], "ncap": [11, 12], "qubit_data": 11, "datasetdict": 11, "train": [11, 12], "note": 11, "sim_result": [11, 12], "sim_opt": [11, 12], "num_row": 11, "1934": 11, "28": 11, "print": 11, "nest": 11, "try": 11, "f": [11, 12], "ha": [11, 12], "k": 11, "except": 11, "pass": 11, "design_opt": [11, 12], "design_tool": [11, 12], "date_cr": [11, 12], "claw_to_claw": 11, "claw_to_ground": 11, "cross_to_claw": 11, "cross_to_cross": 11, "cross_to_ground": 11, "ground_to_ground": 11, "unit": [11, 12], "renderer_opt": 11, "86": 12, "extens": 12, "load": 12, "To": 12, "reload": 12, "reload_ext": 12, "14": 12, "tabl": 12, "node": 12, "build": 12, "top": 12, "order": 12, "need": 12, "some": 12, "yourself": 12, "track": 12, "give": 12, "credit": 12, "root": 12, "group_nam": 12, "user_nam": 12, "Or": 12, "cell": 12, "17": 12, "want": 12, "json": 12, "format": 12, "AT": 12, "least": 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, "same": 12, "just": 12, "instead": 12, "repeat": 12, "each": 12, "result": 12, "fork": 12, "do": 12, "so": 12, "checkout": 12, "branch": 12, "might": 12, "b": 12, "add_to_configur": 12, "modifi": 12, "necessari": 12, "sure": 12, "maintain": 12, "specif": 12, "requir": 12, "commit": 12, "push": 12, "chang": 12, "m": 12, "y": 12, "origin": 12, "against": 12, "hub": 12, "command": 12, "your_usernam": 12, "good": 12, "new_configur": 12, "involv": 12, "ones": 12, "librari": 12, "builder": 12, "script": 12, "defin": 12, "clear": 12, "messag": 12, "x": 12, "go": 12, "exampl": 12, "render": 12, "get": [12, 13], "automat": 12, "79": 12, "def": 12, "combine_json_fil": 12, "source_directori": 12, "output_fil": 12, "all_data": 12, "file_path": 12, "glob": 12, "o": 12, "join": 12, "r": 12, "encod": 12, "utf": 12, "write": 12, "combin": 12, "singl": 12, "w": 12, "outfil": 12, "dump": 12, "indent": 12, "80": 12, "replac": 12, "combined_qubit_data": 12, "desir": 12, "output": 12, "81": 12, "combined_coupler_data": 12, "82": 12, "routemeand": 12, "combined_cav": 12, "claw_data": 12, "83": 12, "renam": 12, "lfl_usc_": 12, "hash": 12, "hashlib": 12, "md5": 12, "sort_kei": 12, "true": 12, "hexdigest": 12, "new_fil": 12, "99": 12, "cli": 12, "test": 12, "save_info": 12, "all_config": 12, "info": 12, "cach": 12, "datasets_modul": 12, "6c042e99be0aa47463aa5d9ae2ceeb87b02331a7e2aa159865c27f7b19e9316": 12, "s_qu_adds_db": 12, "download": 12, "100": 12, "00": 12, "lt": 12, "12458": 12, "33it": 12, "took": 12, "min": 12, "checksum": 12, "extract": 12, "853": 12, "43it": 12, "split": 12, "traceback": 12, "most": 12, "recent": 12, "call": 12, "last": 12, "34": 12, "miniconda3": 12, "qiskit_met": 12, "bin": 12, "gt": 12, "sy": 12, "exit": 12, "main": 12, "lib": 12, "python3": 12, "site": 12, "datasets_cli": 12, "servic": 12, "146": 12, "download_and_prepar": 12, "948": 12, "self": 12, "_download_and_prepar": 12, "1043": 12, "_prepare_split": 12, "split_gener": 12, "prepare_split_kwarg": 12, "1445": 12, "96": 12, "random": 12, "create_train_val_test_split": 12, "source_fil": 12, "output_directori": 12, "train_ratio": 12, "val_ratio": 12, "makedir": 12, "extend": 12, "shuffl": 12, "total_data": 12, "len": 12, "train_end": 12, "int": 12, "val_end": 12, "train_data": 12, "val_data": 12, "test_data": 12, "save": 12, "97": 12, "lfl_usc_cavity_claw_3e95ba4a2e4da2141f9edaa9f9fa1653": 12, "lfl_usc_coupler_e7855e5c7467f76edb09779d8f3a1a0c": 12, "lfl_usc_qubit_e68f323df894ba4b2891bd64742a2c35": 12}, "objects": {"": [[8, 0, 0, "-", "squadds"]], "squadds": [[9, 0, 0, "-", "core"], [10, 0, 0, "-", "database"]], "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"]], "squadds.database": [[10, 0, 0, "-", "checker"], [10, 0, 0, "-", "config"], [10, 0, 0, "-", "contributor"], [10, 0, 0, "-", "db"], [10, 0, 0, "-", "reader"], [10, 0, 0, "-", "utils"]], "squadds.database.checker": [[10, 2, 1, "", "Checker"]], "squadds.database.checker.Checker": [[10, 3, 1, "", "check"]], "squadds.database.config": [[10, 2, 1, "", "SQuADDS_DB_Config"]], "squadds.database.contributor": [[10, 2, 1, "", "Contribute"]], "squadds.database.contributor.Contribute": [[10, 3, 1, "", "check_for_api_key"], [10, 3, 1, "", "create_dataset_name"], [10, 3, 1, "", "create_dataset_repository"], [10, 3, 1, "", "get_dataset_link"], [10, 3, 1, "", "upload_dataset"], [10, 3, 1, "", "upload_dataset_no_validation"]], "squadds.database.reader": [[10, 2, 1, "", "Reader"]], "squadds.database.utils": [[10, 1, 1, "", "copy_files_to_new_location"], [10, 1, 1, "", "create_contributor_info"], [10, 1, 1, "", "generate_file_name"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"]}, "titleterms": {"api": 0, "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, "And": 3, "devic": 3, "design": 3, "simul": 3, "databas": [3, 10, 12], "citat": 3, "indic": 3, "tabl": 3, "releas": 6, "version": 6, "0": 6, "1": [6, 11], "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, "2": 12, "inform": 12, "understand": 12, "terminologi": 12, "structur": 12, "data": 12, "process": 12, "ad": 12, "exist": 12, "configur": 12, "new": 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": 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-squadds"], [9, "module-squadds.core"], [10, "module-squadds.database"]], "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, "module-squadds.database.checker"]], "squadds.database.config module": [[10, "module-squadds.database.config"]], "squadds.database.contributor module": [[10, "module-squadds.database.contributor"]], "squadds.database.db module": [[10, "module-squadds.database.db"]], "squadds.database.reader module": [[10, "module-squadds.database.reader"]], "squadds.database.utils module": [[10, "module-squadds.database.utils"]], "Tutorial 1: Getting Started with SQuADDS": [[11, "Tutorial-1:-Getting-Started-with-SQuADDS"]], "HuggingFace": [[11, "HuggingFace"]], "Creating an Account": [[11, "Creating-an-Account"]], "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"]], "Data Processing:": [[12, "Data-Processing:"]], "Adding to an Existing Configuration": [[12, "Adding-to-an-Existing-Configuration"]], "Contributing a New Configuration": [[12, "Contributing-a-New-Configuration"]], "Tutorials": [[13, "tutorials"]]}, "indexentries": {"module": [[8, "module-squadds"], [9, "module-squadds.core"], [9, "module-squadds.core.globals"], [9, "module-squadds.core.utils"], [10, "module-squadds.database"], [10, "module-squadds.database.checker"], [10, "module-squadds.database.config"], [10, "module-squadds.database.contributor"], [10, "module-squadds.database.db"], [10, "module-squadds.database.reader"], [10, "module-squadds.database.utils"]], "squadds": [[8, "module-squadds"]], "create_mailto_link() (in module squadds.core.utils)": [[9, "squadds.core.utils.create_mailto_link"]], "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"]], "checker (class in squadds.database.checker)": [[10, "squadds.database.checker.Checker"]], "contribute (class in squadds.database.contributor)": [[10, "squadds.database.contributor.Contribute"]], "reader (class in squadds.database.reader)": [[10, "squadds.database.reader.Reader"]], "squadds_db_config (class in squadds.database.config)": [[10, "squadds.database.config.SQuADDS_DB_Config"]], "check() (squadds.database.checker.checker method)": [[10, "squadds.database.checker.Checker.check"]], "check_for_api_key() (squadds.database.contributor.contribute method)": [[10, "squadds.database.contributor.Contribute.check_for_api_key"]], "copy_files_to_new_location() (in module squadds.database.utils)": [[10, "squadds.database.utils.copy_files_to_new_location"]], "create_contributor_info() (in module squadds.database.utils)": [[10, "squadds.database.utils.create_contributor_info"]], "create_dataset_name() (squadds.database.contributor.contribute method)": [[10, "squadds.database.contributor.Contribute.create_dataset_name"]], "create_dataset_repository() (squadds.database.contributor.contribute method)": [[10, "squadds.database.contributor.Contribute.create_dataset_repository"]], "generate_file_name() (in module squadds.database.utils)": [[10, "squadds.database.utils.generate_file_name"]], "get_dataset_link() (squadds.database.contributor.contribute method)": [[10, "squadds.database.contributor.Contribute.get_dataset_link"]], "squadds.database": [[10, "module-squadds.database"]], "squadds.database.checker": [[10, "module-squadds.database.checker"]], "squadds.database.config": [[10, "module-squadds.database.config"]], "squadds.database.contributor": [[10, "module-squadds.database.contributor"]], "squadds.database.db": [[10, "module-squadds.database.db"]], "squadds.database.reader": [[10, "module-squadds.database.reader"]], "squadds.database.utils": [[10, "module-squadds.database.utils"]], "upload_dataset() (squadds.database.contributor.contribute method)": [[10, "squadds.database.contributor.Contribute.upload_dataset"]], "upload_dataset_no_validation() (squadds.database.contributor.contribute method)": [[10, "squadds.database.contributor.Contribute.upload_dataset_no_validation"]]}})
\ 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": {"thi": [0, 3, 10, 12], "section": [0, 1], "provid": [0, 1, 3, 12], "detail": [0, 9], "document": [0, 1], "all": [0, 11, 12], "modul": [0, 3, 4, 12], "class": [0, 3, 10], "function": [0, 10], "other": [0, 12], "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, 10, 12], "welcom": 1, "pleas": [1, 3, 11], "see": 1, "review": [1, 5, 12], "follow": [1, 11, 12], "more": [1, 12], "inform": [1, 5, 10], "contact": 1, "u": 1, "bug": 1, "report": 1, "ani": [1, 10, 12], "you": [1, 2, 3, 11, 12], "find": 1, "code": [1, 11, 12], "open": [1, 3, 5, 12], "an": [1, 3, 5, 9], "issu": 1, "github": [1, 2, 5], "featur": [1, 11], "request": [1, 12], "If": [1, 3, 9, 10, 12], "have": [1, 11, 12], "idea": 1, "new": [1, 3, 5, 10], "pull": [1, 12], "we": [1, 12], "from": [1, 2, 3, 5, 10, 11, 12], "commun": 1, "submit": 1, "patient": 1, "your": [1, 2, 3, 11, 12], "work": [1, 3, 12], "question": 1, "about": [1, 12], "typo": 1, "error": 1, "implement": [1, 3, 6, 10], "next": 1, "releas": 1, "would": 1, "like": 1, "help": 1, "version": 1, "look": 1, "In": [1, 12], "http": [1, 2, 5, 12], "com": [1, 2, 5], "shanto268": [1, 2], "tab": 1, "readm": 1, "ov": 1, "file": [1, 9, 10, 11, 12], "sadman": [1, 3], "ahm": [1, 3], "shanto": [1, 3, 11, 12], "univers": 1, "southern": 1, "california": 1, "eli": [1, 3], "levenson": [1, 3], "falk": [1, 3], "etern": 1, "guidanc": 1, "andr": [1, 3], "kuo": [1, 3], "clark": [1, 3], "miyamoto": [1, 3], "york": 1, "madison": 1, "howard": 1, "institut": [1, 9, 10, 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, 10, 12], "clone": [2, 12], "repositori": [2, 3, 10, 12], "navig": [2, 12], "chosen": 2, "directori": [2, 10, 12], "cd": 2, "repo": 2, "path": [2, 10, 12], "git": [2, 12], "depend": [2, 12], "activ": 2, "qiskit": [2, 5, 12], "metal": [2, 5, 12], "conda": 2, "environ": [2, 11], "env": [2, 9, 10, 11, 12], "q": [2, 5], "placehold": 2, "A": [2, 3, 5, 9], "platform": 3, "aim": 3, "speed": 3, "up": [3, 11], "loop": 3, "creation": [3, 10], "quantum": [3, 5], "hardwar": 3, "tool": 3, "bridg": 3, "gap": 3, "between": 3, "theoret": 3, "practic": [3, 12], "research": 3, "engin": [3, 5], "well": 3, "character": [3, 5], "start": [3, 13], "point": 3, "develop": [3, 11, 12], "enabl": 3, "rapid": 3, "gener": [3, 9, 10, 12], "best": [3, 12], "guess": 3, "valid": [3, 10, 12], "pre": [3, 6], "underpin": 3, "vast": 3, "experiment": [3, 5], "paramet": 3, "lower": 3, "barrier": 3, "entri": 3, "group": [3, 5, 10, 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], "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], "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, 12], "databas": [4, 6, 8], "checker": [4, 8], "config": [4, 8, 11, 12], "contributor": [4, 8, 11, 12], "db": [4, 8], "reader": [4, 8], "avail": 5, "org": 5, "hug": [5, 9, 10, 12], "face": [5, 9, 10, 12], "huggingfac": [5, 6, 10, 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, 12], "1": [5, 12, 13], "pp": 5, "131": 5, "2021": 5, "natur": [5, 10], "publish": 5, "uk": 5, "london": 5, "electrodynam": 5, "cqed": 5, "modular": 5, "quasi": 5, "lump": 5, "model": 5, "2103": 5, "10344": 5, "quant": 5, "ph": 5, "yuan": 5, "comparison": 5, "oscil": 5, "ratio": 5, "method": [5, 10], "design": [5, 6, 11, 12], "two": 5, "dimension": 5, "superconduct": 5, "chip": 5, "entropi": 5, "24": 5, "6": 5, "792": 5, "2022": 5, "mdpi": 5, "awslab": 5, "palac": 5, "3d": 5, "finit": 5, "element": [5, 12], "solver": 5, "comput": [5, 12], "electromagnet": 5, "koch": 5, "charg": 5, "insensit": 5, "qubit": [5, 11, 12], "deriv": 5, "cooper": 5, "pair": 5, "box": 5, "physic": 5, "76": 5, "4": [5, 11, 12], "042319": 5, "2007": 5, "ap": 5, "yan": 5, "framework": 5, "optim": 5, "2020": 5, "2006": 5, "04130": 5, "krantz": 5, "": [5, 12], "guid": 5, "appli": 5, "2": [5, 11, 13], "2019": 5, "aip": 5, "groszkowski": 5, "j": 5, "scqubit": 5, "python": [5, 12], "5": 5, "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, "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, 12], "034031": 5, "besedin": 5, "p": 5, "menushenkov": 5, "qualiti": 5, "factor": 5, "transmiss": 5, "line": [5, 12], "coupl": 5, "coplanar": 5, "waveguid": 5, "reson": 5, "epj": 5, "16": 5, "2018": 5, "springeropen": 5, "mcdaniel": 5, "simul": [5, 6, 11, 12], "guidelin": [5, 12], "wideband": 5, "ground": 5, "back": 5, "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, "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, "materi": 5, "8": [5, 12], "679": 5, "700": 5, "feng": 5, "artifici": 5, "aid": 5, "The": [5, 9, 10, 12], "state": 5, "art": 5, "theori": 5, "techniqu": 5, "70": 5, "11": [5, 11], "4597": 5, "4619": 5, "nov": 5, "nugraha": 5, "shao": 5, "base": [5, 6, 10, 12], "predict": 5, "march": 5, "meet": 5, "la": 5, "vega": 5, "nevada": 5, "10": [5, 12], "virtual": 5, "20": 5, "22": [5, 11], "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, 12], "mar": 5, "rajabzadeh": 5, "analysi": 5, "arbitrari": 5, "accompani": 5, "sqcircuit": 5, "1118": 5, "mvp": 6, "host": 6, "data": [6, 10], "transmoncross": [6, 11, 12], "claw": 6, "onli": 6, "closest": 6, "interpol": 6, "retriev": [6, 10], "logic": 6, "paper": 6, "tutori": 6, "basic": 6, "usag": 6, "contribut": [6, 8, 10, 13], "ad": 6, "pypi": 6, "creat": [6, 9, 10, 12], "create_mailto_link": [8, 9], "send_email_via_cli": [8, 9], "set_huggingface_api_kei": [8, 9, 11], "check": [8, 10], "squadds_db_config": [8, 10], "check_for_api_kei": [8, 10], "create_dataset_nam": [8, 10], "create_dataset_repositori": [8, 10], "get_dataset_link": [8, 10], "upload_dataset": [8, 10], "upload_dataset_no_valid": [8, 10], "copy_files_to_new_loc": [8, 10], "create_contributor_info": [8, 10, 12], "generate_file_nam": [8, 10], "recipi": 9, "subject": 9, "bodi": 9, "mailto": 9, "link": [9, 10], "given": [9, 10], "arg": [9, 10], "list": [9, 10, 12], "email": 9, "address": 9, "str": [9, 10], "return": [9, 10], "dataset_nam": [9, 10, 12], "pi_nam": [9, 10, 12], "date": [9, 10], "dataset_link": [9, 10], "send": 9, "notif": 9, "dataset": [9, 10, 11, 12], "name": [9, 10], "where": [9, 10, 12], "princip": [9, 10], "investig": [9, 10], "who": 9, "when": 9, "none": [9, 10], "set": [9, 11, 12], "api": [9, 10, 11, 12], "kei": [9, 10, 11], "append": [9, 12], "alreadi": [9, 10, 11, 12], "exist": [9, 10, 11], "doe": 9, "add": [9, 12], "again": 9, "token": [9, 10], "found": [9, 10, 11, 12], "rais": [9, 10, 12], "valueerror": [9, 10], "object": 10, "helper": 10, "circuit_el": 10, "element_nam": 10, "result_typ": 10, "kwarg": 10, "builderconfig": 10, "squadds_db": [10, 11, 12], "data_fil": 10, "repres": 10, "upload": [10, 11, 12], "attribut": 10, "dataset_fil": 10, "pi": [10, 11, 12], "hfapi": 10, "presenc": 10, "uniqu": 10, "without": 10, "compon": 10, "data_typ": 10, "data_natur": 10, "data_sourc": 10, "type": 10, "option": 10, "default": 10, "doesn": 10, "t": [10, 11], "notimplementederror": [10, 12], "data_path": 10, "new_path": 10, "copi": 10, "locat": 10, "contain": 10, "prompt": 10, "user": [10, 11, 12], "updat": [10, 11, 12], "enter": 10, "It": [10, 12], "input": 10, "correspond": 10, "field": [10, 12], "confirm": 10, "whether": 10, "overwrit": 10, "valu": 10, "ar": 10, "empti": 10, "load_ext": [11, 12], "autoreload": [11, 12], "instal": [11, 12], "e": [11, 12], "obtain": [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], "0": [11, 12], "successfulli": [11, 12], "run": [11, 12], "instruct": 11, "here": 11, "sign": 11, "onc": 11, "huggingface_api_kei": 11, "variabl": [11, 12], "execut": [11, 12], "import": [11, 12], "15": [11, 12], "get_dataset_config_nam": 11, "load_dataset": [11, 12], "13": 11, "39": [11, 12], "cap_matrix": [11, 12], "cavity_claw": [11, 12], "routermeand": 11, "eigenmod": [11, 12], "ncap": [11, 12], "qubit_data": 11, "datasetdict": 11, "train": [11, 12], "note": 11, "sim_result": [11, 12], "sim_opt": [11, 12], "num_row": 11, "1934": 11, "28": 11, "print": 11, "nest": 11, "try": 11, "f": [11, 12], "ha": [11, 12], "k": 11, "except": 11, "pass": 11, "design_opt": [11, 12], "design_tool": [11, 12], "date_cr": [11, 12], "claw_to_claw": 11, "claw_to_ground": 11, "cross_to_claw": 11, "cross_to_cross": 11, "cross_to_ground": 11, "ground_to_ground": 11, "unit": [11, 12], "renderer_opt": 11, "86": 12, "extens": 12, "load": 12, "To": 12, "reload": 12, "reload_ext": 12, "14": 12, "tabl": 12, "node": 12, "build": 12, "top": 12, "order": 12, "need": 12, "some": 12, "yourself": 12, "track": 12, "give": 12, "credit": 12, "root": 12, "group_nam": 12, "user_nam": 12, "Or": 12, "cell": 12, "17": 12, "want": 12, "json": 12, "format": 12, "AT": 12, "least": 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, "same": 12, "just": 12, "instead": 12, "repeat": 12, "each": 12, "result": 12, "fork": 12, "do": 12, "so": 12, "checkout": 12, "branch": 12, "might": 12, "b": 12, "add_to_configur": 12, "modifi": 12, "necessari": 12, "sure": 12, "maintain": 12, "specif": 12, "requir": 12, "commit": 12, "push": 12, "chang": 12, "m": 12, "y": 12, "origin": 12, "against": 12, "hub": 12, "command": 12, "your_usernam": 12, "good": 12, "new_configur": 12, "involv": 12, "ones": 12, "librari": 12, "builder": 12, "script": 12, "defin": 12, "clear": 12, "messag": 12, "x": 12, "go": 12, "exampl": 12, "render": 12, "get": [12, 13], "automat": 12, "79": 12, "def": 12, "combine_json_fil": 12, "source_directori": 12, "output_fil": 12, "all_data": 12, "file_path": 12, "glob": 12, "o": 12, "join": 12, "r": 12, "encod": 12, "utf": 12, "write": 12, "combin": 12, "singl": 12, "w": 12, "outfil": 12, "dump": 12, "indent": 12, "80": 12, "replac": 12, "combined_qubit_data": 12, "desir": 12, "output": 12, "81": 12, "combined_coupler_data": 12, "82": 12, "routemeand": 12, "combined_cav": 12, "claw_data": 12, "83": 12, "renam": 12, "lfl_usc_": 12, "hash": 12, "hashlib": 12, "md5": 12, "sort_kei": 12, "true": 12, "hexdigest": 12, "new_fil": 12, "99": 12, "cli": 12, "test": 12, "save_info": 12, "all_config": 12, "info": 12, "cach": 12, "datasets_modul": 12, "6c042e99be0aa47463aa5d9ae2ceeb87b02331a7e2aa159865c27f7b19e9316": 12, "s_qu_adds_db": 12, "download": 12, "100": 12, "00": 12, "lt": 12, "12458": 12, "33it": 12, "took": 12, "min": 12, "checksum": 12, "extract": 12, "853": 12, "43it": 12, "split": 12, "traceback": 12, "most": 12, "recent": 12, "call": 12, "last": 12, "34": 12, "miniconda3": 12, "qiskit_met": 12, "bin": 12, "gt": 12, "sy": 12, "exit": 12, "main": 12, "lib": 12, "python3": 12, "site": 12, "datasets_cli": 12, "servic": 12, "146": 12, "download_and_prepar": 12, "948": 12, "self": 12, "_download_and_prepar": 12, "1043": 12, "_prepare_split": 12, "split_gener": 12, "prepare_split_kwarg": 12, "1445": 12, "96": 12, "random": 12, "create_train_val_test_split": 12, "source_fil": 12, "output_directori": 12, "train_ratio": 12, "val_ratio": 12, "makedir": 12, "extend": 12, "shuffl": 12, "total_data": 12, "len": 12, "train_end": 12, "int": 12, "val_end": 12, "train_data": 12, "val_data": 12, "test_data": 12, "save": 12, "97": 12, "lfl_usc_cavity_claw_3e95ba4a2e4da2141f9edaa9f9fa1653": 12, "lfl_usc_coupler_e7855e5c7467f76edb09779d8f3a1a0c": 12, "lfl_usc_qubit_e68f323df894ba4b2891bd64742a2c35": 12}, "objects": {"": [[8, 0, 0, "-", "squadds"]], "squadds": [[9, 0, 0, "-", "core"], [10, 0, 0, "-", "database"]], "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"]], "squadds.database": [[10, 0, 0, "-", "checker"], [10, 0, 0, "-", "config"], [10, 0, 0, "-", "contributor"], [10, 0, 0, "-", "db"], [10, 0, 0, "-", "reader"], [10, 0, 0, "-", "utils"]], "squadds.database.checker": [[10, 2, 1, "", "Checker"]], "squadds.database.checker.Checker": [[10, 3, 1, "", "check"]], "squadds.database.config": [[10, 2, 1, "", "SQuADDS_DB_Config"]], "squadds.database.contributor": [[10, 2, 1, "", "Contribute"]], "squadds.database.contributor.Contribute": [[10, 3, 1, "", "check_for_api_key"], [10, 3, 1, "", "create_dataset_name"], [10, 3, 1, "", "create_dataset_repository"], [10, 3, 1, "", "get_dataset_link"], [10, 3, 1, "", "upload_dataset"], [10, 3, 1, "", "upload_dataset_no_validation"]], "squadds.database.reader": [[10, 2, 1, "", "Reader"]], "squadds.database.utils": [[10, 1, 1, "", "copy_files_to_new_location"], [10, 1, 1, "", "create_contributor_info"], [10, 1, 1, "", "generate_file_name"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"]}, "titleterms": {"api": 0, "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, "And": 3, "devic": 3, "design": 3, "simul": 3, "databas": [3, 10, 12], "citat": 3, "indic": 3, "tabl": 3, "releas": 6, "version": 6, "0": 6, "1": [6, 11], "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, "2": 12, "inform": 12, "understand": 12, "terminologi": 12, "structur": 12, "data": 12, "process": 12, "ad": 12, "exist": 12, "configur": 12, "new": 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": 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-squadds"], [9, "module-squadds.core"], [10, "module-squadds.database"]], "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, "module-squadds.database.checker"]], "squadds.database.config module": [[10, "module-squadds.database.config"]], "squadds.database.contributor module": [[10, "module-squadds.database.contributor"]], "squadds.database.db module": [[10, "module-squadds.database.db"]], "squadds.database.reader module": [[10, "module-squadds.database.reader"]], "squadds.database.utils module": [[10, "module-squadds.database.utils"]], "Tutorial 1: Getting Started with SQuADDS": [[11, "Tutorial-1:-Getting-Started-with-SQuADDS"]], "HuggingFace": [[11, "HuggingFace"]], "Creating an Account": [[11, "Creating-an-Account"]], "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"]], "Data Processing:": [[12, "Data-Processing:"]], "Adding to an Existing Configuration": [[12, "Adding-to-an-Existing-Configuration"]], "Contributing a New Configuration": [[12, "Contributing-a-New-Configuration"]], "Tutorials": [[13, "tutorials"]]}, "indexentries": {"module": [[8, "module-squadds"], [9, "module-squadds.core"], [9, "module-squadds.core.globals"], [9, "module-squadds.core.utils"], [10, "module-squadds.database"], [10, "module-squadds.database.checker"], [10, "module-squadds.database.config"], [10, "module-squadds.database.contributor"], [10, "module-squadds.database.db"], [10, "module-squadds.database.reader"], [10, "module-squadds.database.utils"]], "squadds": [[8, "module-squadds"]], "create_mailto_link() (in module squadds.core.utils)": [[9, "squadds.core.utils.create_mailto_link"]], "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"]], "checker (class in squadds.database.checker)": [[10, "squadds.database.checker.Checker"]], "contribute (class in squadds.database.contributor)": [[10, "squadds.database.contributor.Contribute"]], "reader (class in squadds.database.reader)": [[10, "squadds.database.reader.Reader"]], "squadds_db_config (class in squadds.database.config)": [[10, "squadds.database.config.SQuADDS_DB_Config"]], "check() (squadds.database.checker.checker method)": [[10, "squadds.database.checker.Checker.check"]], "check_for_api_key() (squadds.database.contributor.contribute method)": [[10, "squadds.database.contributor.Contribute.check_for_api_key"]], "copy_files_to_new_location() (in module squadds.database.utils)": [[10, "squadds.database.utils.copy_files_to_new_location"]], "create_contributor_info() (in module squadds.database.utils)": [[10, "squadds.database.utils.create_contributor_info"]], "create_dataset_name() (squadds.database.contributor.contribute method)": [[10, "squadds.database.contributor.Contribute.create_dataset_name"]], "create_dataset_repository() (squadds.database.contributor.contribute method)": [[10, "squadds.database.contributor.Contribute.create_dataset_repository"]], "generate_file_name() (in module squadds.database.utils)": [[10, "squadds.database.utils.generate_file_name"]], "get_dataset_link() (squadds.database.contributor.contribute method)": [[10, "squadds.database.contributor.Contribute.get_dataset_link"]], "squadds.database": [[10, "module-squadds.database"]], "squadds.database.checker": [[10, "module-squadds.database.checker"]], "squadds.database.config": [[10, "module-squadds.database.config"]], "squadds.database.contributor": [[10, "module-squadds.database.contributor"]], "squadds.database.db": [[10, "module-squadds.database.db"]], "squadds.database.reader": [[10, "module-squadds.database.reader"]], "squadds.database.utils": [[10, "module-squadds.database.utils"]], "upload_dataset() (squadds.database.contributor.contribute method)": [[10, "squadds.database.contributor.Contribute.upload_dataset"]], "upload_dataset_no_validation() (squadds.database.contributor.contribute method)": [[10, "squadds.database.contributor.Contribute.upload_dataset_no_validation"]]}})
\ No newline at end of file