Giter Club home page Giter Club logo

fathon's Introduction

fathon Build Status

Issues GitHub stars GitHub forks Python 3.5+

DOI DOI

⚠️⚠️ At the moment, fathon is only available for Linux (64 bit) and macOS ⚠️⚠️

fathon is a python package for DFA (Detrended Fluctuation Analysis) and related algorithms.

It is mostly written in Cython and C in order to speed up computations.

fathon provides four main algorithms, namely

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

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

DCCA has methods for computing the cross-correlation coefficient ρ_DCCA and the corresponding confidence intervals.

Prerequisites

  • Python 3.5 or higher

  • numpy (version >= 1.15)

  • Cython

Installing

As easy as pip install fathon

Examples

A jupyter notebook can be used (fathon_example.ipynb) to play with the four algorithms provided by the fathon package.

If you cannot use the notebook, four Python scripts are provided, dfa.py, mfdfa.py, dcca.py, and ht.py.

Algorithms are implemented on two time series of gaussian white noise, but you can replace them with any time series you like.

Documentation Documentation Status

API documentation

Contributing

To report bugs or improvements, or for any other question, please see CONTRIBUTING.md.

Credits

If you are using fathon in your research, please cite:

Bianchi, S., (2020). fathon: A Python package for a fast computation of detrendend fluctuation analysis and related algorithms. Journal of Open Source Software, 5(45), 1828, https://doi.org/10.21105/joss.01828

Version PyPI version

fathon v1.1

Changelog

v1.1

  • save object state to binary file and reload it later

v1.0

  • wheels! 🎡🎡
  • no more pre-installing step of the GSL library 🎉🎉
  • window's sizes array must be now passed to all the methods
  • logBase option for methods that perform fits
  • verbose option
  • pre-computed hq0 can be now passed to the computeHT method

v0.1.2

  • first release

Author

  • Stefano Bianchi

License GPLv3 License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

This code uses GSL which is licensed under the GNU General Public License v3.0, and can be obtained at https://www.gnu.org/software/gsl/.

fathon's People

Contributors

stfbnc avatar danielskatz avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.