Skip to main content

Functional Data Analysis Python package.

Project description

scikit-fda: Functional Data Analysis in Python

scikit-fda: Functional Data Analysis in Python

python build status Documentation Status Codecov Project Status: Active – The project has reached a stable, usable state and is being actively developed. PyPI - Python Version PyPIBadge Available in Conda license doi

Functional Data Analysis, or FDA, is the field of Statistics that analyses data that depend on a continuous parameter.

This package offers classes, methods and functions to give support to FDA in Python. Includes a wide range of utils to work with functional data, and its representation, exploratory analysis, or preprocessing, among other tasks such as inference, classification, regression or clustering of functional data. See documentation for further information on the features included in the package.

Documentation

The documentation is available at fda.readthedocs.io/en/stable/, which includes detailed information of the different modules, classes and methods of the package, along with several examples showing different functionalities.

The documentation of the latest version, corresponding with the develop version of the package, can be found at fda.readthedocs.io/en/latest/.

Installation

Currently, scikit-fda is available in Python versions above 3.8, regardless of the platform. The stable version can be installed via PyPI:

pip install scikit-fda

It is also available from conda-forge: .. code:

conda install -c conda-forge scikit-fda

Installation from source

It is possible to install the latest version of the package, available in the develop branch, by cloning this repository and doing a manual installation.

git clone https://github.com/GAA-UAM/scikit-fda.git
pip install ./scikit-fda

Make sure that your default Python version is currently supported, or change the python and pip commands by specifying a version, such as python3.8:

git clone https://github.com/GAA-UAM/scikit-fda.git
python3.8 -m pip install ./scikit-fda

Requirements

scikit-fda depends on the following packages:

The dependencies are automatically installed.

Citing scikit-fda

Please, if you find this software useful in your work, reference it citing the following paper:

@article{ramos-carreno++_2024_scikit-fda,
  author = {Ramos-Carreño, Carlos and Torrecilla, José L. and Carbajo Berrocal, Miguel and Marcos Manchón, Pablo and Suárez, Alberto},
  doi = {10.18637/jss.v109.i02},
  journal = {Journal of Statistical Software},
  month = may,
  number = {2},
  pages = {1--37},
  title = {{scikit-fda: A Python Package for Functional Data Analysis}},
  url = {https://www.jstatsoft.org/article/view/v109i02},
  volume = {109},
  year = {2024}
}

You can additionally cite the software repository itself using:

@misc{ramos-carreno++_2024_scikit-fda-repo,
  author = {The scikit-fda developers},
  doi = {10.5281/zenodo.3468127},
  month = feb,
  title = {scikit-fda: Functional Data Analysis in Python},
  url = {https://github.com/GAA-UAM/scikit-fda},
  year = {2024}
}

If you want to reference a particular version for reproducibility, check the version-specific DOIs available in Zenodo.

Contributions

All contributions are welcome. You can help this project grow in multiple ways, from creating an issue, reporting an improvement or a bug, to doing a repository fork and creating a pull request to the development branch.

The people involved at some point in the development of the package can be found in the contributors file.

License

The package is licensed under the BSD 3-Clause License. A copy of the license can be found along with the code.

Project details


Download files

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

Source Distribution

scikit_fda-0.10.1.tar.gz (386.9 kB view details)

Uploaded Source

Built Distribution

scikit_fda-0.10.1-py3-none-any.whl (488.6 kB view details)

Uploaded Python 3

File details

Details for the file scikit_fda-0.10.1.tar.gz.

File metadata

  • Download URL: scikit_fda-0.10.1.tar.gz
  • Upload date:
  • Size: 386.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for scikit_fda-0.10.1.tar.gz
Algorithm Hash digest
SHA256 46ef473ccc4ddcec539ab877e5716f349224c1cb685f07425799b5abbe5f08de
MD5 9e69178ac5905fe7dc99c29ab8ac681a
BLAKE2b-256 510991435c4ddd2d5282599ee876c93291c214be5626dd981387940944b9ccca

See more details on using hashes here.

File details

Details for the file scikit_fda-0.10.1-py3-none-any.whl.

File metadata

  • Download URL: scikit_fda-0.10.1-py3-none-any.whl
  • Upload date:
  • Size: 488.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for scikit_fda-0.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9db5817a7a70f0c1d7c2449dedd1196b25e787d8cc5a6c891cf772a395aec8ee
MD5 fd010c68f87451b30806d81a9f7f8a61
BLAKE2b-256 988fcb691eb94fd2361cafa7d9ee4a83d9482feeff970c4c6e6cc033fca17f6c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page