Package: blimpy
Breakthrough Listen I/O Methods for Python.Filterbank + Raw file readersThis repository contains Python 2/3 readers for interacting withSigproc filterbank(.fil), HDF5 (.h5) andguppi raw(.raw) files,
as used in theBreakthrough Listensearch for intelligent life.InstallationSystem DependenciesSometimes thepipinstallation can fail if a system dependency is not installed. To fix this, make sure you havecurland install the required system dependencies with the command bellow:Debian/Ubuntucurl https://raw.githubusercontent.com/UCBerkeleySETI/blimpy/master/dependencies.txt | xargs -n 1 sudo apt install --no-install-recommends -yManual InstallationThe latest release can be installed via pip directly from this repository:python3 -m pip install -U git+https://github.com/UCBerkeleySETI/blimpyOr, the latest version of the development code can be installed from the githubrepoand then runpython setup.py installorpip install .(with sudo if required), or by using the following terminal command:python3 -m pip install -U https://github.com/UCBerkeleySETI/blimpy/tarball/masterTo install everything required to run the unit tests, run:python3 -m pip install -e .[full]You will neednumpy,h5py,astropy,scipy, andmatplotlibas dependencies. Apip installshould pull in numpy, h5py, and astropy, but you may still need to install scipy and matplotlib separately.
To interact with compressed files, you'll need thehdf5pluginpackage too.Note that h5py generally needs to be installed in this way:$ python3 -m pip install --no-binary=h5py h5pyCommand line utilitiesAfter installation, the following command will display the metadata (header) values and some information about the data matrix:watutil  -iOther command line utilities available post-installation:bldice, Extract a smaller frequency region from a Filterbank file (.fil or .h5 file).calcload, Calculate the Waterfall max_load value needed to load the entire data array for a given Filterbank file.dsamp, Down-sample (time-dimension only) from one Filterbank file to another.fil2h5, Convert a .fil file into .h5 format.h52fil, Convert an .h5 file into .fil format.matchfils, Check if two .fil files are the same.peek, Display a selected portion of values from the data matrix of a Filterbank file.rawhdr, Display the header fields of a raw guppi file.rawutil, Plot data in a guppi raw file.srcname, Patch the header source_name field in a .h5 file.stax, For a collection of .h5 or .fil files sharing the same frequency range, create a vertical stack of waterfall plots as a single PNG file.stix, For a single very large Filterbank file, create a horizontal or vertical stack of waterfall plots as a single PNG file.watutil, Information/read/write/plot utility for Filterbank files.Use the-hflag to any of the above command line utilities to display their available arguments.Reading blimpy filterbank files in .fil or .h5 formatTheblimpy.Waterfallprovides a Python API for interacting with filterbank data. It supports all BL filterbank data products; see thisexample Jupyter notebookfor an overview.From the python, ipython or jupiter notebook environments.fromblimpyimportWaterfallfb=Waterfall('/path/to/filterbank.fil')#fb = Waterfall('/path/to/filterbank.h5') #works the same wayfb.info()data=fb.dataReading guppi raw filesTheGuppi Raw formatcan be read using theGuppiRawclass fromguppi.py:fromblimpyimportGuppiRawgr=GuppiRaw('/path/to/guppirawfile.raw')header,data=gr.read_next_data_block()orfromblimpyimportGuppiRawgr=GuppiRaw('/path/to/guppirawfile.raw')forheader,data_x,data_yingr.get_data():# process dataNote: most users should start analysis with filterbank files, which are smaller in size and have been generated from the guppi raw files.Using blimpy inside DockerThe blimpy images are pushed to a public repository after each successful build on Travis.
If you have Docker installed, you can run the following commands to pull our images, which have the environment and dependencies set up for you.docker pull fx196/blimpy:py3_kern_stableHere is amore complete guideon using blimpy in Docker.Further readingA detailed overview of the data formats used in Breakthrough Listen can be found in ourdata format paper. An archive of data files from the Breakthrough Listen program is provided atseti.berkeley.edu/opendata.If you have any requests or questions, please lets us know!