Installing Ravix

Python 3.9+MIT License

Ravix is available on PyPI and requires Python 3.9 or later.


pip

The recommended installation method:

pip install ravix

To upgrade to the latest version:

pip install --upgrade ravix

From source

git clone https://github.com/danielmcgibney/ravix
cd ravix
pip install -e .

Verify installation

# Should print the installed version
import ravix
print(ravix.__version__)

Dependencies

All required dependencies are installed automatically by pip.

Required
numpy≥ 1.20
pandas≥ 1.4
statsmodels≥ 0.13  Underlying regression engine
matplotlib≥ 3.5
scipyany
scikit-learnany  Pipeline and metrics interop
seabornany  Enhanced plot styling

Quickstart

import ravix

df    = ravix.get_data("Betas.csv")
model = ravix.ols("AAPL ~ SPY", df)
model.summary()
ravix.plot("AAPL ~ SPY", df)
Next step
Click the Quickstart link for a complete quickstart walkthrough.