A python interface to vinecopulib

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for vinecopulib from gravatar.com vinecopulib

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: MIT License (The MIT License (MIT) Copyright © 2019-2023 Thomas Nagler and Thibault Vatter Permission is hereby...)

Author: Thibault Vatter

Tags copula, vines copulas, pair-copulas constructions

Requires: Python >=3.8

Classifiers

Project description

pyvinecopulib

Build Status License: MIT Codacy Badge Documentation DOI

What are vine copulas?

Vine copulas are a flexible class of dependence models consisting of bivariate building blocks (see e.g., Aas et al., 2009). You can find a comprehensive list of publications and other materials on vine-copula.org.

What is pyvinecopulib?

pyvinecopulib is the python interface to vinecopulib, a header-only C++ library for vine copula models based on Eigen. It provides high-performance implementations of the core features of the popular VineCopula R library, in particular inference algorithms for both vine copula and bivariate copula models. Advantages over VineCopula are

  • a stand-alone C++ library with interfaces to both R and Python,
  • a sleaker and more modern API,
  • shorter runtimes and lower memory consumption, especially in high dimensions,
  • nonparametric and multi-parameter families.

Prerequisites

  • numpy (>=1.14)
  • pybind11 (>=2.4)
  • setuptools (>=30.3.0)
  • setuptools_scm (>=2.0.0)
  • To install from source: a compiler with C++11 support (Linux, OS X) or Visual Studio 2015 (required for all Python versions, see notes below)

Installation

The easiest way to install the latest release is to use pip:

pip install pyvinecopulib

To install from source, just clone this repository and do pip install. Note the --recursive option which is needed for the eigen, vinecopulib and wdm submodules:

git clone --recursive https://github.com/vinecopulib/pyvinecopulib.git
pip install ./pyvinecopulib

Examples

Jupyter notebooks with examples can be found in the examples folder.

Documentation

For documentation of the pyvinecopulib's functionality and instructions how to use it, check out our website or the docs/ folder in this repository.

Building the documentation

Documentation for the example project is generated using Sphinx and the "Read the Docs" theme. The following command generates HTML-based reference documentation; for other formats please refer to the Sphinx manual:

  • pip install sphinx-rtd-theme
  • cd pyvinecopulib/docs
  • python3 serve_sphinx.py

License

pyvinecopulib is provided under an MIT license that can be found in the LICENSE file. By using, distributing, or contributing to this project, you agree to the terms and conditions of this license.

Special notes for Windows

Compiler requirements

This package requires a C++11 compliant compiler, i.e Visual Studio 2015 on Windows. Unlike regular C extension modules, it's perfectly fine to compile a pyvinecopulib module with a VS version newer than the target Python's VS version.

Runtime requirements

The Visual C++ 2015 redistributable packages are a runtime requirement for this project.

Contact

If you have any questions regarding the library, feel free to open an issue or send a mail to info@vinecopulib.org.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for vinecopulib from gravatar.com vinecopulib

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: MIT License (The MIT License (MIT) Copyright © 2019-2023 Thomas Nagler and Thibault Vatter Permission is hereby...)

Author: Thibault Vatter

Tags copula, vines copulas, pair-copulas constructions

Requires: Python >=3.8

Classifiers

Release history Release notifications | RSS feed

This version

0.6.5

0.6.4

0.6.3

0.6.2

0.6.1

0.6.0

0.5.5

0.5.4

0.5.2

0.5.0

0.2.0

Download files

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

Source Distribution

pyvinecopulib-0.6.5.tar.gz (26.6 MB view hashes)

Uploaded Source

Built Distributions

pyvinecopulib-0.6.5-cp312-cp312-win_amd64.whl (1.3 MB view hashes)

Uploaded CPython 3.12 Windows x86-64

pyvinecopulib-0.6.5-cp312-cp312-win32.whl (1.2 MB view hashes)

Uploaded CPython 3.12 Windows x86

pyvinecopulib-0.6.5-cp312-cp312-musllinux_1_1_x86_64.whl (2.1 MB view hashes)

Uploaded CPython 3.12 musllinux: musl 1.1+ x86-64

pyvinecopulib-0.6.5-cp312-cp312-musllinux_1_1_i686.whl (2.0 MB view hashes)

Uploaded CPython 3.12 musllinux: musl 1.1+ i686

pyvinecopulib-0.6.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.5 MB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64

pyvinecopulib-0.6.5-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl (1.5 MB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ i686

pyvinecopulib-0.6.5-cp312-cp312-macosx_11_0_arm64.whl (1.4 MB view hashes)

Uploaded CPython 3.12 macOS 11.0+ ARM64

pyvinecopulib-0.6.5-cp312-cp312-macosx_10_9_x86_64.whl (1.5 MB view hashes)

Uploaded CPython 3.12 macOS 10.9+ x86-64

pyvinecopulib-0.6.5-cp311-cp311-win_amd64.whl (1.3 MB view hashes)

Uploaded CPython 3.11 Windows x86-64

pyvinecopulib-0.6.5-cp311-cp311-win32.whl (1.2 MB view hashes)

Uploaded CPython 3.11 Windows x86

pyvinecopulib-0.6.5-cp311-cp311-musllinux_1_1_x86_64.whl (2.1 MB view hashes)

Uploaded CPython 3.11 musllinux: musl 1.1+ x86-64

pyvinecopulib-0.6.5-cp311-cp311-musllinux_1_1_i686.whl (2.0 MB view hashes)

Uploaded CPython 3.11 musllinux: musl 1.1+ i686

pyvinecopulib-0.6.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.5 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

pyvinecopulib-0.6.5-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl (1.5 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ i686

pyvinecopulib-0.6.5-cp311-cp311-macosx_11_0_arm64.whl (1.4 MB view hashes)

Uploaded CPython 3.11 macOS 11.0+ ARM64

pyvinecopulib-0.6.5-cp311-cp311-macosx_10_9_x86_64.whl (1.5 MB view hashes)

Uploaded CPython 3.11 macOS 10.9+ x86-64

pyvinecopulib-0.6.5-cp310-cp310-win_amd64.whl (1.3 MB view hashes)

Uploaded CPython 3.10 Windows x86-64

pyvinecopulib-0.6.5-cp310-cp310-win32.whl (1.2 MB view hashes)

Uploaded CPython 3.10 Windows x86

pyvinecopulib-0.6.5-cp310-cp310-musllinux_1_1_x86_64.whl (2.1 MB view hashes)

Uploaded CPython 3.10 musllinux: musl 1.1+ x86-64

pyvinecopulib-0.6.5-cp310-cp310-musllinux_1_1_i686.whl (2.0 MB view hashes)

Uploaded CPython 3.10 musllinux: musl 1.1+ i686

pyvinecopulib-0.6.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.5 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

pyvinecopulib-0.6.5-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl (1.5 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ i686

pyvinecopulib-0.6.5-cp310-cp310-macosx_11_0_arm64.whl (1.4 MB view hashes)

Uploaded CPython 3.10 macOS 11.0+ ARM64

pyvinecopulib-0.6.5-cp310-cp310-macosx_10_9_x86_64.whl (1.5 MB view hashes)

Uploaded CPython 3.10 macOS 10.9+ x86-64

pyvinecopulib-0.6.5-cp39-cp39-win_amd64.whl (1.3 MB view hashes)

Uploaded CPython 3.9 Windows x86-64

pyvinecopulib-0.6.5-cp39-cp39-win32.whl (1.2 MB view hashes)

Uploaded CPython 3.9 Windows x86

pyvinecopulib-0.6.5-cp39-cp39-musllinux_1_1_x86_64.whl (2.1 MB view hashes)

Uploaded CPython 3.9 musllinux: musl 1.1+ x86-64

pyvinecopulib-0.6.5-cp39-cp39-musllinux_1_1_i686.whl (2.0 MB view hashes)

Uploaded CPython 3.9 musllinux: musl 1.1+ i686

pyvinecopulib-0.6.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.5 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

pyvinecopulib-0.6.5-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl (1.5 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ i686

pyvinecopulib-0.6.5-cp39-cp39-macosx_11_0_arm64.whl (1.4 MB view hashes)

Uploaded CPython 3.9 macOS 11.0+ ARM64

pyvinecopulib-0.6.5-cp39-cp39-macosx_10_9_x86_64.whl (1.5 MB view hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

pyvinecopulib-0.6.5-cp38-cp38-win_amd64.whl (1.3 MB view hashes)

Uploaded CPython 3.8 Windows x86-64

pyvinecopulib-0.6.5-cp38-cp38-win32.whl (1.2 MB view hashes)

Uploaded CPython 3.8 Windows x86

pyvinecopulib-0.6.5-cp38-cp38-musllinux_1_1_x86_64.whl (2.1 MB view hashes)

Uploaded CPython 3.8 musllinux: musl 1.1+ x86-64

pyvinecopulib-0.6.5-cp38-cp38-musllinux_1_1_i686.whl (2.0 MB view hashes)

Uploaded CPython 3.8 musllinux: musl 1.1+ i686

pyvinecopulib-0.6.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.5 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

pyvinecopulib-0.6.5-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl (1.5 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ i686

pyvinecopulib-0.6.5-cp38-cp38-macosx_11_0_arm64.whl (1.4 MB view hashes)

Uploaded CPython 3.8 macOS 11.0+ ARM64

pyvinecopulib-0.6.5-cp38-cp38-macosx_10_9_x86_64.whl (1.5 MB view hashes)

Uploaded CPython 3.8 macOS 10.9+ x86-64

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