Update documentation and add HuggingFace link to icon links

docs/conf.py

@@ -52,20 +52,25 @@
         "alt_text": "SQuADDS Logo",
         "image_light": "_static/images/squadds_logo_light_name.png",
         "image_dark": "_static/images/squadds_logo_dark_name.png",
-        "link": "."
+        "link": "https://lfl-lab.github.io/SQuADDS/"
     },
     "github_url": "https://github.com/LFL-Lab/SQuADDS",
     "icon_links": [
-        {
-            "name": "LFL Lab",
-            "url": "https://dornsife.usc.edu/lfl/",
-            "icon": "fas fa-hand-peace",
-        },
         {
             "name": "PyPI",
             "url": "https://pypi.org/project/SQuADDS/",
             "icon": "fab fa-python",
         },
+        {
+            "name": "HuggingFace",
+            "url": "https://huggingface.co/datasets/SQuADDS/SQuADDS_DB",
+            "icon": "fas fa-face-smile",
+        },
+        {
+            "name": "LFL Lab",
+            "url": "https://dornsife.usc.edu/lfl/",
+            "icon": "fas fa-hand-peace",
+        },
     ],
     "navigation_depth": 5,
     "show_nav_level": 3,

docs/index.rst

@@ -20,8 +20,9 @@ SQuADDS is an open-source platform aimed at speeding up the design loop in the c
    Documentation Home <self>
    Getting Started <source/getting_started>
    Tutorials <source/tutorials/index>
-   Developer Notes<source/developer/index>
    API Reference <source/apidocs/index>
+   Developer Notes <source/developer/index>
+   Simulation Notes <source/resources/simulations>
    Release Logs<source/release_notes>
    GitHub <https://github.com/shanto268/SQuADDS>
    Paper <https://arxiv.org/pdf/2312.13483.pdf>

docs/source/getting_started.rst

@@ -32,11 +32,10 @@ Alternatively, you can install SQuADDS from source.
       cd SQuADDS
       pip install -e .
 
-
 FAQ
----
-
-- **Getting `ModuleNotFoundError: No module named 'squadds'` after running `pip install SQuADDS`** in Jupyter Notebook
+===
 
-- You may need to restart the kernel after installing `SQuADDS`
+Q: **Getting `ModuleNotFoundError: No module named 'squadds'` after running `pip install SQuADDS` in Jupyter Notebook. How can I fix this?**
+----------------------------------------------------------------------------------------------------------------------------------------
 
+A: You may need to restart the kernel after installing `SQuADDS`. To do this, go to the `Kernel` menu in Jupyter Notebook and select `Restart`.

docs/source/release_notes.rst

@@ -1,13 +1,15 @@
 Release Notes
 =============
 
-Version 0.2.1 (2023-12-24)
+Version 0.2.1 (2024-01-10)
 --------------------------
 
 * **Alpha Version 0.2.1**
 
 - Bug fixes:
+
   - change "c" to "readout" in both code and database entries
+
 - Handled Warnings from pyaedt
 
 Version 0.2 (2023-12-24)

docs/source/resources/simulations.rst

@@ -0,0 +1,57 @@
+Simulation Lessons
+==================
+
+This is a guide to the simulation methodologies we have found to be useful in our project. 
+
+ANSYS Simulations
+-----------------
+
+We have found the following practices to be effective in ANSYS simulations:
+
+- Finer mesh is always better, but as long as the seed mesh is no more than 1/3 the size of a feature it spans, it will converge to a good adaptive mesh.
+
+- The convergence criteria (Delta-S or Delta-f, depending on the solver) should be less than 0.02%; 0.01% is better. The default (0.2%) never works.
+
+- There should be a minimum of 1 additional simulation pass after the convergence criteria are met; more is better (but slower).
+
+- EPR analysis has been quite unreliable for getting coupling strengths, with typical errors above 30%. We use a lumped approach similar to LOM whenever possible, and only use eigenmodal analysis for frequencies and quality factors.
+
+- We get best results simulating small components separately from each other.
+
+- Resonator quality factor is never super accurate, but the best approach we've found is to do an eigenmodal analysis of the resonator and feedline (with feedline finely meshed and extending far beyond the coupling region), with the feedline terminated by 50-ohm lumped ports.
+
+- Each mesh cell can be represented by a constant, linear function, or 2nd-order polynomial. We've found best results with a linear function.
+
+- *Not strictly simulations, but important for analysis:* The rotating wave approximation can cause one to mis-estimate dispersive shifts by a factor of ~2 if you have far-detuned qubit and cavity.
+
+Resources
+=========
+
+Some learning resources we've found useful:
+
+- Ansys Learning Resources:
+    - `HowToSim YouTube Channel <https://youtube.com/@howtosim7253?feature=shared>`_
+
+    - `HFSS Tutorial for Axion Cavity Workshop (PDF) <https://indico.fnal.gov/event/13068/contributions/17083/attachments/11439/14607/MJones_-_HFSS_Tutorial_for_Axion_Cavity_Workshop.pdf>`_
+
+    - `Ansys Courses <https://courses.ansys.com/index.php/electronics/>`_
+
+    - `Advanced Meshing Techniques (PDF) <http://www.ece.uprm.edu/~rafaelr/inel6068/HFSS/3570_Advanced_Meshing_Techniques.pdf>`_
+
+- Ansys Scripting Resources:
+    - `Ansys Scripting Forum <https://forum.ansys.com/categories/scripting>`_
+
+    - `GitHub Repository for HowToSim <https://github.com/linmingchih>`_
+
+    - `HFSS Library <https://arrc.ou.edu/~cody/hfsslib/>`_
+
+    - `PyANSYS Documentation <https://aedt.docs.pyansys.com/version/stable/>`_
+
+- Ansys Parallel Jobs:
+    - `Using ANSYS RSM <https://www.hpc.iastate.edu/guides/using-ansys-rsm>`_
+
+
+Get Involved
+============
+
+We continuously enhance our simulation techniques and strive to maintain the most current information on this webpage. We're eager to understand how closely our methods align with your team's practices and to learn about any challenges you've encountered previously. We welcome your insights and feedback, so please feel free to reach out to us!

next_release.md

@@ -1,30 +1,32 @@
 # Bug fixes:
 
-- [x] fix the autodoc generator workflow
-
 ---
 
 # Features to add:
 
+- [ ] LLM based queries
 - [ ] Contribution via HuggingFace Hub API
-- [ ] HuggingFace Workflow Action for sending emails upon PR
+- [ ] Create automated tests for each version release workflow
 - [ ] Standardize the way we handle units for simulated results + impmelent necessary changes in backend
-- [ ] add UMAP representation of self.selected_df
-- [ ] LLM based queries
-- [ ] forced download of data from HuggingFace Hub API
 - [ ] change backend calculators to be formula free (dependent on `scqubits` and `sqcircuits`) for analysis
 - [ ] NCap Cavities + Coupled Systems analysis features added + update Tutorial 1 (and Simulator)
+- [ ] H parameter vs Device parameter analysis modules
+
+---
+
+# Documentation requests:
+
+- [ ] updated documentation for all code
+- [ ] completed contribution tutorials
+- [ ] documenting reliable simulation methodologies we have learned and resources
+- [ ] tutorial to show how to demo analysis (H params against device params)
 
 ---
 
 # Database changes:
 
 - [ ] More data points to existing configurations
 - [ ] Update HF data cards
+- [ ] Update HF repo info
 
 ---
-
-# Documentation requests:
-
-- [ ] completed contribution tutorials
-- [ ] documenting reliable simulation methodologies we have learned and resources