Add a Cite panel and a Citation section

#1
by shanto268 - opened
Files changed (3) hide show
  1. README.md +33 -0
  2. geomgnn/app_flagship.py +2 -0
  3. geomgnn/ui.py +33 -0
README.md CHANGED
@@ -70,3 +70,36 @@ The examples run without sign-in. Sign in with Hugging Face to run your own layo
70
  ## Privacy
71
 
72
  Uploaded layouts are processed in memory and held there only while the Space runs, to answer repeat requests. Nothing is written to permanent storage, and no file names or geometry are logged or kept. To enforce the daily limit, your Hugging Face username and your network address are turned into keyed hashes, held in memory and cleared at the end of the UTC day. They are never stored or logged. We keep only daily totals (runs per model and per layout size, refusals by reason, errors, response times and the number of distinct users that day) to understand how the demo is used. Hugging Face keeps ordinary web access logs under its own policy.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
70
  ## Privacy
71
 
72
  Uploaded layouts are processed in memory and held there only while the Space runs, to answer repeat requests. Nothing is written to permanent storage, and no file names or geometry are logged or kept. To enforce the daily limit, your Hugging Face username and your network address are turned into keyed hashes, held in memory and cleared at the end of the UTC day. They are never stored or logged. We keep only daily totals (runs per model and per layout size, refusals by reason, errors, response times and the number of distinct users that day) to understand how the demo is used. Hugging Face keeps ordinary web access logs under its own policy.
73
+
74
+ ## Citation
75
+
76
+ If you use SQuADDS or QCap in your work, please cite:
77
+
78
+ - S. Shanto *et al.*, "SQuADDS: A validated design database and simulation workflow for superconducting qubit design," *Quantum* **8**, 1465 (2024), [doi:10.22331/q-2024-09-09-1465](https://doi.org/10.22331/q-2024-09-09-1465).
79
+ - S. A. Shanto, S. Das and E. Levenson-Falk, "QCap: a physics-corrected graph neural network for the capacitance matrix of any planar superconducting device layout," [arXiv:2611.22057](https://arxiv.org/abs/2611.22057) (2026).
80
+
81
+ ```bibtex
82
+ @article{Shanto2024squaddsvalidated,
83
+ doi = {10.22331/q-2024-09-09-1465},
84
+ url = {https://doi.org/10.22331/q-2024-09-09-1465},
85
+ title = {{SQ}u{ADDS}: {A} validated design database and simulation workflow for superconducting qubit design},
86
+ author = {Shanto, Sadman and Kuo, Andre and Miyamoto, Clark and Zhang, Haimeng and Maurya, Vivek and Vlachos, Evangelos and Hecht, Malida and Shum, Chung Wa and Levenson-Falk, Eli},
87
+ journal = {{Quantum}},
88
+ issn = {2521-327X},
89
+ publisher = {{Verein zur F{\"{o}}rderung des Open Access Publizierens in den Quantenwissenschaften}},
90
+ volume = {8},
91
+ pages = {1465},
92
+ month = sep,
93
+ year = {2024}
94
+ }
95
+
96
+ @misc{Shanto2026planarcapacitance,
97
+ title = {{QCap}: a physics-corrected graph neural network for the capacitance matrix of any planar superconducting device layout},
98
+ author = {Shanto, Sadman Ahmed and Das, Saikat and Levenson-Falk, Eli},
99
+ year = {2026},
100
+ eprint = {2611.22057},
101
+ archivePrefix = {arXiv},
102
+ primaryClass = {quant-ph},
103
+ url = {https://arxiv.org/abs/2611.22057}
104
+ }
105
+ ```
geomgnn/app_flagship.py CHANGED
@@ -592,6 +592,8 @@ def build_app(title: str, examples_dir=None):
592
  report = gr.Markdown()
593
  with gr.Accordion("About", open=False):
594
  gr.Markdown(about_md(reg))
 
 
595
  gr.HTML(UI.footer(), container=False, padding=False, elem_classes="tl-flush")
596
  res_state = gr.State(None)
597
  vst = gr.State({})
 
592
  report = gr.Markdown()
593
  with gr.Accordion("About", open=False):
594
  gr.Markdown(about_md(reg))
595
+ with gr.Accordion("Cite", open=False):
596
+ gr.Markdown(UI.CITE_MD)
597
  gr.HTML(UI.footer(), container=False, padding=False, elem_classes="tl-flush")
598
  res_state = gr.State(None)
599
  vst = gr.State({})
geomgnn/ui.py CHANGED
@@ -188,6 +188,39 @@ def header(title: str, lede: str, meta: str | None = None, product: str | None =
188
  return f"<div id='tl-header'>{top}<p>{lede}</p>" + (f"<p class='tl-meta'>{meta}</p>" if meta else "") + "</div>"
189
 
190
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
191
  def footer() -> str:
192
  """Credit and copyright, as on the SQuADDS paper page."""
193
  site = "<a href='https://sadmanahmedshanto.com'>Sadman Ahmed Shanto</a>"
 
188
  return f"<div id='tl-header'>{top}<p>{lede}</p>" + (f"<p class='tl-meta'>{meta}</p>" if meta else "") + "</div>"
189
 
190
 
191
+ CITE_MD = r"""If you use SQuADDS or QCap in your work, please cite:
192
+
193
+ - S. Shanto *et al.*, "SQuADDS: A validated design database and simulation workflow for superconducting qubit design," *Quantum* **8**, 1465 (2024), [doi:10.22331/q-2024-09-09-1465](https://doi.org/10.22331/q-2024-09-09-1465).
194
+ - S. A. Shanto, S. Das and E. Levenson-Falk, "QCap: a physics-corrected graph neural network for the capacitance matrix of any planar superconducting device layout," [arXiv:2611.22057](https://arxiv.org/abs/2611.22057) (2026).
195
+
196
+ ```bibtex
197
+ @article{Shanto2024squaddsvalidated,
198
+ doi = {10.22331/q-2024-09-09-1465},
199
+ url = {https://doi.org/10.22331/q-2024-09-09-1465},
200
+ title = {{SQ}u{ADDS}: {A} validated design database and simulation workflow for superconducting qubit design},
201
+ author = {Shanto, Sadman and Kuo, Andre and Miyamoto, Clark and Zhang, Haimeng and Maurya, Vivek and Vlachos, Evangelos and Hecht, Malida and Shum, Chung Wa and Levenson-Falk, Eli},
202
+ journal = {{Quantum}},
203
+ issn = {2521-327X},
204
+ publisher = {{Verein zur F{\"{o}}rderung des Open Access Publizierens in den Quantenwissenschaften}},
205
+ volume = {8},
206
+ pages = {1465},
207
+ month = sep,
208
+ year = {2024}
209
+ }
210
+
211
+ @misc{Shanto2026planarcapacitance,
212
+ title = {{QCap}: a physics-corrected graph neural network for the capacitance matrix of any planar superconducting device layout},
213
+ author = {Shanto, Sadman Ahmed and Das, Saikat and Levenson-Falk, Eli},
214
+ year = {2026},
215
+ eprint = {2611.22057},
216
+ archivePrefix = {arXiv},
217
+ primaryClass = {quant-ph},
218
+ url = {https://arxiv.org/abs/2611.22057}
219
+ }
220
+ ```
221
+ """
222
+
223
+
224
  def footer() -> str:
225
  """Credit and copyright, as on the SQuADDS paper page."""
226
  site = "<a href='https://sadmanahmedshanto.com'>Sadman Ahmed Shanto</a>"