wfarah / psrdada-python

Python bindings to the PSRDada ringbuffer implementation

PSRDada Python

Python3 bindings to the ringbuffer implementation in PSRDada

It allows you to connect to a ringbuffer, read header info, and read/write ringbuffer pages as numpy arrays. I aim to be interoperable, and bug-for-bug compattible, with PSRDADA. It also supports reading multiple datasets from a ringbuffer for connecting to dada_dbevent.

This is a proof-of-concept implementation, only functions from PSRDADA immediately necessary for my project will be implemented. The code is inspired by the example code in the cython userguide

Error messages, together with a start-up and shutdown message, are written to the syslog. Depending on your OS, you can read those using:

 $ grep psrdada-python /var/log/syslog
 $ journalctl --since "10 minutes ago" | grep psrdada-python

Documentation

The documentation is available here See the two scripts in the examples directory, and the tests.

#!/usr/bin/env python3
import numpy as np
from psrdada import Reader

# Create a reader instace and connect to a running ringbuffer with key 'dada'
reader = Reader(0xdada)

# loop over the pages
for page in reader:
    # read the page as numpy array
    data = np.asarray(page)
    print(np.sum(data))

reader.disconnect()

Installation

clone the repository
git clone [e-mail]:AA-ALERT/psrdada-python.git change into the top-level directory
cd psrdada-python
install the dependencies (in a virtual env) python -m venv env && . env/bin/activate && pip install -f requirements.txt build the package make && make test && make install

Dependencies

PSRDada, see their website:

• PSRDada dada_db exectuable in the PATH for testing;

• PSRDada header files needed for compilation, set CPATH or CFLAGS.

• PSRDada library needed during runtime, set LD_LIBRARY_PATH

License

Copyright (c) 2018, Jisk Attema Apache Software License 2.0.

Contributing

All contributions are welcome! Please use the github issue tracker to get in touch.

Contributing authors so far:

• Jisk Attema
• Leon Oostrum
• Liam Connor
• Wael Farah