# intel-qpl

**Repository Path**: zhoudan-intel/intel-qpl

## Basic Information

- **Project Name**: intel-qpl
- **Description**: intel qpl lib
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: v0.2.1_branch
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 4
- **Created**: 2023-01-10
- **Last Updated**: 2023-03-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<!--
Copyright (C) 2022 Intel Corporation 
SPDX-License-Identifier: MIT
-->

Intel® Query Processing Library (Intel® QPL) Beta
=================================================


The Intel® Query Processing Library (Intel® QPL) is an open-source library to provide
high-performance query processing operations on Intel CPUs. Intel® QPL is aimed to support 
capabilities of the new Intel® In-Memory Analytics Accelerator (Intel® IAA) available on Next
Generation Intel® Xeon® Scalable processors, codenamed Sapphire Rapids processor, such as very high
throughput compression and decompression combined with primitive analytic functions, as well as to
provide highly-optimized SW fallback on other Intel CPUs. Intel QPL primarily targets applications
such as big-data and in-memory analytic databases.


## Documentation

>**Note:** Online documention is still in building stage, currently we only provide offline document. The library is in beta state and its APIs may change as the library is actively developed.


**Offline Documentation Building**

***Prerequisites***

To build an offline copy of documentation,
make sure the following documentation generation tools are installed and set up:

- `Doxygen <https://www.doxygen.nl/index.html>`__ 1.8.17 or higher: ``apt install doxygen``
- `Python <https://www.python.org/>`__ 3.8.5 or higher: ``apt install python3.X``
- `Sphinx <https://www.sphinx-doc.org/en/master/>`__ 3.5.4 or higher: ``pip3 install sphinx``
- `sphinx_book_theme <https://executablebooks.org/en/latest/>`__ : ``pip3 install sphinx-book-theme``
- `Breathe <https://breathe.readthedocs.io/en/latest/>`__ 4.29.0 or higher: ``pip3 install breathe``

***Build***

To generate the full offline documentation from sources, use the following command:

```
/bin/bash <qpl_library>/doc/_get_docs.sh
```


After the generation process is completed, open the ``<qpl_library>/doc/build/html/index.html`` file.


## Get Started

To set up and build the Intel QPL library, follow instructions below:

1. Make sure your system meets all System Requirements described in offline doc **Get Started-Installation-System Requirements** chapter
2. Follow instructions to build the library. See offline doc **Get Started-Installation** chapter for more details.


## Testing

See offline doc **Get Started-Library Testing** chapter for details about testing process.

## How to Contribute

See [Contributing document](CONTRIBUTING.md) for details about contribution process.

## How to Report Issues

See offline doc **Contributing-Issue Reporting** chapter for details about issue reporting process.

## License

The library is licensed under the MIT license. Refer to the
"[LICENSE](LICENSE)" file for the full license text.

This distribution includes third party software governed by separate license
terms (see "[THIRD-PARTY-PROGRAMS](third-party-programs.txt)").