Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shapelets/khiva-python
Python binding for Khiva library.
https://github.com/shapelets/khiva-python
data-series gpu khiva multicore opencl python
Last synced: 6 days ago
JSON representation
Python binding for Khiva library.
- Host: GitHub
- URL: https://github.com/shapelets/khiva-python
- Owner: shapelets
- License: mpl-2.0
- Created: 2018-06-06T14:15:46.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-20T22:03:01.000Z (6 months ago)
- Last Synced: 2024-08-02T07:06:57.937Z (3 months ago)
- Topics: data-series, gpu, khiva, multicore, opencl, python
- Language: Python
- Homepage: https://khiva-python.readthedocs.io/
- Size: 3.95 MB
- Stars: 46
- Watchers: 14
- Forks: 11
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome_time_series_in_python - khiva-python
README
# Khiva-Python
[](https://github.com/shapelets/khiva-python/blob/master/LICENSE.txt)
[](https://gitter.im/shapelets-io/khiva-python?utm_source=share-link&utm_medium=link&utm_campaign=share-link)
| Build Documentation | Build Linux and Mac OS | Build Windows | Code Coverage |
|:-------------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| [](https://khiva-python.readthedocs.io/en/master/?badge=master) | [](https://travis-ci.org/shapelets/khiva-python/branches) | [](https://ci.appveyor.com/project/shapelets/khiva-python/branch/master) |[](https://codecov.io/gh/shapelets/khiva-python/branch/master) |
# README #
This is the Khiva Python binding, it allows the usage of Khiva library from Python.
## License
This project is licensed under [MPL-v2](https://www.mozilla.org/en-US/MPL/2.0/).
## 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
- [Python 64-bits](https://www.python.org/downloads/)
> Note: By now, only 64-bit Python versions are supported.
> Note **Windows' users**: Search your 64-bits version [here](https://www.python.org/downloads/windows/)
### Install latest version
Install latest stable version of Khiva library. Follow the steps in the "Installation" section of the [Khiva repository](https://github.com/shapelets/khiva)
To install the Khiva Python binding, we just need to execute the following command:
```bash
python setup.py install
```
### Install any release
Install the prerequisites listed in the "Installation" section of the [Khiva library repository](https://github.com/shapelets/khiva). Download and install your selected Khiva release from [Khiva repository](https://github.com/shapelets/khiva/releases).
Install the Khiva python binding compatible with the Khiva library installed previously. Follow the steps to install the Khiva python binding explained in [pypi](https://pypi.org/project/khiva/).
## Executing the tests:
All tests can be executed separately, please find them in /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 /docs folder:
```bash
make html
```
## Contributing
The rules to contribute to this project are described [here](CONTRIBUTING.md)
[](https://shapelets.io)