| Branch | Build Documentation | Build Linux and Mac OS | Build Windows | Code Coverage |
|---|---|---|---|---|
| master |  |
 |
||
| develop |  |
 |
Khiva is an open-source library of efficient algorithms to analyse time series in GPU and CPU. It can be used to extract insights from one or a group of time series. The large number of available methods allow us to understand the nature of each time series. Based on the results of this analysis, users can reduce dimensionality, find out recurrent motifs or discords, understand the seasonality or trend from a given time series, forecasting and detect anomalies.
Khiva provides a mean for time series analytics at scale. These analytics can be exploited in a wide range of use cases across several industries, like energy, finance, e-health, IoT, music industry, etc.
This project is licensed under MPL-v2.
- Install conan, c++ package manager, preferably through
pip install conan. For more information and alternative installation options, please refer to conan manual page. - Run
conan remote add conan-mpusz https://api.bintray.com/conan/mpusz/conan-mpusz. - Create
buildfolder and, after moving into the new folder, runconan install .. --build missing. - Run
cmake ... - Run
make -j8 && make install.
This project can be packaged to be installed in a Windows, Linux or Mac OS system. CPack is used in order to perform this task.
- For Windows the installer can be generated running the command
cpack -G NSISinside thebuildfolder. You need NSIS installed in your system. - For linux either a deb or a rpm package the installer can be generated. This could be done running the command
cpack -G DEBorcpack -G RPMrespectively inside thebuildfolder. - For Mac OS the installer can be generated running the command
cpack -G productbuildinside thebuildfolder.
Notes: Before generating the installer the project should be built. The generated package will be stored in the build folder.
We use sphinx + doxygen to generate our documentation. You will need to install the following packages:
- Sphinx:
brew install sphinx - Doxygen:
brew install doxygen - Read the Docs Theme:
pip install sphinx_rtd_theme - Breathe:
pip install breathe
The rules to contribute to this project are described here
We have a first approach to generate a build and execute the set of tests on every pull request to the develop branch. This process uses travis and appveyor. The status badges of the builds are contained at the beginning of this file.