Commit 95ea0dcd authored by Tammo Jan Dijkema's avatar Tammo Jan Dijkema
Browse files

Fix markup for documentation

parent 777a3bdd
...@@ -3,9 +3,10 @@ ...@@ -3,9 +3,10 @@
This module contains some classes for conveniently working with the devices in the Dwingeloo This module contains some classes for conveniently working with the devices in the Dwingeloo
Telescope that communicate over GPIB (General Purpuse Interface Bus) or HPIB (presumably the Telescope that communicate over GPIB (General Purpuse Interface Bus) or HPIB (presumably the
HP variant of GPIB). Currently, three of these devices exist, on different HPIB addresses: HP variant of GPIB). Currently, three of these devices exist, on different HPIB addresses:
* Receiver (address 1)
* Local Oscillator (address 28), used for mixing signals to downconvert them - Receiver (address 1)
* Clock Generator (address 14), used as the clock for the FPGA - Local Oscillator (address 28), used for mixing signals to downconvert them
- Clock Generator (address 14), used as the clock for the FPGA
For each of the three devices a class exists. Setting and getting the frequency of these For each of the three devices a class exists. Setting and getting the frequency of these
devices is done by using their `frequency` attribute. devices is done by using their `frequency` attribute.
...@@ -21,10 +22,13 @@ Example: ...@@ -21,10 +22,13 @@ Example:
By default, the setter method of `frequency` checks if setting the device succeeded. This is a By default, the setter method of `frequency` checks if setting the device succeeded. This is a
blocking operation, but the HPIB bus is quite fast. blocking operation, but the HPIB bus is quite fast.
>>> lo.frequency = 1.e18 >>> lo.frequency = 1.e18
Traceback (most recent call last): Traceback (most recent call last):
RuntimeError: Setting frequency failed: tried to set to 1e+18 Hz, it is now 1100000000.0 Hz RuntimeError: Setting frequency failed: tried to set to 1e+18 Hz, it is now 1100000000.0 Hz
This checking can be disabled: This checking can be disabled:
>>> non_checking_lo = camrasdevices.LocalOscillator(check_frequency = False) >>> non_checking_lo = camrasdevices.LocalOscillator(check_frequency = False)
>>> non_checking_lo.frequency = 1.e18 >>> non_checking_lo.frequency = 1.e18
>>> non_checking_lo.frequency >>> non_checking_lo.frequency
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment