Skip to content
Snippets Groups Projects

RAP-840 Add Read the Docs

Merged RAP-840 Add Read the Docs
All threads resolved!
Merged Mick Veldhuis requested to merge rap-840-add-docs into main
All threads resolved!
1 file
+ 27
4
Compare changes
  • Side-by-side
  • Inline
Downloading and Installation
============================
Instructions for downloading and installing the Pre-Processing Pipeline are summarised below and also available on the GitLab page.
Instructions for downloading and installing the Pre-Processing Pipeline are summarised below and also available on its `GitLab page <https://git.astron.nl/RD/preprocessing-cwl>`_.
Obtaining the Pre-Processing Pipeline
-------------------------------------
Perform a git clone.
The pipeline consists of Common Workflow Language (CWL) workflows, which can be obtained with:
.. code:: console
$ git clone https://git.astron.nl/RD/preprocessing-cwl
Manual Installation
-------------------
Describe the process of building on scratch...
To run the pipeline, you need a CWL runner, such as ``cwltool`` or ``toil``. It's recommended to install these in a virtual environment:
.. code:: console
$ python3 -m venv venv
$ source venv/bin/active
$ pip install cwltool toil[cwl]
Note that it is also necessary to install NodeJS, which can either be installed via your favourite package manager or using the ``nodejs-wheel`` Python package.
Additionally, the Pre-Processing Pipeline depends on the following software for processing:
* `LofarStMan <https://github.com/lofar-astron/LofarStMan>`_
* `AOFlagger <https://gitlab.com/aroffringa/aoflagger>`_
* `DP3 <https://git.astron.nl/RD/DP3>`_
* `SAGECal <https://github.com/nlesc-dirac/sagecal>`_
* `Casacore <https://github.com/casacore/casacore>`_
Please follow their respective installation instructions.
Docker Installation
-------------------
Descibe obtaining a docker image...
Installing and running the pipeline with a Docker container is currently not suported.
Loading