Skip to main content

Multiple Univariate ARCH modeling toolbox built on top of the ARCH package

Project description

MUArch

Continuous Integration

Build Status Build status

Documentation

Documentation Status

Coverage

Coverage Status

Installing

Install and update using pip and on conda.

This is a wrapper on top of Kevin Sheppard's ARCH package. The purpose of which are to:

  1. Enable faster Monte Carlo simulation
  2. Simulate innovations through copula marginals

In the package, there are 2 classes to aid you - UArch and MUArch. The UArch class can be defined using a similar API to arch_model in the original arch package. The MUArch is a collection of these UArch models.

Thus, if you have a function that generates uniform marginals, like a copula, you can create a dependence structure among the different marginals when simulating the GARCH processes.

If you need a copula package, I have one here. :)

Example

I'll list out a simple procedure to do AR-GARCH-Copula simulations.

from muarch import MUArch, UArch
from muarch.datasets import load_etf
from copulae import NormalCopula


returns = load_etf()  # load returns data
num_assets = returns.shape[1]

# sets up a MUArch model collection where each model defaults to 
# mean: AR(1)
# vol: GARCH(1, 1)
# dist: normal 
models = MUArch(num_assets, mean='AR', lags=1) 

# set first model to AR(1)-GARCH(1, 1) with skewt innovations  
models[0] = UArch('AR', lags=1, dist='skewt')  

# fit model, if you get complaints regarding non-convergence, you can scale the data up 
# using the scale parameter in the UArch or MUArch. i.e. UArch(..., scale=100). This will
# reduce numerical errors. Don't worry, I'll rescale the simulation values subsequently
models.fit(returns)

# Usually you'll want to fit the residuals to the copula, use the copula to generate the
# residuals and subsequently transform it back to returns 

residuals = models.residuals() # defaults to return the standardized residuals


cop = NormalCopula(dim=num_assets) # use a normal copula, you could of course use a TCopula
cop.fit(residuals)

# simulate 10 steps into the future, over 4 repetitions. This will return a (10 x 4 x 3) array
models.simulate_mc(10, 4, custom_dist=cop.random)

Future Works

This is actually a temporary hack so that others can do GARCH copula simulation. Another issue is that an ARFIMA mean model is not so easily specified (and simulated from) with the original arch package. You could specify an ARFIMA (or even just an ARMA model for the matter), fit it separately then use the residuals to fit a zero-mean model (pure GARCH). However, in such a way, the simulation is not so straightforward as you'll have to stitch the simulations from GARCH process and the mean model process back.

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

muarch-0.2.0.tar.gz (436.0 kB view details)

Uploaded Source

Built Distributions

muarch-0.2.0-cp38-cp38-win_amd64.whl (431.7 kB view details)

Uploaded CPython 3.8 Windows x86-64

muarch-0.2.0-cp37-cp37m-win_amd64.whl (430.8 kB view details)

Uploaded CPython 3.7m Windows x86-64

File details

Details for the file muarch-0.2.0.tar.gz.

File metadata

  • Download URL: muarch-0.2.0.tar.gz
  • Upload date:
  • Size: 436.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0.post20200127 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.7.6

File hashes

Hashes for muarch-0.2.0.tar.gz
Algorithm Hash digest
SHA256 100d0da2b125e4632ccebbf6d07b1899ca20249201a439d89e8dce1b241c15f0
MD5 3599292a658062b0f45c9073ad0046f7
BLAKE2b-256 5f1d85a21fd08bf141606ac5f649e7aea6586052018f88481ff42cba5087b08c

See more details on using hashes here.

File details

Details for the file muarch-0.2.0-cp38-cp38-win_amd64.whl.

File metadata

  • Download URL: muarch-0.2.0-cp38-cp38-win_amd64.whl
  • Upload date:
  • Size: 431.7 kB
  • Tags: CPython 3.8, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0.post20200127 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.7.6

File hashes

Hashes for muarch-0.2.0-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 f5f8eb7589035e811901bfe0d2585ef8ac9b7a580d17f153fa0ca998c5be0ad2
MD5 51086e58253804fea93a3ba8042762ee
BLAKE2b-256 fb70c18edae845ef00fc4876f0464f8a4e02127d9b5ee0b5cc8319e76d4bf93c

See more details on using hashes here.

File details

Details for the file muarch-0.2.0-cp37-cp37m-win_amd64.whl.

File metadata

  • Download URL: muarch-0.2.0-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 430.8 kB
  • Tags: CPython 3.7m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0.post20200127 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.7.6

File hashes

Hashes for muarch-0.2.0-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 e52499bef7d9ed82abb47418d96dc2af2393f7b93c32614f5c2ffafce79a6001
MD5 f4bc69ca39f8b33e72a957370deb580d
BLAKE2b-256 4378e6dc828b769769adc2fb92884ea0c68dade5f85f0ecc06d92ec7c5b23e50

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