Skip to content

Commit

Permalink
updated docs based on reconfiguration
Browse files Browse the repository at this point in the history
  • Loading branch information
dkweiss31 committed Sep 29, 2024
1 parent 876200d commit 3ac41cc
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/floquet.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,30 @@ The **floquet** Python API consists largely of the **floquet_analysis** function
options:
show_source: false

## Displaced state

::: floquet.displaced_state
options:
show_source: false

## Drive parameters

::: floquet.drive_parameters
options:
show_source: false

## Amplitude conversion utilities

::: floquet.amplitude_converters
options:
show_source: false

## Options

::: floquet.options
options:
show_source: false

## File utilities

::: floquet.utils.file_io
Expand Down
7 changes: 7 additions & 0 deletions floquet/floquet.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,13 @@ def floquet_analysis_from_file(filepath: str) -> FloquetAnalysis:


class FloquetAnalysis:
"""Class containing methods for performing full Floquet analysis.
This class should be instantiated by calling the function floquet_analysis().
In most workflows, one needs only then to call then run() method which performs
both the displaced state fit and the Blais branch analysis. For an example
workflow, see the [transmon](../examples/transmon) tutorial.
"""
def __init__(
self,
H0: qt.Qobj,
Expand Down

0 comments on commit 3ac41cc

Please sign in to comment.