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

  • NumPy (1.9+)

  • SciPy (0.15+)

  • Pandas (0.16+)

  • statsmodels (0.6+)

  • matplotlib (1.3+)

Optional Requirements

  • Numba (0.21+) 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.20+, 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.0.tar.gz (107.6 kB view details)

Uploaded Source

Built Distributions

arch-4.0-cp35-cp35m-win_amd64.whl (237.0 kB view details)

Uploaded CPython 3.5m Windows x86-64

arch-4.0-cp35-cp35m-macosx_10_6_x86_64.whl (243.7 kB view details)

Uploaded CPython 3.5m macOS 10.6+ x86-64

arch-4.0-cp27-cp27m-win_amd64.whl (245.3 kB view details)

Uploaded CPython 2.7m Windows x86-64

arch-4.0-cp27-cp27m-macosx_10_7_x86_64.whl (258.2 kB view details)

Uploaded CPython 2.7m macOS 10.7+ x86-64

File details

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

File metadata

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

File hashes

Hashes for arch-4.0.tar.gz
Algorithm Hash digest
SHA256 d528070a115dc8d5de50d7739c6e845455a63f3d8bb5b580b0f7d06836fa5398
MD5 8352d72e0ac1db0c93ae9c4b209f3182
BLAKE2b-256 ecf99f3cbcda850245cb1299489c488726776e3074124555b1ce4f118e07494c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for arch-4.0-cp35-cp35m-win_amd64.whl
Algorithm Hash digest
SHA256 9264155f2a0cc83a5f4f9b7595db2c93d80fbe1d0a070fde1845f7ff417c4dc1
MD5 3e4bb18b720be70960da83c5164ca495
BLAKE2b-256 a6c0a3421855a74db0046a1536ba6dfcc0e79fe718f778b5a1ef11ec9279ef26

See more details on using hashes here.

File details

Details for the file arch-4.0-cp35-cp35m-macosx_10_6_x86_64.whl.

File metadata

File hashes

Hashes for arch-4.0-cp35-cp35m-macosx_10_6_x86_64.whl
Algorithm Hash digest
SHA256 7c2426253a1d4e1f434abdc2477f084558d0f0a22c040cd78b3dec8234dd2080
MD5 6cf089050b69f0729bb44993d49b6720
BLAKE2b-256 566ec08e4216833be98c6488992a5e9f65c9df6fe4c1e70f6119ab7a96f0f0df

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for arch-4.0-cp27-cp27m-win_amd64.whl
Algorithm Hash digest
SHA256 c01414df615a20b066247b2d350b7e4b47ed6d94c4ec2d5fd80ef67b4cd81833
MD5 21067aae47c9fae52e7eb7aea1f85760
BLAKE2b-256 8bf4bbccac2087074ca6d705acf49681be6f18e3e36e08dd0605bb2ca94605ff

See more details on using hashes here.

File details

Details for the file arch-4.0-cp27-cp27m-macosx_10_7_x86_64.whl.

File metadata

File hashes

Hashes for arch-4.0-cp27-cp27m-macosx_10_7_x86_64.whl
Algorithm Hash digest
SHA256 3a100da6727ea7c1c4e06d009e291f4da8e6816ce5c11601af81f7ec5bf4ee54
MD5 3ac2b24c3bf965b14d42e9c86ba47f07
BLAKE2b-256 b3910fb1e412ab944ef1ae125f21107425a21c5ff9ed76befb519127e94a24d4

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