diff --git a/README.md b/README.md index 1e92eb1..f5a1965 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ We are now ready to create an instance of the `FloquetAnalysis` class, and run t floquet_analysis = ft.FloquetAnalysis(model, state_indices=state_indices) data_vals = floquet_analysis.run() ``` -`data_vals` is a dictionary containing all quantities computed during the call to `run()`. This includes the overlap with the "ideal" displaced state, which can be plotted to reveal "scars" in the drive frequency and amplitude space where resonances occur. This part of the analysis is based on [Xiao, Venkatraman et al, arXiv (2023)](https://arxiv.org/abs/2304.13656), see Appendices I and J. Additionally we perform a so-called branch analysis to understand which states are responsible for ionization, based on [Dumas et al, arXiv 2024](https://arxiv.org/abs/2402.06615). See the [demo](https://github.com/dkweiss31/floquet/blob/main/docs/examples/transmon.ipynb) for more details on the analysis and how to plot and visualize the computed quantities. +`data_vals` is a dictionary containing all quantities computed during the call to `run()`. This includes the overlap with the "ideal" displaced state, which can be plotted to reveal "scars" in the drive frequency and amplitude space where resonances occur. This part of the analysis is based on [Xiao, Venkatraman et al, arXiv (2023)](https://arxiv.org/abs/2304.13656), see Appendices I and J. Additionally we perform a so-called branch analysis to understand which states are responsible for ionization, based on [Dumas et al, arXiv 2024](https://arxiv.org/abs/2402.06615). See the [demo](https://github.com/dkweiss31/floquet/blob/main/docs/examples/demo.ipynb) for more details on the analysis and how to plot and visualize the computed quantities. ## Citation diff --git a/docs/examples/transmon.ipynb b/docs/examples/demo.ipynb similarity index 100% rename from docs/examples/transmon.ipynb rename to docs/examples/demo.ipynb diff --git a/mkdocs.yml b/mkdocs.yml index 18ba3aa..015b273 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -69,4 +69,4 @@ nav: - API: - 'floquet.md' - Examples: - - Transmon: 'examples/transmon.ipynb' + - Transmon: 'examples/demo.ipynb'