Skip to content
Snippets Groups Projects

RAP-840 Add Read the Docs

Merged Mick Veldhuis requested to merge rap-840-add-docs into main
1 file
+ 3
5
Compare changes
  • Side-by-side
  • Inline
+ 3
5
@@ -42,8 +42,6 @@ User-defined parameters
* ``avg_timestep``: this parameter defines the number of time steps that will be averaged.
* ``avg_freqstep``: this parameter defines the number of channels that will be averaged.
**Optional parameters:**
*Flagging options:*
@@ -57,7 +55,7 @@ User-defined parameters
* ``demix_skymodel``: the skymodel used by the demixing algorithm (default: ``Ateam.skymodel``).
* ``demix_sources``: the list of sources to demix, e.g., ``[CasA, CygA]``. Note that these sources have to be present in the provided skymodel. (default: ``[]``.)
* ``demix_baselines``: select the baselines used to demix, the baseline selection syntax is described in the `DP3 documentation <https://dp3.readthedocs.io/en/latest/steps/Description%20of%20baseline%20selection%20parameters.html>`_ (default: ``[CR]S*&``).
* ``demix_ignoretarget``: set this parameter to false if you want to project the target away, if set to true the target will be ignored (default: ``false``).
* ``demix_ignoretarget``: if set to ``true``, the source model of the target will not be taken into account during demixing, i.e., the target will be ignored (default: ``false``).
* ``demix_lbfgs_robustdof``: the degrees of freedom of the LBFGS solver noise model (default: ``200``).
* ``demix_lbfgs_historysize``: the history size the LBFGS solver uses to approximate the inverse Hessian (default: ``10``).
@@ -69,6 +67,6 @@ User-defined parameters
*Miscellaneous parameters:*
* ``sasid``: identifier of the SAS process that called the pipeline; this unique identifier is prefixed with an 'L'.
* ``msin_autoweight``: set this parameter to true when the input consist of raw LOFAR data, this will ensure proper weights are set (default ``true``).
* ``sasid``: identifier of the SAS process that called the pipeline; this unique identifier is prefixed with an 'L'. The SASID is used to name the output MSs, and replaces the Observation ID (default: reuse Observation ID).
* ``msin_autoweight``: set this parameter to true when the input consist of raw LOFAR data, this will ensure proper weights are set (default: ``true``).
* ``dp3_numthreads``: the number of threads per process used by DP3 (default: ``10``).
Loading