Installation¶

Make things as simple as possible, but not any simpler.

—Albert Einstein

The Python Distutils are used to build and install PyTables, so it is fairly simple to get the application up and running. If you want to install the package from sources you can go on reading to the next section.

However, if you want to go straight to binaries that ‘just work’ for the main platforms (Linux, Mac OSX and Windows), you might want to use the excellent Anaconda, ActivePython, Canopy distributions. PyTables usually distributes its own Windows binaries too; go Binary installation (Windows) for instructions. Finally Christoph Gohlke also maintains an excellent suite of a variety of binary packages for Windows at his site.

Installation from source¶

These instructions are for both Unix/MacOS X and Windows systems. If you are using Windows, it is assumed that you have a recent version of MS Visual C++ compiler installed. A GCC compiler is assumed for Unix, but other compilers should work as well.

Extensions in PyTables have been developed in Cython (see [CYTHON]) and the C language. You can rebuild everything from scratch if you have Cython installed, but this is not necessary, as the Cython compiled source is included in the source distribution.

To compile PyTables you will need a recent version of Python, the HDF5 (C flavor) library from http://www.hdfgroup.org, and the NumPy (see [NUMPY]) and Numexpr (see [NUMEXPR]) packages.

Prerequisites¶

First, make sure that you have the following dependencies installed. If you don’t, fetch and install them before proceeding.

Python >= 3.10
HDF5 >= 1.10.5 (although 1.14.0 or later is strongly recommended)
Cython >= 3.0.10
NumPy >= 1.20.0
Numexpr >= 2.6.2
packaging
py-cpuinfo
typing-extensions >= 4.4.0
c-blosc >= 1.11.1 (sources are bundled with PyTables sources but the user can use an external version of sources using the BLOSC_DIR environment variable or the –blosc flag of the setup.py)
Either
- python-blosc2 >= 2.3.0, this is the Python wheel containing both the C-Blosc2 libs and headers (>= 2.11.0), as well as the Python wrapper for Blosc2 (not currently used, but it might be in the future), or
- A standalone installation of the c-blosc2 library (>= 2.11.0) including the headers. The latter are usually provided by Linux distribtions in a package named blosc2-devel, libblosc2-dev, or similar.

Compile and install these packages (but see Windows prerequisites for instructions on how to install pre-compiled binaries if you are not willing to compile the prerequisites on Windows systems).

For compression (and possibly improved performance), you will need to install the Zlib (see [ZLIB]), which is also required by HDF5 as well. You may also optionally install the excellent LZO compression library (see [LZO] and Compression issues). The high-performance bzip2 compression library can also be used with PyTables (see [BZIP2]).

The Blosc (see [BLOSC]) compression library is embedded in PyTables, so this will be used in case it is not found in the system. So, in case the installer warns about not finding it, do not worry too much ;)

Libraries are searched in system standard paths, and pkg-config is used, when available, to improve the automatic detection.

If setup.py` can not find any of the needed libraries or if several versions of a library are installed, then it is possible to set the path to the particular resource using the environment. The following environment variables can be used for the purpose:

HDF5_DIR,
LZO_DIR,
BZIP2_DIR,
BLOSC_DIR, or
BLOSC2_DIR

One may also specify the locations of the resource root directories on the setup.py` command line. The following options are available:

–hdf5,
–blosc,
–lzo,
–bzip2, or
–blosc2

the command line arguments to setup.py (e.g. –blosc2) has the highest precedence

If the command line argument for a specific library is not specified and the corresponding environment variables exists (e.g. BLOSC2_DIR), then its value is used.

If the target library (blosc2 in the example) can’t still be found, then pkg-config is used for further detection, if it is available.

If the library is still not found, then a selection of hardcoded paths is used

Please note that, for the specific case of Blosc2, the list of search paths also includes the ones used by the python-blosc2 wheel package to install the relevant header files and libraries.

Unix

setup.py will detect HDF5, Blosc, Blosc2, LZO, or bzip2 libraries and include files under /usr or /usr/local; this will cover most manual installations as well as installations from packages. If setup.py can not find libhdf5, libhdf5 (or liblzo, or libbz2 that you may wish to use) or if you have several versions of a library installed and want to use a particular one, then you can set the path to the resource in the environment, by setting the values of the HDF5_DIR, LZO_DIR, BZIP2_DIR, BLOSC_DIR or BLOSC2_DIR environment variables to the path to the particular resource. You may also specify the locations of the resource root directories on the setup.py command line. For example:
--hdf5=/stuff/hdf5-1.14.2
--blosc=/stuff/blosc-1.21.5
--lzo=/stuff/lzo-2.02
--bzip2=/stuff/bzip2-1.0.5
--blosc2=/stuff/blosc2-2.10.3
If your HDF5 library was built as a shared library not in the runtime load path, then you can specify the additional linker flags needed to find the shared library on the command line as well. For example:
--lflags="-Xlinker -rpath -Xlinker /stuff/hdf5-1.14.2/lib"
You may also want to try setting the LD_LIBRARY_PATH environment variable to point to the directory where the shared libraries can be found. Check your compiler and linker documentation as well as the Python Distutils documentation for the correct syntax or environment variable names. It is also possible to link with specific libraries by setting the LIBS environment variable:
LIBS="hdf5-1.14.2 nsl"
Starting from PyTables 3.2 can also query the pkg-config database to find the required packages. If available, pkg-config is used by default unless explicitly disabled.

To suppress the use of pkg-config:
$ python3 setup.py build --use-pkgconfig=FALSE
or use the USE_PKGCONFIG environment variable:
$ env USE_PKGCONFIG=FALSE python3 setup.py build

Windows

You can get ready-to-use Windows binaries and other development files for most of the following libraries from the GnuWin32 project (see [GNUWIN32]). In case you cannot find the LZO binaries in the GnuWin32 repository, you can find them at http://sourceforge.net/projects/pytables/files/lzo-win. Once you have installed the prerequisites, setup.py needs to know where the necessary library stub (.lib) and header (.h) files are installed. You can set the path to the include and dll directories for the HDF5 (mandatory) and LZO, BZIP2, BLOSC (optional), BLOSC2 libraries in the environment, by setting the values of the HDF5_DIR, LZO_DIR, BZIP2_DIR, BLOSC_DIR or BLOSC2_DIR environment variables to the path to the particular resource. For example:
set HDF5_DIR=c:\\stuff\\hdf5-1.10.2-32bit-VS2008-IVF101\\release
set BLOSC_DIR=c:\\Program Files (x86)\\Blosc
set LZO_DIR=c:\\Program Files (x86)\\GnuWin32
set BZIP2_DIR=c:\\Program Files (x86)\\GnuWin32
set BLOSC2_DIR=c:\\Program Files (x86)\\Blosc2
You may also specify the locations of the resource root directories on the setup.py command line. For example:
--hdf5=c:\\stuff\\hdf5-1.10.1-32bit-VS2008-IVF101\\release
--blosc=c:\\Program Files (x86)\\Blosc
--lzo=c:\\Program Files (x86)\\GnuWin32
--bzip2=c:\\Program Files (x86)\\GnuWin32
--blosc2=c:\\Program Files (x86)\\Blosc2

Conda

Pre-built packages for PyTables are available in the anaconda (default) channel:
conda install pytables
The most recent version is usually available in the conda-forge channel:
conda config --add channels conda-forge
conda install pytables
The HDF5 libraries and other helper packages are automatically found in a conda environment. During installation setup.py uses the CONDA_PREFIX environment variable to detect a conda environment. If detected it will try to find all packages within this environment. PyTables needs at least the hdf5 package:
conda install hdf5
python3 setup.py install
It is still possible to override package locations using the HDF5_DIR, LZO_DIR, BZIP2_DIR or BLOSC_DIR environment variables.

When inside a conda environment pkg-config will not work. To disable using the conda environment and fall back to pkg-config use –no-conda:
python3 setup.py install --no-conda
When the –use-pkgconfig flag is used, –no-conda is assumed.

Development version (Unix)

Installation of the development version is very similar to installation from a source package (described above). There are two main differences:
sources have to be downloaded from the PyTables source repository hosted on GitHub. Git (see [GIT]) is used as VCS. The following command create a local copy of latest development version sources:
$ git clone --recursive https://github.com/PyTables/PyTables.git
sources in the git repository do not include pre-built documentation and pre-generated C code of Cython extension modules. To be able to generate them, both Cython (see [CYTHON]) and sphinx >= 1.0.7 (see [SPHINX]) are mandatory prerequisites.

PyTables package installation¶

Once you have installed the HDF5 library and the NumPy and Numexpr packages, you can proceed with the PyTables package itself.

Run this command from the main PyTables distribution directory, including any extra command line arguments as discussed above:
```
$ python3 setup.py build
```
If the HDF5 installation is in a custom path, e.g. $HOME/hdf5-1.14.2, one of the following commands can be used:
```
$ python3 setup.py build --hdf5=$HOME/hdf5-1.14.2
```
Note

AVX2 support is detected automatically for your machine and, if found, it is enabled by default. In some situations you may want to disable AVX2 explicitly (maybe your binaries have to be exported and run on machines that do not have AVX2 support). In that case, define the DISABLE_AVX2 environment variable:
```
$ DISABLE_AVX2=True python3 setup.py build  # for bash and its variants
```
To run the test suite, execute any of these commands.
Unix
In the sh shell and its variants:
$ cd build/lib.linux-x86_64-3.3 $ env PYTHONPATH=. python3 tables/tests/test_all.py
or, if you prefer:
$ cd build/lib.linux-x86_64-3.3 $ env PYTHONPATH=. python3 -c "import tables; tables.test()"
Note

the syntax used above overrides original contents of the PYTHONPATH environment variable. If this is not the desired behaviour and the user just wants to add some path before existing ones, then the safest syntax to use is the following:
$ env PYTHONPATH=.${PYTHONPATH:+:$PYTHONPATH} python3 tables/tests/test_all.py
Please refer to your sh documentation for details.
Windows
Open the command prompt (cmd.exe or command.com) and type:
> cd build\\lib.linux-x86_64-2.7 > set PYTHONPATH=.;%PYTHONPATH% > python3 tables\\tests\\test_all.py
or:
> cd build\\lib.linux-x86_64-2.7 > set PYTHONPATH=.;%PYTHONPATH% > python3 -c "import tables; tables.test()"
Both commands do the same thing, but the latter still works on an already installed PyTables (so, there is no need to set the PYTHONPATH variable for this case). However, before installation, the former is recommended because it is more flexible, as you can see below. If you would like to see verbose output from the tests simply add the -v flag and/or the word verbose to the first of the command lines above. You can also run only the tests in a particular test module. For example, to execute just the test_types test suite, you only have to specify it:
```
# change to backslashes for win
$ python3 tables/tests/test_types.py -v
```
You have other options to pass to the test_all.py driver:
```
# change to backslashes for win
$ python3 tables/tests/test_all.py --heavy
```
The command above runs every test in the test unit. Beware, it can take a lot of time, CPU and memory resources to complete:
```
# change to backslashes for win
$ python3 tables/tests/test_all.py --print-versions
```
The command above shows the versions for all the packages that PyTables relies on. Please be sure to include this when reporting bugs:
```
# only under Linux 2.6.x
$ python3 tables/tests/test_all.py --show-memory
```
The command above prints out the evolution of the memory consumption after each test module completion. It’s useful for locating memory leaks in PyTables (or packages behind it). Only valid for Linux 2.6.x kernels. And last, but not least, in case a test fails, please run the failing test module again and enable the verbose output:
```
$ python3 tables/tests/test_<module>.py -v verbose
```
and, very important, obtain your PyTables version information by using the –print-versions flag (see above) and send back both outputs to developers so that we may continue improving PyTables. If you run into problems because Python can not load the HDF5 library or other shared libraries.

Unix

Try setting the LD_LIBRARY_PATH or equivalent environment variable to point to the directory where the missing libraries can be found.

Windows

Put the DLL libraries (hdf5dll.dll and, optionally, lzo1.dll, bzip2.dll or blosc.dll) in a directory listed in your PATH environment variable. The setup.py installation program will print out a warning to that effect if the libraries can not be found.
To install the entire PyTables Python package, change back to the root distribution directory and run the following command (make sure you have sufficient permissions to write to the directories where the PyTables files will be installed):
```
$ python3 setup.py install
```
Again if one needs to point to libraries installed in custom paths, then specific setup.py options can be used:
```
$ python3 setup.py install --hdf5=/hdf5/custom/path
```
or:
```
$ env HDF5_DIR=/hdf5/custom/path python3 setup.py install
```
Of course, you will need super-user privileges if you want to install PyTables on a system-protected area. You can select, though, a different place to install the package using the –prefix flag:
```
$ python3 setup.py install --prefix="/home/myuser/mystuff"
```
Have in mind, however, that if you use the –prefix flag to install in a non-standard place, you should properly setup your PYTHONPATH environment variable, so that the Python interpreter would be able to find your new PyTables installation. You have more installation options available in the Distutils package. Issue a:
```
$ python3 setup.py install --help
```
for more information on that subject.

That’s it! Now you can skip to the next chapter to learn how to use PyTables.

Installation with pip¶

Many users find it useful to use the pip program (or similar ones) to install python packages.

As explained in previous sections the user should in any case ensure that all dependencies listed in the Prerequisites section are correctly installed.

The simplest way to install PyTables using pip is the following:

$ python3 -m pip install tables

The following example shows how to install the latest stable version of PyTables in the user folder when a older version of the package is already installed at system level:

$ python3 -m pip install --user --upgrade tables

The –user option tells to the pip tool to install the package in the user folder ($HOME/.local on GNU/Linux and Unix systems), while the –upgrade option forces the installation of the latest version even if an older version of the package is already installed.

Additional options for the setup.py script can be specified using them –install-option:

$ python3 -m pip install --install-option='--hdf5=/custom/path/to/hdf5' tables

or:

$ env HDF5_DIR=/custom/path/to/hdf5 python3 -m pip install tables

The pip tool can also be used to install packages from a source tar-ball:

$ python3 -m pip install tables-3.0.0.tar.gz

To install the development version of PyTables from the develop branch of the main git [GIT] repository the command is the following:

$ python3 -m pip install git+https://github.com/PyTables/PyTables.git@develop#egg=tables

A similar command can be used to install a specific tagged version:

$ python3 -m pip install git+https://github.com/PyTables/PyTables.git@v.2.4.0#egg=tables

Of course the pip can be used to install only python packages. Other dependencies like the HDF5 library of compression libraries have to be installed by the user.

Note

Recent versions of Debian and Ubuntu the HDF5 library is installed in with a very peculiar layout that allows to have both the serial and MPI versions installed at the same time.

PyTables >= 3.2 natively supports the new layout via pkg-config (that is expected to be installed on the system at build time).

If pkg-config is not available or PyTables is older than version 3.2, then the following command can be used:

$ env CPPFLAGS=-I/usr/include/hdf5/serial \
LDFLAGS=-L/usr/lib/x86_64-linux-gnu/hdf5/serial python3 setup.py install

or:

$ env CPPFLAGS=-I/usr/include/hdf5/serial \
LDFLAGS=-L/usr/lib/x86_64-linux-gnu/hdf5/serial python3 -m pip install tables

Binary installation (Windows)¶

This section is intended for installing precompiled binaries on Windows platforms. Binaries are distribution in wheel format, which can be downloaded and installed using pip as described above. You may also find it useful for instructions on how to install binary prerequisites even if you want to compile PyTables itself on Windows.

Windows prerequisites¶

First, make sure that you have Python 3, NumPy 1.8.0 and Numexpr 2.5.2 or higher installed.

To enable compression with the optional LZO library (see the Compression issues for hints about how it may be used to improve performance), fetch and install the LZO from http://sourceforge.net/projects/pytables/files/lzo-win (choose v1.x for Windows 32-bit and v2.x for Windows 64-bit). Normally, you will only need to fetch that package and copy the included lzo1.dll/lzo2.dll file in a directory in the PATH environment variable (for example C:\WINDOWS\SYSTEM) or python_installation_path\Lib\site-packages\tables (the last directory may not exist yet, so if you want to install the DLL there, you should do so after installing the PyTables package), so that it can be found by the PyTables extensions.

Please note that PyTables has internal machinery for dealing with uninstalled optional compression libraries, so, you don’t need to install the LZO or bzip2 dynamic libraries if you don’t want to.

PyTables package installation¶

On PyPI wheels for 32 and 64-bit versions of Windows and are usually provided. They are automatically found and installed using pip:

$ python3 -m pip install tables

If a matching wheel cannot be found for your installation, third party built wheels can be found e.g. at the Unofficial Windows Binaries for Python Extension Packages page. Download the wheel matching the version of python and either the 32 or 64-bit version and install using pip:

# python 3.6 64-bit:
$ python3 -m pip install tables-3.6.1-2-cp36-cp36m-win_amd64.whl

You can (and you should) test your installation by running the next commands:

>>> import tables
>>> tables.test()

on your favorite python shell. If all the tests pass (possibly with a few warnings, related to the potential unavailability of LZO lib) you already have a working, well-tested copy of PyTables installed! If any test fails, please copy the output of the error messages as well as the output of:

>>> tables.print_versions()

and mail them to the developers so that the problem can be fixed in future releases.

You can proceed now to the next chapter to see how to use PyTables.