Awesome
Khiva-Python
Build Documentation | Build Linux and Mac OS | Build Windows | Code Coverage |
---|---|---|---|
README
This is the Khiva Python binding, it allows the usage of Khiva library from Python.
License
This project is licensed under MPL-v2.
Quick Summary
This Python binding called 'khiva' provides all the functionalities of the KHIVA library for time series analytics.
Set up
In order to use this binding, you need to install Khiva library.
Prerequisites
Note: By now, only 64-bit Python versions are supported.
Note Windows' users: Search your 64-bits version here
Install latest version
Install latest stable version of Khiva library. Follow the steps in the "Installation" section of the Khiva repository
To install the Khiva Python binding, we just need to execute the following command:
python setup.py install
Install any release
Install the prerequisites listed in the "Installation" section of the Khiva library repository. Download and install your selected Khiva release from Khiva repository.
Install the Khiva python binding compatible with the Khiva library installed previously. Follow the steps to install the Khiva python binding explained in pypi.
Executing the tests:
All tests can be executed separately, please find them in <project-root-dir>/tests/unit_tests.
Documentation
This Khiva Python binding follows the standard way of writing documentation of Python by using Sphinx.
In order to generate the documentation (in html format), run the following command under the <project-root-dir>/docs folder:
make html
Contributing
The rules to contribute to this project are described here