Update release version and fix GitHub link in index.rst

LFL-Lab · Dec 20, 2023 · a4e67bb · a4e67bb
1 parent 30c43ef
commit a4e67bb
Show file tree

Hide file tree

Showing 5 changed files with 68 additions and 385 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -7,7 +7,7 @@
 project = 'SQuADDS'
 copyright = '2023, Sadman Ahmed Shanto'
 author = 'Sadman Ahmed Shanto'
-release = '0.0.1'
+release = '0.1.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -17,13 +17,11 @@
     'sphinx.ext.autodoc',
     'nbsphinx',
     'qiskit_sphinx_theme',
-    'sphinxcontrib.bibtex',
 ]
 
 autodoc_typehints = "none"
 nbsphinx_execute = 'never'
 templates_path = ['_templates']
-bibtex_bibfiles = ['references.bib']
 exclude_patterns = []
 
 

diff --git a/docs/source/developer/index.rst b/docs/source/developer/index.rst
@@ -1,15 +1,12 @@
-.. SQuADDS
-   Copyright (C) 2023, Sadman Ahmed Shanto & Eli Levenson-Falk
-
-.. _developers:
-
 .. note::
 
    Everyone is welcome to contribute to SQuADDS. Please see review the following section for more information or contact us!
 
+Developer Notes
+===============
 
 Contribution Items
-==================
+------------------
 
 | **Bug Reports** - Please report any bugs you find in the code or documentation by opening an issue on GitHub.
 | **Feature Requests** - If you have an idea for a new feature, please open an issue on GitHub.
@@ -19,18 +16,14 @@ Contribution Items
 
 
 Developers
-===========
+----------
 
 | `Sadman Ahmed Shanto <https:sadmanahmedshanto.com>`_ (University of Southern California)
 
-
-.. _developers-contributors:
-
 Contributors
-============
-
+------------
 
 | **Eli Levenson-Falk** (University of Southern California) - Eternal Guidance Provider 🙏🏽
-| **Andre Kuo** (University of Southern California) - Code contributor
-| **Clark Miyamoto** (New York University) - Code contributor
-| **Madison Howard** (California Institute of Tech) - Bug Hunter
+| **Andre Kuo** (University of Southern California) - Code contributor 💻
+| **Clark Miyamoto** (New York University) - Code contributor 💻
+| **Madison Howard** (California Institute of Technology) - Bug Hunter 🐛
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -22,9 +22,9 @@ SQuADDS is an open-source platform aimed at speeding up the design loop in the c
    Tutorials <tutorials/index>
    Developer Notes<developer/index>
    References<references/index>
-   GitHub <https://github.com/shanto268/SQuADDS>
    Release Logs<release_notes>
    API Reference <apidocs/index>
+   GitHub <https://github.com/shanto268/SQuADDS>
 
 
 Citation

diff --git a/docs/source/references/index.rst b/docs/source/references/index.rst
@@ -1,8 +1,61 @@
-**********
+.. _bibliography:
+
+***********
 References
-**********
+***********
+
+- "Qiskit Metal", available at https://qiskit.org/metal.
+
+- "Hugging Face", available at https://huggingface.co/.
+
+- Z. K. Minev et al., "Energy-participation quantization of Josephson circuits", npj Quantum Information, vol. 7, no. 1, pp. 131, 2021, Nature Publishing Group UK London.
+
+- Z. K. Minev et al., "Circuit quantum electrodynamics (cQED) with modular quasi-lumped models", 2021, arXiv:2103.10344 [quant-ph].
+
+- B. Yuan et al., "Comparison of Lumped Oscillator Model and Energy Participation Ratio Methods in Designing Two-Dimensional Superconducting Quantum Chips", Entropy, vol. 24, no. 6, pp. 792, 2022, MDPI.
+
+- "GitHub - awslabs/palace: 3D finite element solver for computational electromagnetics", available at https://github.com/awslabs/palace.
+
+- J. Koch et al., "Charge-insensitive qubit design derived from the Cooper pair box", Physical Review A, vol. 76, no. 4, pp. 042319, 2007, APS.
+
+- F. Yan et al., "Engineering Framework for Optimizing Superconducting Qubit Designs", 2020, arXiv:2006.04130 [quant-ph].
+
+- P. Krantz et al., "A quantum engineer's guide to superconducting qubits", Applied Physics Reviews, vol. 6, no. 2, 2019, AIP Publishing.
+
+- P. Groszkowski and J. Koch, "Scqubits: a Python package for superconducting qubits", Quantum, vol. 5, pp. 583, 2021, Verein zur Förderung des Open Access Publizierens in den Quantenwissenschaften.
+
+- P. Aumann et al., "CircuitQ: an open-source toolbox for superconducting circuits", New Journal of Physics, vol. 24, no. 9, pp. 093012, 2022, IOP Publishing.
+
+- H. Zhang et al., "Noise suppression in superconducting qubits through on-demand cavity cooling and optimal control", Bulletin of the American Physical Society, 2023, APS.
+
+- J. Liu et al., "Experimental Characterization of a Modular Dissipator for On-Demand Cavity Cooling", Bulletin of the American Physical Society, 2023, APS.
+
+- R. Shillito et al., "Dynamics of Transmon Ionization", Physical Review Applied, vol. 18, no. 3, pp. 034031, 2022, American Physical Society.
+
+- I. Besedin and A. P. Menushenkov, "Quality Factor of a Transmission Line Coupled Coplanar Waveguide Resonator", EPJ Quantum Technology, vol. 5, no. 1, pp. 1-16, 2018, SpringerOpen.
+
+- J. W. McDaniel, "Simulation Guidelines for Wideband Ground Backed Coplanar Waveguide Transmission Lines", in IEEE 20th Wireless and Microwave Technology Conference (WAMICON), 2019, pp. 1-5.
+
+- V. Maurya et al., "On-Demand Driven Dissipation for Cavity Reset and Cooling", 2023, arXiv:2310.16785 [cond-mat, physics:quant-ph].
+
+- T. Tanamoto et al., "Classical SPICE Simulation of Superconducting Quantum Circuits", Applied Physics Express, vol. 16, no. 3, pp. 034501, 2023, IOP Publishing.
+
+- G. Huang et al., "Machine Learning for Electronic Design Automation: A survey", ACM Transactions on Design Automation of Electronic Systems, vol. 26, no. 5, pp. 1-46, 2021.
+
+- J. Jiang et al., "Deep Neural Networks for the evaluation and design of photonic devices", Nature Reviews Materials, vol. 6, no. 8, pp. 679-700, 2020.
+
+- F. Feng et al., "Artificial Neural Networks for Microwave Computer-Aided Design: The State of the Art", IEEE Transactions on Microwave Theory and Techniques, vol. 70, no. 11, pp. 4597-4619, Nov 2022.
+
+- F. P. Nugraha and Q. Shao, "Machine Learning-Based Predictive Model for Designing Transmon Qubits in Superconducting Quantum Computer", in APS March Meeting 2023, Las Vegas, Nevada (March 5-10) and Virtual (March 20-22), 2023, American Physical Society, pp. B73.00007.
+
+- C. Zhang et al., "Multivalued Neural Network Inverse Modeling and Applications to Microwave Filters", IEEE Transactions on Microwave Theory and Techniques, vol. 66, no. 8, pp. 3781-3797, Aug 2018.
+
+- D. Willsch et al., "Observation of Josephson Harmonics in Tunnel Junctions", 2023, arXiv:2302.09192 [cond-mat, physics:quant-ph].
+
+- P. Aumann et al., "CircuitQ: An Open-Source Toolbox for Superconducting Circuits", New Journal of Physics, vol. 24, no. 9, pp. 093012, Sep 2022, IOP Publishing.
+
+- A. J. Kerman, "Efficient Numerical Simulation of Complex Josephson Quantum Circuits", 2020, arXiv:2010.14929 [quant-ph].
 
-.. rubric:: References
+- T. Menke et al., "Automated Design of Superconducting Circuits and Its Application to 4-Local Couplers", npj Quantum Information, vol. 7, no. 1, pp. 1-8, Mar 2021, Nature Publishing Group.
 
-.. bibliography:: references.bib
-   :style: unsrt
+- T. Rajabzadeh et al., "Analysis of Arbitrary Superconducting Quantum Circuits Accompanied by a Python Package: SQcircuit", Quantum, vol. 7, pp. 1118, Sep 2023, Verein zur Förderung des Open Access Publizierens in den Quantenwissenschaften.