Skip to content

Commit

Permalink
#50 hotfix update API doc front page
Browse files Browse the repository at this point in the history
  • Loading branch information
crnbaker committed Jan 24, 2024
1 parent a316cac commit 1af0930
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions src/spectrumdevice/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@
| `SpectrumDigitiserCard` | Controlling individual digitiser cards |
| `SpectrumDigitiserStarHub` | Controlling digitiser cards aggregated with a StarHub |
| `SpectrumDigitiserAnalogChannel` | Controlling analog channels of a digitiser |
| `SpectrumDigitiserIOLine` | Controlling multipurpose IO channels of a digitiser |
| `SpectrumDigitiserIOLine` | Controlling multipurpose IO lines of a digitiser |
| `SpectrumAWGCard` | Controlling individual AWG cards |
| `SpectrumAWGStarHub` | (not yet implemented) |
| `SpectrumAWGAnalogChannel` | Controlling analog channels of an AWG |
| `SpectrumAWGIOLine` | Controlling multipurpose IO channels of an AWG |
| `SpectrumAWGIOLine` | Controlling multipurpose IO lines of an AWG |
| `PulseGenerator` | Controlling pulse generators belonging to IO lines |
### Mock Classes
`spectrumdevice` also includes mock classes for testing software without drivers installed or hardware connected:
Expand Down Expand Up @@ -62,9 +63,10 @@

from spectrumdevice.measurement import Measurement
from .devices.digitiser.digitiser_card import SpectrumDigitiserCard
from .devices.digitiser.digitiser_channel import SpectrumDigitiserAnalogChannel
from .devices.digitiser.digitiser_channel import SpectrumDigitiserAnalogChannel, SpectrumDigitiserIOLine
from .devices.digitiser.digitiser_star_hub import SpectrumDigitiserStarHub
from .devices.awg.awg_card import SpectrumAWGCard
from .devices.awg.awg_channel import SpectrumAWGAnalogChannel, SpectrumAWGIOLine
from .devices.mocks import MockSpectrumDigitiserCard, MockSpectrumDigitiserStarHub, MockSpectrumAWGCard
from .devices.abstract_device import (
AbstractSpectrumDevice,
Expand All @@ -73,9 +75,11 @@
AbstractSpectrumStarHub,
)
from .devices.digitiser.abstract_spectrum_digitiser import AbstractSpectrumDigitiser
from .features.pulse_generator.pulse_generator import PulseGenerator

__all__ = [
"SpectrumDigitiserAnalogChannel",
"SpectrumDigitiserIOLine",
"SpectrumDigitiserCard",
"SpectrumDigitiserStarHub",
"MockSpectrumDigitiserCard",
Expand All @@ -89,6 +93,9 @@
"Measurement",
"SpectrumAWGCard",
"MockSpectrumAWGCard",
"SpectrumAWGAnalogChannel",
"SpectrumAWGIOLine",
"PulseGenerator",
]


Expand Down

0 comments on commit 1af0930

Please sign in to comment.