scikit-fda


Namescikit-fda JSON
Version 0.9.1 PyPI version JSON
download
home_page
SummaryFunctional Data Analysis Python package.
upload_time2024-02-26 11:54:59
maintainer
docs_urlNone
author
requires_python>=3.9
licenseBSD 3-Clause License Copyright (c) 2019, Grupo de Aprendizaje Automático - Universidad Autónoma de Madrid All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords functional data statistics machine learning
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: https://raw.githubusercontent.com/GAA-UAM/scikit-fda/develop/docs/logos/title_logo/title_logo.png
	:alt: scikit-fda: Functional Data Analysis in Python

scikit-fda: Functional Data Analysis in Python
===================================================

|python|_ |build-status| |docs| |Codecov| |repostatus| |versions| |PyPIBadge| |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/ <https://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/ <https://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_:

.. code::

    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.

.. code:: bash

    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``:

.. code:: bash

    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:

* `fdasrsf <https://github.com/jdtuck/fdasrsf_python>`_ - SRSF framework
* `findiff <https://github.com/maroba/findiff>`_ - Finite differences
* `matplotlib <https://github.com/matplotlib/matplotlib>`_ - Plotting with Python
* `multimethod <https://github.com/coady/multimethod>`_ - Multiple dispatch
* `numpy <https://github.com/numpy/numpy>`_ - The fundamental package for scientific computing with Python
* `pandas <https://github.com/pandas-dev/pandas>`_ - Powerful Python data analysis toolkit
* `rdata <https://github.com/vnmabus/rdata>`_ - Reader of R datasets in .rda format in Python
* `scikit-datasets <https://github.com/daviddiazvico/scikit-datasets>`_ - Scikit-learn compatible datasets
* `scikit-learn <https://github.com/scikit-learn/scikit-learn>`_ - Machine learning in Python
* `scipy <https://github.com/scipy/scipy>`_ - Scientific computation in Python
* `setuptools <https://github.com/pypa/setuptools>`_ - Python Packaging

The dependencies are automatically installed.

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 <https://github.com/GAA-UAM/scikit-fda/blob/develop/THANKS.txt>`_.

.. Citation
   ========
   If you find this project useful, please cite:

   .. todo:: Include citation to scikit-fda paper.

License
=======

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

.. _examples: https://fda.readthedocs.io/en/latest/auto_examples/index.html
.. _PyPI: https://pypi.org/project/scikit-fda/
.. _conda-forge: https://anaconda.org/conda-forge/scikit-fda/

.. |python| image:: https://img.shields.io/pypi/pyversions/scikit-fda.svg
.. _python: https://badge.fury.io/py/scikit-fda

.. |build-status| image:: https://github.com/GAA-UAM/scikit-fda/actions/workflows/tests.yml/badge.svg?event=push
    :alt: build status
    :scale: 100%
    :target: https://github.com/GAA-UAM/scikit-fda/actions/workflows/tests.yml

.. |docs| image:: https://readthedocs.org/projects/fda/badge/?version=latest
    :alt: Documentation Status
    :scale: 100%
    :target: http://fda.readthedocs.io/en/latest/?badge=latest

.. |Codecov| image:: https://codecov.io/gh/GAA-UAM/scikit-fda/branch/develop/graph/badge.svg
.. _Codecov: https://app.codecov.io/gh/GAA-UAM/scikit-fda

.. |repostatus| image:: https://www.repostatus.org/badges/latest/active.svg
   :alt: Project Status: Active – The project has reached a stable, usable state and is being actively developed.
   :target: https://www.repostatus.org/#active
   
.. |versions| image:: https://img.shields.io/pypi/pyversions/scikit-fda
   :alt: PyPI - Python Version
   :scale: 100%

.. |PyPIBadge| image:: https://badge.fury.io/py/scikit-fda.svg
.. _PyPIBadge: https://badge.fury.io/py/scikit-fda

.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/scikit-fda
    :alt: Available in Conda
    :scale: 100%
    :target: https://anaconda.org/conda-forge/scikit-fda

.. |license| image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
.. _license: https://github.com/GAA-UAM/scikit-fda/blob/master/LICENSE.txt

.. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3468127.svg
    :target: https://doi.org/10.5281/zenodo.3468127

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "scikit-fda",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "Carlos Ramos Carre\u00f1o <vnmabus@gmail.com>",
    "keywords": "functional data,statistics,machine learning",
    "author": "",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/d7/13/743f01d189b3f06a25fac94cba0ce4755df5bc6ce154327321d61611369c/scikit-fda-0.9.1.tar.gz",
    "platform": null,
    "description": ".. image:: https://raw.githubusercontent.com/GAA-UAM/scikit-fda/develop/docs/logos/title_logo/title_logo.png\n\t:alt: scikit-fda: Functional Data Analysis in Python\n\nscikit-fda: Functional Data Analysis in Python\n===================================================\n\n|python|_ |build-status| |docs| |Codecov| |repostatus| |versions| |PyPIBadge| |conda| |license| |doi|\n\nFunctional Data Analysis, or FDA, is the field of Statistics that analyses\ndata that depend on a continuous parameter.\n\nThis package offers classes, methods and functions to give support to FDA\nin Python. Includes a wide range of utils to work with functional data, and its\nrepresentation, exploratory analysis, or preprocessing, among other tasks\nsuch as inference, classification, regression or clustering of functional data.\nSee documentation for further information on the features included in the\npackage.\n\nDocumentation\n=============\n\nThe documentation is available at\n`fda.readthedocs.io/en/stable/ <https://fda.readthedocs.io/en/stable/>`_, which\nincludes detailed information of the different modules, classes and methods of\nthe package, along with several examples showing different functionalities.\n\nThe documentation of the latest version, corresponding with the develop\nversion of the package, can be found at\n`fda.readthedocs.io/en/latest/ <https://fda.readthedocs.io/en/latest/>`_.\n\nInstallation\n============\nCurrently, *scikit-fda* is available in Python versions above 3.8, regardless of the\nplatform.\nThe stable version can be installed via PyPI_:\n\n.. code::\n\n    pip install scikit-fda\n\nIt is also available from conda-forge:\n.. code::\n\n    conda install -c conda-forge scikit-fda\n\nInstallation from source\n------------------------\n\nIt is possible to install the latest version of the package, available in the\ndevelop branch,  by cloning this repository and doing a manual installation.\n\n.. code:: bash\n\n    git clone https://github.com/GAA-UAM/scikit-fda.git\n    pip install ./scikit-fda\n\nMake sure that your default Python version is currently supported, or change\nthe python and pip commands by specifying a version, such as ``python3.8``:\n\n.. code:: bash\n\n    git clone https://github.com/GAA-UAM/scikit-fda.git\n    python3.8 -m pip install ./scikit-fda\n\nRequirements\n------------\n*scikit-fda* depends on the following packages:\n\n* `fdasrsf <https://github.com/jdtuck/fdasrsf_python>`_ - SRSF framework\n* `findiff <https://github.com/maroba/findiff>`_ - Finite differences\n* `matplotlib <https://github.com/matplotlib/matplotlib>`_ - Plotting with Python\n* `multimethod <https://github.com/coady/multimethod>`_ - Multiple dispatch\n* `numpy <https://github.com/numpy/numpy>`_ - The fundamental package for scientific computing with Python\n* `pandas <https://github.com/pandas-dev/pandas>`_ - Powerful Python data analysis toolkit\n* `rdata <https://github.com/vnmabus/rdata>`_ - Reader of R datasets in .rda format in Python\n* `scikit-datasets <https://github.com/daviddiazvico/scikit-datasets>`_ - Scikit-learn compatible datasets\n* `scikit-learn <https://github.com/scikit-learn/scikit-learn>`_ - Machine learning in Python\n* `scipy <https://github.com/scipy/scipy>`_ - Scientific computation in Python\n* `setuptools <https://github.com/pypa/setuptools>`_ - Python Packaging\n\nThe dependencies are automatically installed.\n\nContributions\n=============\nAll contributions are welcome. You can help this project grow in multiple ways,\nfrom creating an issue, reporting an improvement or a bug, to doing a\nrepository fork and creating a pull request to the development branch.\n\nThe people involved at some point in the development of the package can be\nfound in the `contributors\nfile <https://github.com/GAA-UAM/scikit-fda/blob/develop/THANKS.txt>`_.\n\n.. Citation\n   ========\n   If you find this project useful, please cite:\n\n   .. todo:: Include citation to scikit-fda paper.\n\nLicense\n=======\n\nThe package is licensed under the BSD 3-Clause License. A copy of the\nlicense_ can be found along with the code.\n\n.. _examples: https://fda.readthedocs.io/en/latest/auto_examples/index.html\n.. _PyPI: https://pypi.org/project/scikit-fda/\n.. _conda-forge: https://anaconda.org/conda-forge/scikit-fda/\n\n.. |python| image:: https://img.shields.io/pypi/pyversions/scikit-fda.svg\n.. _python: https://badge.fury.io/py/scikit-fda\n\n.. |build-status| image:: https://github.com/GAA-UAM/scikit-fda/actions/workflows/tests.yml/badge.svg?event=push\n    :alt: build status\n    :scale: 100%\n    :target: https://github.com/GAA-UAM/scikit-fda/actions/workflows/tests.yml\n\n.. |docs| image:: https://readthedocs.org/projects/fda/badge/?version=latest\n    :alt: Documentation Status\n    :scale: 100%\n    :target: http://fda.readthedocs.io/en/latest/?badge=latest\n\n.. |Codecov| image:: https://codecov.io/gh/GAA-UAM/scikit-fda/branch/develop/graph/badge.svg\n.. _Codecov: https://app.codecov.io/gh/GAA-UAM/scikit-fda\n\n.. |repostatus| image:: https://www.repostatus.org/badges/latest/active.svg\n   :alt: Project Status: Active \u2013 The project has reached a stable, usable state and is being actively developed.\n   :target: https://www.repostatus.org/#active\n   \n.. |versions| image:: https://img.shields.io/pypi/pyversions/scikit-fda\n   :alt: PyPI - Python Version\n   :scale: 100%\n\n.. |PyPIBadge| image:: https://badge.fury.io/py/scikit-fda.svg\n.. _PyPIBadge: https://badge.fury.io/py/scikit-fda\n\n.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/scikit-fda\n    :alt: Available in Conda\n    :scale: 100%\n    :target: https://anaconda.org/conda-forge/scikit-fda\n\n.. |license| image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg\n.. _license: https://github.com/GAA-UAM/scikit-fda/blob/master/LICENSE.txt\n\n.. |doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3468127.svg\n    :target: https://doi.org/10.5281/zenodo.3468127\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License  Copyright (c) 2019, Grupo de Aprendizaje Autom\u00e1tico - Universidad Aut\u00f3noma de Madrid All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
    "summary": "Functional Data Analysis Python package.",
    "version": "0.9.1",
    "project_urls": {
        "documentation": "https://fda.readthedocs.io",
        "homepage": "https://github.com/GAA-UAM/scikit-fda",
        "repository": "https://github.com/GAA-UAM/scikit-fda"
    },
    "split_keywords": [
        "functional data",
        "statistics",
        "machine learning"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "26e2f748588fbedc883749e2ce30312c6a1fa7f4abead686c4d7ca05169c5c9c",
                "md5": "5cf31a5b5f4bab924c227815adac14f8",
                "sha256": "615bfb173d25ca495793a226248f65c193efc49fa942cf8bf94c0387099e5d63"
            },
            "downloads": -1,
            "filename": "scikit_fda-0.9.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5cf31a5b5f4bab924c227815adac14f8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 434736,
            "upload_time": "2024-02-26T11:54:57",
            "upload_time_iso_8601": "2024-02-26T11:54:57.904778Z",
            "url": "https://files.pythonhosted.org/packages/26/e2/f748588fbedc883749e2ce30312c6a1fa7f4abead686c4d7ca05169c5c9c/scikit_fda-0.9.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d713743f01d189b3f06a25fac94cba0ce4755df5bc6ce154327321d61611369c",
                "md5": "10baa54c33acdb7d68bc1f003bff6f18",
                "sha256": "4a92793eaf2585253ef0ec377620e9ef42b1dbb3be60b765b0c52ccffccb09cf"
            },
            "downloads": -1,
            "filename": "scikit-fda-0.9.1.tar.gz",
            "has_sig": false,
            "md5_digest": "10baa54c33acdb7d68bc1f003bff6f18",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 338214,
            "upload_time": "2024-02-26T11:54:59",
            "upload_time_iso_8601": "2024-02-26T11:54:59.899139Z",
            "url": "https://files.pythonhosted.org/packages/d7/13/743f01d189b3f06a25fac94cba0ce4755df5bc6ce154327321d61611369c/scikit-fda-0.9.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-26 11:54:59",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "GAA-UAM",
    "github_project": "scikit-fda",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "scikit-fda"
}
        
Elapsed time: 0.20482s