Metadata-Version: 2.1
Name: fathon
Version: 1.3.3.post1
Summary: A python package for detrended fluctuation analysis (DFA) and related algorithms.
Home-page: https://github.com/stfbnc/fathon.git
Author: Stefano Bianchi
Author-email: fathon.package@gmail.com
License: GPLv3.0
Project-URL: Documentation, https://fathon.readthedocs.io/
Project-URL: Bug Reports, https://github.com/stfbnc/fathon/issues
Project-URL: Source, https://github.com/stfbnc/fathon/
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Cython
Classifier: Programming Language :: C
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy >=1.24.4

fathon (v1.3.3)
***************

Current version is available for Linux (x86_64 and ARM64), macOS (x86_64), and Windows (64bit).

Python package for detrended fluctuation analysis (DFA) and related algorithms.
`fathon` provides five main algorithms, namely

- `DFA` (Detrended Fluctuation Analysis)
- `MFDFA` (Multifractal Detrended Fluctuation Analysis)
- `DCCA` (Detrended Cross-Correlation Analysis)
- `MFDCCA` (Multifractal  Detrended Cross-Correlation Analysis)
- `HT` (Time-dependent Hurst exponent)

`MFDFA` and `MFDCCA` also provides methods for the mass exponent τ and the multifractal spectrum f(α).

`DCCA` has methods to compute the cross-correlation coefficient ρ_DCCA and the corresponding confidence intervals.

Requirements
============

- Python 3.8+
- numpy (version >= 1.24.4 for Python < 3.12, version >= 1.26.2 for Python >= 3.12)

Installation
============

`pip install fathon`

