Skip to content

Commit 052b58a

Browse files
Update docs
1 parent 99ba69d commit 052b58a

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

docs/source/components.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ The stage-specific steps (usually step 7) derive additional solutions which are
4747
- Stage **5.+close** applies global fringe closing solutions.
4848

4949
The post-processing stages are not part of the main pipeline workflow, but are run as needed.
50-
- Stage 6 (**6.uvfits**) creates uvfits files from the fringe-fitted data in mk4 format. Starting from this stage, the uvfits files are used as inputs
51-
for the subsequent stages.
50+
- Stage 6 (**6.uvfits**) creates uvfits files from the fringe-fitted data in mk4 format. Starting from this stage, the uvfits files are used as inputs for the subsequent stages.
5251
- Stage 7 (**7.apriori**) performs apriori amplitude calibration (after deriving SEFDs using metadata from *antab*, *vex*, and *array.txt* files) and field angle rotation correction.
52+
- Stage 8 (**8.+polcal**) performs R/L gain ratio calibration.
5353

5454
Automatic simultaneous multi-band data processing is not supported by the pipeline yet. Each band is processed independently.
55-
To avoid code duplication, symbolic links to scripts in band 1 (**hops-b1**) are used to run other bands.
55+
To avoid code duplication, symbolic links to scripts in band 1 (**hops-b1**) are placed in the directories corresponding to the other bands.
5656

5757
.. _data-organization:
5858

@@ -96,9 +96,15 @@ is structured as follows:
9696
- <track>.vex
9797
- array.txt
9898

99+
.. note::
100+
101+
The *antab* directory can become quite large and is therefore not included with the pipeline by default. Users must ensure that the
102+
*antab* directory is available in the metadata directory. In contrast, the *vex* and *array.txt* files are relatively small and are
103+
included with the pipeline.
104+
99105
While running the pipeline, the user must set the environment variable **METADIR** to point to the metadata directory for the
100106
campaign and frequency being processed so that a typical value looks as follows::
101107

102108
SET_METADIR=/path/to/ehthops/meta/<campaign>/<frequency>
103109

104-
The parent directory of *<campaign>/<frequency>* need not be *ehthops/meta* but must be set in the environment variable **METADIR**.
110+
**METADIR** (i.e., the parent directory of *<campaign>/<frequency>*) can point to any location containing the metadata. It need not be the default location *ehthops/meta*.

0 commit comments

Comments
 (0)