Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Dinesh Pinto <[email protected]>
  • Loading branch information
dineshpinto committed May 7, 2023
1 parent bca430a commit abe4e89
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ sidestepped by lazy loading data and storing metadata instead wherever possible.
pip install qudi-hira-analysis
```

### Update to latest version

```bash
pip install --upgrade qudi-hira-analysis
```

## Citation

If you are publishing scientific results, you can cite this work as: https://doi.org/10.5281/zenodo.7604670
Expand Down Expand Up @@ -193,7 +199,7 @@ dh.save_figures(filepath="rabi_variation", fig=fig)
### Example 5: Temperature data

```python
temperature_measurements = dh.load_measurements(measurement_str="Temperature")
temperature_measurements = dh.load_measurements(measurement_str="Temperature", qudi=False)

temperature = pd.concat([t.data for t in temperature_measurements.values()])

Expand All @@ -202,6 +208,17 @@ sns.lineplot(data=temperature, x="Time", y="Temperature", ax=ax)
dh.save_figures(filepath="temperature_monitoring", fig=fig)
```

### Example 6: PYS data (pi3diamond compatibility)

```python
pys_measurements = dh.load_measurements(measurement_str="ndmin", extension=".pys", qudi=False)
pys = pys_measurements[list(pys_measurements)[0]].data

fig, ax = plt.subplots()
sns.lineplot(x=pys["time_bins"], y=pys["counts"], ax=ax)
dh.save_figures(filepath="pys_measurement", fig=fig)
```

## Measurement Dataclass Schema

```mermaid
Expand Down Expand Up @@ -233,7 +250,8 @@ flowchart LR

## Supports common fitting routines

To get the full list of available fit routines, use the `dh.fit_function` attribute. The fit functions are:
To get the full list of available fit routines, explore the `dh.fit_function` attribute or call `dh.get_all_fits()`. The
fit functions are:

| Dimension | Fit |
|-----------|-------------------------------|
Expand Down

0 comments on commit abe4e89

Please sign in to comment.