Metadata-Version: 2.1
Name: rapthor
Version: 1.0
Summary: Rapthor: LOFAR DDE Pipeline
Home-page: https://git.astron.nl/RD/rapthor
Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 4 - Beta
Classifier: Natural Language :: English
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: astropy
Requires-Dist: jinja2
Requires-Dist: shapely
Requires-Dist: toil[cwl] (!=5.6,!=5.8)
Requires-Dist: reproject
Requires-Dist: python-dateutil
Requires-Dist: Rtree
Requires-Dist: lsmtool
Requires-Dist: losoto
Requires-Dist: bdsf
Requires-Dist: python-casacore

Rapthor: LOFAR DDE Pipeline
===========================

Rapthor is an experimental pipeline for correcting direction-dependent effects in LOFAR data. It uses DPPP and WSClean to derive and apply the corrections in facets or as smooth 2-D screens. It uses [CWL](https://www.commonwl.org) for the pipeline language and [Toil](http://toil.ucsc-cgl.org) to run the pipelines.

## Documentation

Extensive documentation can be found on [Read the Docs](https://rapthor.readthedocs.io/en/latest/).


Installation
------------

To install rapthor, follow the instructions below.


### Dependencies

Rapthor requires the following packages (beyond those installed automatically with rapthor):

* [WSClean](https://gitlab.com/aroffringa/wsclean) (version 2.9 or later; building with [IDG](https://gitlab.com/astron-idg/idg) and [EveryBeam](https://git.astron.nl/RD/EveryBeam) is required)
* [DP3](https://git.astron.nl/RD/DP3) (version v4.1 or later; building with [Dysco](https://github.com/aroffringa/dysco) and [EveryBeam](https://git.astron.nl/RD/EveryBeam) is required)
* [LSMTool](https://git.astron.nl/RD/LSMTool) (version 1.4.2 or later)
* [LoSoTo](https://github.com/revoltek/losoto) (version 2.0 or later)
* [PyBDSF](https://github.com/lofar-astron/PyBDSF) (version 1.9.2 or later)

### Downloading and Installing

Get the latest developer version by cloning the git repository:

    git clone https://git.astron.nl/RD/rapthor.git

Then install with:

    cd rapthor
    pip install .

Or, alternatively, in one go:

    pip install git+https://git.astron.nl/RD/rapthor.git

Usage
-----

The `rapthor` executable can be used from the command line with
a parset that defines the parameters of the run. E.g.:

    $ rapthor rapthor.parset

The parset defines the input and working directories, various options, etc. For details,
please see the example parset in the examples directory.
