Baseband requires:

On python 3.7, in addition it requires importlib_metadata, which is the backport of importlib.metadata from python 3.8 and later.

Installing Baseband

To install Baseband with pip, run:

pip3 install baseband

Here, include a --user flag if you are installing for yourself outside of a virtual environment. You can also add a trailing [all] to install also the baseband-tasks package (and all of its dependencies), which provides analysis tasks and I/O support for hdf5.

Obtaining Source Code

The source code and latest development version of Baseband can found on its GitHub repo. You can get your own clone using:

git clone

Of course, it is even better to fork it on GitHub, and then clone your own repository, so that you can more easily contribute! You can install the cloned repository with:

pip3 install .

Here, apart from the --user option, you may want to add the --editable option to just link to the source repository, which means that any edit will be seen.

Running Code without Installing

As Baseband is purely Python, it can be used without being built or installed, by appending the directory it is located in to the PYTHON_PATH environment variable. Alternatively, you can use sys.path within Python to append the path:

import sys

where BASEBAND_PATH is the directory you downloaded or cloned Baseband into. However, for its plugin modules to be discoverable, you may still want to run:

python3 egg_info

Testing the Installation

To test that the code works on your system, you need pytest and pytest-astropy to be installed; this is most easily done by first installing the code together with its test dependencies:

pip install -e .[test]

Then, inside the root directory, simply run


or, inside of Python:

import baseband

For further details, see the Astropy Running Tests pages.

Building Documentation


As with Astropy, building the documentation is unnecessary unless you are writing new documentation or do not have internet access, as Baseband’s documentation is available online at

To build the Baseband documentation, you need Sphinx and sphinx-astropy to be installed; this is most easily done by first installing the code together with its documentations dependencies:

pip install -e .[docs]

Then, go to the docs directory and run

make html

For further details, see the Astropy Building Documentation pages.