Skip to content

Commit

Permalink
docs: changed names of tutorials for clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
shanto268 committed Sep 28, 2024
1 parent b2099f5 commit 2d12822
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 9 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ Read more on [install_guide](docs/installation/unix_install.md))

- [Tutorial 1: Getting Started with SQuADDS](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-1_Getting_Started_with_SQuADDS.html)
- [Tutorial 2: Simulating Interpolated Designs](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-2_Simulate_interpolated_designs.html)
- [Tutorial 3: Contributing to the SQuADDS Database](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-3_Contributing_to_SQuADDS.html)
- [Tutorial 4: Contributing Experimentally-Validated Devices to the SQuADDS Database](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial_4_Contributing_Experimental_Data_to_SQuADDS.html)
- [Tutorial 3: Contributing Experimentally-Validated Simulation Data to the SQuADDS Database](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial-3_Contributing_Validated_Simulation_Data_to_SQuADDS.html)
- [Tutorial 4: Contributing Measured Devices' Data to the SQuADDS Database](https://lfl-lab.github.io/SQuADDS/source/tutorials/Tutorial_4_Contributing_Measured_Data_to_SQuADDS.html)
- [(COMING SOON) More tutorials]()

## Citation
Expand Down
4 changes: 2 additions & 2 deletions docs/source/tutorials/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Tutorials

Tutorial-1_Getting_Started_with_SQuADDS.ipynb
Tutorial-2_Simulate_interpolated_designs.ipynb
Tutorial-3_Contributing_to_SQuADDS.ipynb
Tutorial_4_Contributing_Experimental_Data_to_SQuADDS.ipynb
Tutorial-3_Contributing_Validated_Simulation_Data_to_SQuADDS.ipynb
Tutorial_4_Contributing_Measured_Data_to_SQuADDS.ipynb

.. note::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Tutorial 3: Contributing to SQuADDS\n",
"# Tutorial 3: Contributing Experimentally Validated Simulation Data to SQuADDS\n",
"\n",
"In this tutorial, we will go over the basics of contributing simulation data to the SQuADDS project. We will cover the following topics:\n",
"\n",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Tutorial 4: Contributing Experimentally-Validated Devices to the SQuADDS Database\n",
"# Tutorial 4: Contributing Measured Devices' Data to the SQuADDS Database\n",
"\n",
"This tutorial covers how to contribute **experimentally-validated devices** to the SQuADDS database. These devices are essential for validating simulations and expanding the SQuADDS's design capabilities.\n",
"\n",
Expand Down Expand Up @@ -294,6 +294,10 @@
" \"paper_link\": \"PUBLICATION LINK\",\n",
" \"foundry\": \"FOUNDRY NAME\",\n",
" \"fabrication_recipe\": \"FABRICATION RECIPE LINK\", // Optional\n",
" \"substrate\": \"Silicon\", // Optional\n",
" \"materials\": \"Aluminium\", // Optional\n",
" \"junction_style\": \"Dolan\", // Optional\n",
" \"junction_material\": \"Al-AlOx-Al\" // Optional\n",
" \"notes\": \"ADDITIONAL NOTES\" // Optional\n",
"}\n",
"```\n",
Expand Down Expand Up @@ -325,7 +329,11 @@
"6. **`paper_link`**: Link to related papers.\n",
"7. **`foundry`**: Name of the fabricating foundry.\n",
"8. **`fabrication_recipe`** (Optional): Link to the fabrication recipe (use [Fabublox](https://fabublox.com) if available).\n",
"9. **`notes`** (Optional): Additional device details.\n",
"9. **`substrate`** (Optional): Substrate material.\n",
"10. **`materials`** (Optional): Device materials.\n",
"11. **`junction_style`** (Optional): Junction style (e.g., Dolan).\n",
"12. **`junction_material`** (Optional): Junction material (e.g., Al-AlOx-Al).\n",
"13. **`notes`** (Optional): Additional device details.\n",
"\n",
"--- "
]
Expand Down Expand Up @@ -379,6 +387,10 @@
" \"paper_link\": \"https://arxiv.org/abs/1234.5678\", # Replace with the link to your associated paper\n",
" \"foundry\": \"Your Foundry Name\",\n",
" \"fabrication_recipe\": \"https://fabublox.com/your_recipe\", # Replace with the link to your fabrication recipe\n",
" \"substrate\": \"Silicon\",\n",
" \"materials\": \"Aluminium\",\n",
" \"junction_style\": \"Dolan\",\n",
" \"junction_material\": \"Al-AlOx-Al\",\n",
" \"notes\": \"Additional notes about the device.\"\n",
"}"
]
Expand Down Expand Up @@ -441,8 +453,8 @@
"\n",
"<div style='width: 100%; background-color:#3cb1c2;color:#324344;padding-left: 10px; padding-bottom: 10px; padding-right: 10px; padding-top: 5px'>\n",
" <h3>This code is a part of SQuADDS</h3>\n",
" <p>Developed by Sadman Ahmed Shanto & Adhish Chakravorty </p>\n",
" <p>This tutorial is written by Sadman Ahmed Shanto, Adhish Chakravorty and Elizabeth Kunz & </p> \n",
" <p>Developed by Sadman Ahmed Shanto</p>\n",
" <p>This tutorial is written by Sadman Ahmed Shanto, Adhish Chakravorty and Elizabeth Kunz</p> \n",
" <p>&copy; Copyright Sadman Ahmed Shanto & Eli Levenson-Falk 2023.</p>\n",
" <p>This code is licensed under the MIT License. You may<br> obtain a copy of this license in the LICENSE.txt file in the root directory<br> of this source tree.</p>\n",
" <p>Any modifications or derivative works of this code must retain this<br>copyright notice, and modified files need to carry a notice indicating<br>that they have been altered from the originals.</p>\n",
Expand Down

0 comments on commit 2d12822

Please sign in to comment.