Skip to content

Commit

Permalink
doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ojdf committed Nov 13, 2023
1 parent 3346f16 commit 9427b1d
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
2 changes: 1 addition & 1 deletion doc/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ FAST accepts a number of configuration parameters, which must be defined in a py

Some things to keep in mind:

- Some parameters can be set to ``"auto"``, in which case the simulation will *attempt* to select parameters that will provide good results. This is not a guarantee that the parameters will be optimal for your particular setup!
- Some parameters can be set to ``"auto"`` or ``"opt"``, in which case the simulation will *attempt* to select parameters that will provide good results. This is not a guarantee that the parameters will be optimal for your particular setup!
- FAST expects atmospheric turbulence profiles in units of :math:`C_n^2 (h) \, \mathrm{d}h`, i.e. **integrated** Cn2 for each layer, units m :sup:`1/3`
- Some analytical atmopsheric turbulence models (HV57, Bufton wind model) are provided with useful functions in :py:mod:`fast.turbulence_models`

Expand Down
1 change: 1 addition & 0 deletions doc/output.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Once completed, the simulation results can be found in ``sim.result`` (also retu

- ``result.dB_rel`` - results in dB relative to the diffraction limit (no turbulence).
- ``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

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
Expand Down

0 comments on commit 9427b1d

Please sign in to comment.