summaryrefslogtreecommitdiffstats
path: root/host/docs/calibration.rst
diff options
context:
space:
mode:
authorNicholas Corgan <nick.corgan@ettus.com>2012-03-29 14:47:54 -0700
committerNicholas Corgan <nick.corgan@ettus.com>2012-03-29 14:47:54 -0700
commitd1ad808f78497db2770a346d560c9a7f21ff1f1f (patch)
tree0bf27335a10927460f4a2c5747c8e74f64c9bdc9 /host/docs/calibration.rst
parenta67486fff0b75a08072fe66b2c6c314cb4b3a16a (diff)
downloaduhd-d1ad808f78497db2770a346d560c9a7f21ff1f1f.tar.gz
uhd-d1ad808f78497db2770a346d560c9a7f21ff1f1f.tar.bz2
uhd-d1ad808f78497db2770a346d560c9a7f21ff1f1f.zip
docs: Format consistency, such as representation of program names or filepaths
Diffstat (limited to 'host/docs/calibration.rst')
-rw-r--r--host/docs/calibration.rst19
1 files changed, 9 insertions, 10 deletions
diff --git a/host/docs/calibration.rst b/host/docs/calibration.rst
index 14e66a312..680a74f3b 100644
--- a/host/docs/calibration.rst
+++ b/host/docs/calibration.rst
@@ -7,10 +7,10 @@ UHD - Calibration Application Notes
------------------------------------------------------------------------
Self-calibration
------------------------------------------------------------------------
-The UHD comes with several self-calibration utilities for minimizing IQ imbalance and DC offset.
+UHD comes with several self-calibration utilities for minimizing IQ imbalance and DC offset.
These utilities perform calibration sweeps using transmit leakage into the receive path
(special equipment is not required).
-The results from a calibration are written to a csv file in the user's home directory.
+The results from a calibration are written to a CSV file in the user's home directory.
UHD will automatically apply corrections at runtime when the user re-tunes the daughterboard LO.
Calibration results are specific to an individual RF board.
@@ -21,10 +21,9 @@ the user should re-apply the desired setting every time the LO is re-tuned.
UHD comes with the following calibration utilities:
- * **uhd_cal_rx_iq_balance:** - mimimizes RX IQ imbalance vs LO frequency
- * **uhd_cal_tx_dc_offset:** - mimimizes TX DC offset vs LO frequency
- * **uhd_cal_tx_iq_balance:** - mimimizes TX IQ imbalance vs LO frequency
-
+ * **uhd_cal_rx_iq_balance:** - mimimizes RX IQ imbalance vs. LO frequency
+ * **uhd_cal_tx_dc_offset:** - mimimizes TX DC offset vs. LO frequency
+ * **uhd_cal_tx_iq_balance:** - mimimizes TX IQ imbalance vs. LO frequency
The following RF frontends are supported by the self-calibration utilities:
@@ -33,9 +32,9 @@ The following RF frontends are supported by the self-calibration utilities:
* more to come...
********************************************
-Calibration utilities
+Calibration Utilities
********************************************
-UHD installs the calibration utilities into <install-path>/bin.
+UHD installs the calibration utilities into **<install-path>/bin**.
**Disconnect** any extrernal hardware from the RF antenna ports,
and run the following from the command line.
Each utility will take several minutes to complete.
@@ -49,13 +48,13 @@ See the output given by --help for more advanced options, such as:
manually choosing the frequency range and step size for the sweeps.
********************************************
-Calibration data
+Calibration Data
********************************************
Calibration files are stored in the user's home/application directory.
They can easily be moved from machine to another by copying the "cal" directory.
Re-running a calibration utility will replace the existing calibration file.
The old calibration file will be renamed so it may be recovered by the user.
- * **Unix:** ${HOME}/.uhd/cal/
+ * **Linux:** ${HOME}/.uhd/cal/
* **Windows:** %APPDATA%\\.uhd\\cal\\