From 5ac2e36c4f89d106d1138cfa655a88530ead045d Mon Sep 17 00:00:00 2001
From: Jean-Baptiste Bayle <j2b.bayle@gmail.com>
Date: Tue, 13 Dec 2022 15:33:11 +0100
Subject: [PATCH] Fix documentation
---
lisainstrument/instrument.py | 9 +++------
1 file changed, 3 insertions(+), 6 deletions(-)
diff --git a/lisainstrument/instrument.py b/lisainstrument/instrument.py
index e05d46b..e48307e 100755
--- a/lisainstrument/instrument.py
+++ b/lisainstrument/instrument.py
@@ -147,8 +147,8 @@ class Instrument:
clock_freqoffsets: dictionary of clock frequency offsets [s^-1], or 'default'
clock_freqlindrifts: dictionary of clock frequency linear drifts [s^-2], or 'default'
clock_freqquaddrifts: dictionary of clock frequency quadratic drifts [s^-2], or 'default'
- clockinv_tolerance: convergence tolerance for timer deviation inversion [s]
- clockinv_maxiter: maximum number of iterations for timer deviation inversion
+ clockinv_tolerance: convergence tolerance for clock noise inversion [s]
+ clockinv_maxiter: maximum number of iterations for clock noise inversion
backlink_asds: dictionary of amplitude spectral densities for backlink noise [m/sqrt(Hz)]
backlink_fknees: dictionary of cutoff frequencied for backlink noise [Hz]
testmass_asds: dictionary of amplitude spectral densities for test-mass noise [ms^(-2)/sqrt(Hz)]
@@ -851,10 +851,7 @@ class Instrument:
self.sync_asds = ForEachSC(0)
def disable_clock_noises(self):
- """Turn off all imperfections on clocks.
-
- This includes offsets, and frequency offsets and deviations.
- """
+ """Turn off all imperfections on clocks."""
self.clock_asds = ForEachSC(0)
self.clock_offsets = ForEachSC(0)
self.clock_freqoffsets = ForEachSC(0)
--
GitLab