# Backend Simulation Tool for Phased Array Feeds (PAFs)
This repository contains the `pafsim` python module. The module implements various PAF backend components such as Correlator, Beamforer, Calibrator etc. The purpose of this module is a comprehensive simulation tool for PAF backends which may act like a "golden reference" for real world PAFs.
The PAF Backend Simulator is part of the [Radioblocks]() project. The counterpart to this project is the [PAF Frontend Simulator](https://gitlab.mpcdf.mpg.de/yayian/paffrontendsimpublic). Both the front- and backend simulator share an interface allowing to generate realisitic datasets.
## Install
It is recommended to create a virtual environment before installing the packaged.
...
...
@@ -24,8 +26,9 @@ All required dependencies are resolved.
## Documentation
The API documentation and user guide can be found [here]().
The repository contains a comprehensive jupyter notebook on how to use the `pafsim` module. It can be found in the `example` folder.
The API documentation and user guide can be found [here](https://nesser.pages.mpcdf.de/pafsim/).
Jupyter notebook's on how to use the `pafsim` module are in the `example`-folder.
