Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Reorganise documentation #47

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 2 additions & 31 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,39 +5,10 @@ Usage
Command Line
------------

The flagger can be run from the command line::
The flagger can be run from the command line.
Read the help for further details::

$ tricolour --help
usage: tricolour [-h] [-c CONFIG] [-if] [-fs {standard,polarisation}]
[-rc ROW_CHUNKS] [-nw NWORKERS]
ms

positional arguments:
ms Measurement Set

optional arguments:
-h, --help show this help message and exit
-c CONFIG, --config CONFIG
YAML config file containing parameters for the flagger
in the 'sum_threshold' key. (default: )
-if, --ignore-flags
-fs {standard,polarisation}, --flagging-strategy {standard,polarisation}
Flagging Strategy. If 'standard' all correlations in
the visibility are flagged independently. If
'polarisation' the polarised intensity sqrt(Q^2 + U^2
+ V^2) is calculated and used to flag all correlations
in the visibility. (default: standard)
-rc ROW_CHUNKS, --row-chunks ROW_CHUNKS
Hint indicating the number of Measurement Set rows to
read in a single chunk. Smaller and larger numbers
will tend to respectively decrease or increase both
memory usage and computational efficiency (default:
10000)
-nw NWORKERS, --nworkers NWORKERS
Number of workers (threads) to use. By default, set to
twice the number of logical CPUs on the system. Many
workers can also affect memory usage on systems with
many cores. (default: 16)

Sample Configuration Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down