scintillation index doc changes

ojdf · Nov 18, 2024 · e4f826b · e4f826b
1 parent 7b2e55b
commit e4f826b
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/doc/output.rst b/doc/output.rst
@@ -18,6 +18,7 @@ Once completed, the simulation results can be found in ``sim.result`` (also retu
 - ``result.dB_abs`` - results in dB including all link budget terms, i.e. Rx power / Tx power
 - ``result.dBm`` - results in dBm including all terms in link budget
 - ``result.power`` - results in linear power, units of Watts
+- ``result.scintillation_index`` - scintillation index (variance of power normalised to mean power)
 
 Simulation results can be saved to FITS file with most simulation parameters as header information by calling the :py:func:`~fast.fast.Fast.save` function on the sim class
 

diff --git a/fast/fast.py b/fast/fast.py
@@ -934,6 +934,7 @@ class FastResult():
         dB_abs: results in dB including all terms in link budget (i.e. received power/launched power)
         dBm: results in dBm, including all terms in link budget
         power: results in received power, units of Watts
+        scintillation_index: scintillation index (variance of power/power.mean())
     '''
     def __init__(self, random_iters, diffraction_limit, header=None):
         self._r = random_iters