Metadata-Version: 2.1
Name: sstudentt
Version: 0.0.5
Summary: An implementation of the skewed student-t distribution.
Home-page: https://github.com/berrij/sstudentt
Author: Jonathan Berrisch
Author-email: jonathan@berrisch.biz
License: GNU General Public License v3
Keywords: sstudentt
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Requires-Dist: numpy
Requires-Dist: scipy

.. image:: https://img.shields.io/pypi/v/sstudentt?style=for-the-badge
        :alt: PyPI

.. image:: https://img.shields.io/pypi/status/sstudentt?style=for-the-badge
        :alt: PyPI - Status

.. image:: https://img.shields.io/travis/BerriJ/sstudentt?style=for-the-badge
        :alt: Travis (.org)
        :target: https://travis-ci.org/berrij/sstudentt

.. image:: https://img.shields.io/readthedocs/sstudentt?style=for-the-badge
        :alt: Documentation Status
        :target: https://sstudentt.readthedocs.io/

.. image:: https://img.shields.io/pypi/l/sstudentt?style=for-the-badge
        :alt: PyPI - License

|

=======================================================
An implementation of the skewed student-t distribution.
=======================================================

This package implements the skewed student-t distribution parameterized as described in Wurtz et. al (2006) [1]_.
An implementation in R is already existent [2]_.

Features
--------

* Evaluate the density function
* Evaluate the cumulative distribution function
* Evaluate the quantile function
* Generate random numbers

References
----------

.. [1] Wurtz, Y. Chalabi, and L. Luksan. Parameter estimation of arma models with garch/aparch errors. an r and splus software implementation. Journal of Statistical Software, 2006.

.. [2] R Implementation: https://www.gamlss.com/wp-content/uploads/2018/01/DistributionsForModellingLocationScaleandShape.pdf


Licence
-------
Free software: GNU General Public License v3

Documentation
-------------
Documentation: https://sstudentt.readthedocs.io.

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

0.0.5 (2020-04-19)
------------------
* First release on PyPi
* Use pydata-sphinx-theme for the documentation

0.0.3 (2020-04-20)
------------------
* Update Documentation

0.0.3 (2020-04-19)
------------------
* Automatic deployment on Test-PyPi via travis

0.0.2 (2020-04-19)
------------------
* Import SST class directly

0.0.1 (2020-04-19)
------------------
* First release on Test-PyPI.


