Skip to content

Commit 88f2f8a

Browse files
authored
Update README.md
1 parent c714297 commit 88f2f8a

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ QFit is your go-to Python application for extracting parameters of superconducti
1919

2020
1. **Calibration**: QFit helps to establish the mapping from voltage (your experimental tunable input) to circuit parameters (your simulation ingredients).
2121

22-
2. **Point Extraction**: With just a click, you can locate the peak of the spectrum sweep data with computer-assistance. The extracted data can be simply grouped as a transition and labeled. QFit even provides filters and coloring options for enhancing data visualization.
22+
2. **Point Extraction**: With just a click, you can locate the resonance peak in the spectroscopy data with computer-assistance. The extracted data can be simply grouped as a transition and labeled. QFit even provides filters and coloring options for enhancing data visualization.
2323

2424
3. **Interactive Pre-fit**: See your numerical model result and the data on the same plot for intuitive comparison. Adjust the numerical simulator with simple sliders to improve your fit.
2525

@@ -29,8 +29,8 @@ QFit supports a wide variety of circuit quantum electrodynamic systems, thanks t
2929

3030
Join us in refining QFit during its beta phase! Your insights and reports are invaluable in making QFit a robust tool for this community. Dive in and explore what QFit can do for you, and let us know your experience!
3131

32-
Installation and Usage
33-
----------------------
32+
Installation
33+
------------
3434

3535
Follow these steps to install `QFit`:
3636

@@ -50,7 +50,9 @@ Once done, the application can be launched in a jupyter notebook session via
5050
```
5151
where `<HilbertSpace>` is a `scqubits.HilbertSpace` object, the circuit model you want to fit against.
5252

53-
Check out the notebook [QFit_Quick_Start.ipynb](./example_notebooks/QFit_Quick_Start.ipynb) for a quick tutorial, and [QFit_Advanced_Tips.ipynb](./example_notebooks/QFit_Advanced_Tips.ipynb) for further information.
53+
Usage
54+
-----
55+
Please check out the notebook [QFit_Quick_Start.ipynb](./example_notebooks/QFit_Quick_Start.ipynb) for a quick tutorial, and [QFit_Advanced_Tips.ipynb](./example_notebooks/QFit_Advanced_Tips.ipynb) for further information.
5456

5557
> [!NOTE]
5658
> While you can install QFit with `pip install qfit`, this application is unstable on machines with Apple silicons. This is due to compatibility issues with pip-installed `scipy`. As a workaround, you can run `conda install scipy` afterward, though using conda for the full installation is preferred.

0 commit comments

Comments
 (0)