Build instructions

Dependencies

EveryBeam needs a number of dependencies in order to successfully compile. On a clean (Ubuntu 20.04) system, the dependencies can be installed with (see also the docker directory):

General packages:

apt-get -y install wget git make cmake g++ doxygen \
libboost-all-dev libhdf5-dev libfftw3-dev \
libblas-dev liblapack-dev libxml2-dev \
libgtkmm-3.0-dev libpython3-dev python3-distutils

Astronomy-specific packages:

apt-get -y install casacore-dev libcfitsio-dev wcslib-dev

Versions of EveryBeam after 0.6.2 require Casacore 3.6. Currently, this version is not in Ubuntu/Debian: as long as this is the case it is required to built Casacore from source (see the Casacore repository for instructions). Versions of EveryBeam after 0.6.2 also require gcc version 10 or later.

To be able to build the documentation with make doc, sphinx and some other documentation tools need to be installed:

pip3 install sphinx sphinx_rtd_theme breathe myst-parser

Quick installation guide

git clone --recursive -j4 https://git.astron.nl/RD/EveryBeam.git
cd EveryBeam
mkdir build && cd build
cmake -DCMAKE_INSTALL_PREFIX=<everybeam_install_path> ..
make install

Installation options

(Use ccmake or cmake -i to configure all options.)

  • BUILD_WITH_PYTHON: build Python module ‘everybeam’ to use everybeam from Python

  • BUILD_TESTING: compile tests when building EveryBeam

  • DOWNLOAD_LOBES: download and install available LOBEs coefficients files (OFF by default)

  • DOWNLOAD_LWA: download and install OVRO-LWA coefficients file (OFF by default)

  • EVERYBEAM_DATADIR: override the directory where EveryBeam searches for its data files; a relative path will be prefixed with the install prefix.

All other build options serve development purposes only, and can/should be left at the default values by a regular user.

All libraries are installed in <installpath>/lib. The header files in <installpath>/include. The Python module in <installpath>/lib/python{VERSION_MAJOR}.{VERSION_MINOR}/site-packages. Make sure that your LD_LIBRARY_PATH and PYTHONPATH are set as appropiate. Data files, such as coefficient files for the Hamaker model, the SKALA4.0 model (OSKAR), the OVRO-LWA model (if DOWNLOAD_LWA=On), and the LOBEs model (if DOWNLOAD_LOBES=On) are installed in <installpath>/share/everybeam.