diff --git a/README.md b/README.md index 0c7d7109bba73a86b2993221e8adfb9de6e5aa7e..b8cc9ce1ba55c8fd5adc1bb622094e63ef130b35 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,16 @@ # VLBI for EDD -This repository is currently under development.It contains a set of EDD-based components to support VLBI operation modes. The major usecase is the digital -downconversion of baseband signal. The digital downconverter processes the incoming baseband data into several narrower sidechannel bands. The sidechannels are packed into VDIF +The EDD (Effelsberg Direct Digitization) is a modular concept for radioastronomy systems, including receivers, time distribution, digitization, packetization and data processing in the backend. + +This repository is a EDD backend plugin used for VLBI operations, but it also has proven in other usecases. ## Requirements - CUDA 11.0 or greater (and cuBLAS) - C++ libs - psrdada, psrdada_cpp, boost, Google Testframework - python3 - numpy, matplotlib, scipy, cupy, cusignal -## Installtion -The repository implements a python module and C++ based command line tools. Get the latest version of this repository by cloning - -`git clone https://gitlab.mpcdf.mpg.de/mpifr-bdg/edd_dbbc` - -Change the directory to the root directory of the project. - -`cd edd_dbbc` - -Note: It is highly recommended to install the project within a `edd_base` Docker image. - -### Install Python -The `pyproject.toml`-file allows a installation of the `dbbc`-module via pip. - -`pip install .` - -Make sure all requirements are satisfied. - -### Install C++ -The C++ project (`edd_dbbc`) is managed by CMake. First, create a folder for the output files of cmake (e.g. `bin`) - -`mkdir bin && cd bin` - -Run cmake - -`cmake .. -DPSRDADA_INCLUDE_DIR=/usr/local/include/psrdada -DPSRDADACPP_INCLUDE_DIR=/usr/local/include/psrdada_cpp` - -Compile and build - -`make -j8 && make install` - -Optionally, test the compiled code - -`make test` - ## Documentation -Documentation can be found here: <http://mpifr-bdg.pages.mpcdf.de/edd_dbbc/> +- Documentation can be found here: <http://mpifr-bdg.pages.mpcdf.de/edd_dbbc/> ## Contact Author: Niclas Esser - <nesser@mpifr-bonn.mpg.de>