Skip to content

Python library for cointegration analysis. It carries out cointegration test and evaluates spread between cointegrated time-series based on scikit-learn API.

License

Notifications You must be signed in to change notification settings

quantumquark/cointanalysis

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CointAnalysis

python pypi CI downloads code style

Python library for cointegration analysis.

hyg-bkln-adjust

Features

  • Carry out cointegration test
  • Evaluate spread between cointegrated time-series
  • Generate cointegrated time-series artificially
  • Based on scikit-learn API

Installation

$ pip install cointanalysis

What is cointegration?

See Hamilton's book.

How to use

Open In Colab

Let us see how the main class CointAnalysis works using two ETFs, HYG and BKLN, as examples. Since they are both connected with liabilities of low-rated companies, these prices behave quite similarly.

hyg-bkln

Cointegration test

The method test carries out a cointegration test. The following code gives p-value for null-hypothesis that there is no cointegration.

from cointanalysis import CointAnalysis

hyg = ...   # Fetch historical price of high-yield bond ETF
bkln = ...  # Fetch historical price of bank loan ETF
X = np.array([hyg, bkln]).T

coint = CointAnalysis()
coint.test(X)

coint.pvalue_
# 0.0055

The test has rejected the null-hypothesis by the p-value of 0.55%, which implies cointegration.

Get spread

The method fit finds the cointegration equation.

coint = CointAnalysis().fit(X)

coint.coef_
# np.array([-0.18  1.])
coint.mean_
# 6.97
coint.std_
# 0.15

This means that spread "-0.18 HYG + BKLN" has a mean 6.97 and a standard deviation of 0.15.

In fact, the prices adjusted with these parameters clarifies the similarities of these ETFs:

hyg-bkln-adjust

The time-series of spread is obtained by applying the method transform subsequently. The mean and the standard deviation are automatically adjusted (unless you pass parameters asking not to).

spread = coint.transform(X)
# returns (-0.18 * hyg + 1. * bkln - 7.00) / 0.15

spread = coint.transform(X, adjust_mean=False, adjust_std=False)
# returns -0.18 * hyg + 1. * bkln

The method fit_transform carries out fit and transform at once.

spread = coint.fit_transform(X)

The result looks like this:

hyg-bkln-spread

Acknowledgements

References

About

Python library for cointegration analysis. It carries out cointegration test and evaluates spread between cointegrated time-series based on scikit-learn API.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 97.9%
  • Shell 2.1%