khrapovs/hcl-model

Simple time series forecasting based on multiple linear regression

HCL Model

Simple time series forecasting based on multiple linear regression.

Documentation

Full documentations hosted on GitHub pages: khrapovs.github.io/hcl-model.

Installation

pip install hcl-model

Contribute

Create a virtual environment and activate it

python -m venv venv
source venv/bin/activate

Install the development packages

pip install -e .[dev]

and use pre-commit to make sure that your code is formatted using black and isort automatically:

pre-commit install

Run tests:

pip install -e .[test]
pytest

Build documentation:

pip install -e .[doc]
mkdocs build

or use

mkdocs serve

if you prefer a live, self-refreshing, documentation.