Metadata-Version: 2.1
Name: hurst-estimators
Version: 0.0.3
Summary: Library for Hurst estimation methods
License: MIT
Author: Aras Edeş
Author-email: edesaras@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: numpy (>=1.21.0,<2.0.0)
Requires-Dist: pywavelets (>=1.2.0,<2.0.0)
Requires-Dist: scipy (>=1.7.0,<2.0.0)
Description-Content-Type: text/markdown

# Hurst Estimators

Hurst Estimators is a Python library for estimating the Hurst exponent of time series data using various methods. This library includes implementations of several popular Hurst exponent estimation methods, as well as utilities for generating synthetic data and analyzing results.

## Installation

You can install the library using `pip`:

```sh
pip install hurst-estimators
```

or clone from the github repo:
```sh
git clone https://github.com/edesaras/hurst-estimators.git
```



## Importing the library

```python
import hurst_estimators as he
```

## Available Methods

### Time Domain Estimators 
* Central Estimator
* Detrended Fluctuation Estimator
* General Hurst Exponent Estimator
* Higuchi Estimator
* Rescaled Range Estimator

### Frequency Domain Estimators
* Periodogram Estimator

### Wavelet Estimators
* Average Wavelet Coefficient Estimator
* Variance Versus Level Wavelet Estimator

### Simulators
* Fractional Gaussian Noise (Circulant Embedding Method)

## Quick Example

## Contributing

## Citation

```bibtex
@software{hurst_estimators,
  author = {Aras Edes},
  title = {hurst-estimators: A Python library for Hurst exponent estimation},
  year = {2024},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/edesaras/hurst-estimators}},
}
```

