Skip to main content

ARCH for Python

Project description

Documentation Status Travis Build Status Appveyor Build Status Coverage Status codecov Code Health DOI

ARCH

This is a work-in-progress for ARCH and other tools for financial econometrics, written in Python (and Cython)

What is in this repository?

Documentation

Documentation is hosted on read the docs

More about ARCH

More information about ARCH and related models is available in the notes and research available at Kevin Sheppard’s site.

Contributing

Contributions are welcome. There are opportunities at many levels to contribute:

  • Implement new volatility process, e.g FIGARCH

  • Improve docstrings where unclear or with typos

  • Provide examples, preferably in the form of IPython notebooks

Examples

Volatility Modeling

  • Mean models

    • Constant mean

    • Heterogeneous Autoregression (HAR)

    • Autoregression (AR)

    • Zero mean

    • Models with and without exogenous regressors

  • Volatility models

    • ARCH

    • GARCH

    • TARCH

    • EGARCH

    • EWMA/RiskMetrics

  • Distributions

    • Normal

    • Student’s T

See the univariate volatility example notebook for a more complete overview.

import datetime as dt
import pandas.io.data as web
st = dt.datetime(1990,1,1)
en = dt.datetime(2014,1,1)
data = web.get_data_yahoo('^FTSE', start=st, end=en)
returns = 100 * data['Adj Close'].pct_change().dropna()

from arch import arch_model
am = arch_model(returns)
res = am.fit()

Unit Root Tests

  • Augmented Dickey-Fuller

  • Dickey-Fuller GLS

  • Phillips-Perron

  • KPSS

  • Variance Ratio tests

See the unit root testing example notebook for examples of testing series for unit roots.

Bootstrap

  • Bootstraps

    • IID Bootstrap

    • Stationary Bootstrap

    • Circular Block Bootstrap

    • Moving Block Bootstrap

  • Methods

    • Confidence interval construction

    • Covariance estimation

    • Apply method to estimate model across bootstraps

    • Generic Bootstrap iterator

See the bootstrap example notebook for examples of bootstrapping the Sharpe ratio and a Probit model from Statsmodels.

# Import data
import datetime as dt
import pandas as pd
import pandas.io.data as web
start = dt.datetime(1951,1,1)
end = dt.datetime(2014,1,1)
sp500 = web.get_data_yahoo('^GSPC', start=start, end=end)
start = sp500.index.min()
end = sp500.index.max()
monthly_dates = pd.date_range(start, end, freq='M')
monthly = sp500.reindex(monthly_dates, method='ffill')
returns = 100 * monthly['Adj Close'].pct_change().dropna()

# Function to compute parameters
def sharpe_ratio(x):
    mu, sigma = 12 * x.mean(), np.sqrt(12 * x.var())
    return np.array([mu, sigma, mu / sigma])

# Bootstrap confidence intervals
from arch.bootstrap import IIDBootstrap
bs = IIDBootstrap(returns)
ci = bs.conf_int(sharpe_ratio, 1000, method='percentile')

Multiple Comparison Procedures

  • Test of Superior Predictive Ability (SPA), also known as the Reality Check or Bootstrap Data Snooper

  • Stepwise (StepM)

  • Model Confidence Set (MCS)

See the multiple comparison example notebook for examples of the multiple comparison procedures.

Requirements

These requirements reflect the testing environment. It is possible that arch will work with older versions.

  • Python (2.7, 3.4 - 3.6)

  • NumPy (1.10+)

  • SciPy (0.16+)

  • Pandas (0.16+)

  • statsmodels (0.6+)

  • matplotlib (1.5+)

Optional Requirements

  • Numba (0.24+) will be used if available and when installed using the –no-binary option

  • IPython (4.0+) is required to run the notebooks

Installing

  • Cython (0.24+, if not using –no-binary)

  • py.test (For tests)

  • sphinx (to build docs)

  • sphinx-napoleon (to build docs)

Note: Setup does not verify requirements. Please ensure these are installed.

Linux/OSX

pip install git+https://github.com/bashtage/arch.git

Anaconda

Anaconda builds are not currently available for OSX.

conda install -c https://conda.binstar.org/bashtage arch

Windows

Building extension using the community edition of Visual Studio is well supported for Python 3.5+. Building extensions for 64-bit Windows for use in Python 2.7 is also supported using Microsoft Visual C++ Compiler for Python 2.7. Building on combinations of Python/Windows is more difficult and is not necessary when Numba is installed since just-in-time compiled code (Numba) runs as fast as ahead-of-time compiled extensions.

With a compiler

If you are comfortable compiling binaries on Windows:

pip install git+https://github.com/bashtage/arch.git

No Compiler

All binary code is backed by a pure Python implementation. Compiling can be skipped using the flag --no-binary

pip install git+https://github.com/bashtage/arch.git --install-option "--no-binary"

Note: If Cython is not installed, the package will be installed as-if –no-binary was used.

Anaconda

conda install -c https://conda.binstar.org/bashtage arch

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arch-4.1.tar.gz (126.9 kB view details)

Uploaded Source

Built Distributions

arch-4.1-cp36-cp36m-win_amd64.whl (243.3 kB view details)

Uploaded CPython 3.6m Windows x86-64

arch-4.1-cp35-cp35m-win_amd64.whl (243.0 kB view details)

Uploaded CPython 3.5m Windows x86-64

arch-4.1-cp27-cp27m-win_amd64.whl (252.0 kB view details)

Uploaded CPython 2.7m Windows x86-64

File details

Details for the file arch-4.1.tar.gz.

File metadata

  • Download URL: arch-4.1.tar.gz
  • Upload date:
  • Size: 126.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for arch-4.1.tar.gz
Algorithm Hash digest
SHA256 9b493ec2870a98a9e443f72075d3aeb13da8e32730bdcab13fbfb0ac9cd9801a
MD5 6031806d7661dcf6dde98d1f4808d73a
BLAKE2b-256 dafd85176151cbe0e5b924fe419f6e8a9b34cd0a975dd653a935eb38e8027906

See more details on using hashes here.

File details

Details for the file arch-4.1-cp36-cp36m-win_amd64.whl.

File metadata

File hashes

Hashes for arch-4.1-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 fc41483227486378483afa8383e06d1a61839071047af5575fea68aab521e090
MD5 f1dc3545007f1522961fcd1ef9b8708c
BLAKE2b-256 9bb6b1a516b19e1bb550ee05470aefad27e6a607338610795d2daa62f2d9ed3e

See more details on using hashes here.

File details

Details for the file arch-4.1-cp35-cp35m-win_amd64.whl.

File metadata

File hashes

Hashes for arch-4.1-cp35-cp35m-win_amd64.whl
Algorithm Hash digest
SHA256 3a986ab102c0e960a9c72b4c8a70b23c8d4c97fb4a3f413f661c5dfc90b30113
MD5 8cbadab3654fd28b870c3f242e7663b1
BLAKE2b-256 083f734085196e918cebdec72525cfe625a4e6e82455ee889eb2fb2b451b462d

See more details on using hashes here.

File details

Details for the file arch-4.1-cp27-cp27m-win_amd64.whl.

File metadata

File hashes

Hashes for arch-4.1-cp27-cp27m-win_amd64.whl
Algorithm Hash digest
SHA256 98457fdaea013fc17d55dea492c68823f9d37d69d0b8a29b4571696fb4fb6fe8
MD5 60ee09b6b2433aae6343bf990c67f67d
BLAKE2b-256 11adbd204cb8868c93d7ae8556c83d60e104aac7b2d55bf69d3ed37e1869c4fa

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page