blueetl-core


Nameblueetl-core JSON
Version 0.2.2 PyPI version JSON
download
home_pageNone
SummaryCore transformations for BlueETL
upload_time2024-04-08 13:23:10
maintainerNone
docs_urlNone
authorBlue Brain Project, EPFL
requires_python>=3.9
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            |banner|

|build_status| |license| |coverage| |docs| |CodeQL| |PyPI| |DOI|

blueetl-core
============

Core transformations for BlueETL.


Introduction
------------

``BlueETL-core`` automatically registers Pandas accessors using the ``.etl`` namespace, that can be useful to simplify some recurring operations on Pandas DataFrames, Series, and Indexes.

It provides the core transformations used by `BlueETL <https://github.com/BlueBrain/blueetl>`__, a package that can help analyse multiple simulations in a Simulation Campaign.


Installation
------------

``BlueETL-core`` can be installed independently from ``BlueETL`` with::

    pip install -U blueetl-core


Examples
--------

To use the Core Transformations provided by the ``.etl`` accessor with any Pandas DataFrame or Series, it's enough to import BlueETL or BlueETL-core, and call the desired methods.

For example:

.. code-block:: python


    import blueetl_core
    import pandas as pd

    df = pd.DataFrame({"a": [0, 1, 2], "b": [3, 4, 5]})
    df = df.etl.q(a=1)

See `this Jupyter notebook <https://blueetl.readthedocs.io/en/stable/notebooks/01_core_transformations.html>`__ for more information and examples.


Contribution Guidelines
-----------------------

See `<CONTRIBUTING.rst>`__.


Citation
--------

When you use this software, we kindly ask you to cite the following DOI:

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


Acknowledgment
--------------

The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology.

For license and authors, see `<LICENSE.txt>`__ and `<AUTHORS.txt>`__ respectively.

Copyright © 2023 Blue Brain Project/EPFL


.. |build_status| image:: https://github.com/BlueBrain/blueetl-core/actions/workflows/run-tox.yml/badge.svg
   :alt: Build Status

.. |license| image:: https://img.shields.io/pypi/l/blueetl-core
   :target: https://github.com/BlueBrain/blueetl-core/blob/main/LICENSE.txt
   :alt: License

.. |coverage| image:: https://codecov.io/github/BlueBrain/blueetl-core/coverage.svg?branch=main
   :target: https://codecov.io/github/BlueBrain/blueetl-core?branch=main
   :alt: codecov.io

.. |docs| image:: https://readthedocs.org/projects/blueetl-core/badge/?version=latest
   :target: https://blueetl-core.readthedocs.io/
   :alt: documentation status

.. |CodeQL| image:: https://github.com/BlueBrain/blueetl-core/actions/workflows/github-code-scanning/codeql/badge.svg
   :target: https://github.com/BlueBrain/blueetl-core/actions/workflows/github-code-scanning/codeql
   :alt: CodeQL

.. |PyPI| image:: https://github.com/BlueBrain/blueetl-core/actions/workflows/publish-sdist.yml/badge.svg
   :target: https://pypi.org/project/blueetl-core/
   :alt: PyPI

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

.. local-substitutions

.. |banner| image:: https://raw.githubusercontent.com/BlueBrain/blueetl-core/main/doc/source/_images/BlueETL.jpeg

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "blueetl-core",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Blue Brain Project, EPFL",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/89/75/2f777fbbb4653380cd00777de3c6ec9ebab697111424c078c20d23f3cacd/blueetl-core-0.2.2.tar.gz",
    "platform": null,
    "description": "|banner|\n\n|build_status| |license| |coverage| |docs| |CodeQL| |PyPI| |DOI|\n\nblueetl-core\n============\n\nCore transformations for BlueETL.\n\n\nIntroduction\n------------\n\n``BlueETL-core`` automatically registers Pandas accessors using the ``.etl`` namespace, that can be useful to simplify some recurring operations on Pandas DataFrames, Series, and Indexes.\n\nIt provides the core transformations used by `BlueETL <https://github.com/BlueBrain/blueetl>`__, a package that can help analyse multiple simulations in a Simulation Campaign.\n\n\nInstallation\n------------\n\n``BlueETL-core`` can be installed independently from ``BlueETL`` with::\n\n    pip install -U blueetl-core\n\n\nExamples\n--------\n\nTo use the Core Transformations provided by the ``.etl`` accessor with any Pandas DataFrame or Series, it's enough to import BlueETL or BlueETL-core, and call the desired methods.\n\nFor example:\n\n.. code-block:: python\n\n\n    import blueetl_core\n    import pandas as pd\n\n    df = pd.DataFrame({\"a\": [0, 1, 2], \"b\": [3, 4, 5]})\n    df = df.etl.q(a=1)\n\nSee `this Jupyter notebook <https://blueetl.readthedocs.io/en/stable/notebooks/01_core_transformations.html>`__ for more information and examples.\n\n\nContribution Guidelines\n-----------------------\n\nSee `<CONTRIBUTING.rst>`__.\n\n\nCitation\n--------\n\nWhen you use this software, we kindly ask you to cite the following DOI:\n\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10277477.svg\n   :target: https://doi.org/10.5281/zenodo.10277477\n\n\nAcknowledgment\n--------------\n\nThe development of this software was supported by funding to the Blue Brain Project, a research center of the \u00c9cole polytechnique f\u00e9d\u00e9rale de Lausanne (EPFL), from the Swiss government\u2019s ETH Board of the Swiss Federal Institutes of Technology.\n\nFor license and authors, see `<LICENSE.txt>`__ and `<AUTHORS.txt>`__ respectively.\n\nCopyright \u00a9 2023 Blue Brain Project/EPFL\n\n\n.. |build_status| image:: https://github.com/BlueBrain/blueetl-core/actions/workflows/run-tox.yml/badge.svg\n   :alt: Build Status\n\n.. |license| image:: https://img.shields.io/pypi/l/blueetl-core\n   :target: https://github.com/BlueBrain/blueetl-core/blob/main/LICENSE.txt\n   :alt: License\n\n.. |coverage| image:: https://codecov.io/github/BlueBrain/blueetl-core/coverage.svg?branch=main\n   :target: https://codecov.io/github/BlueBrain/blueetl-core?branch=main\n   :alt: codecov.io\n\n.. |docs| image:: https://readthedocs.org/projects/blueetl-core/badge/?version=latest\n   :target: https://blueetl-core.readthedocs.io/\n   :alt: documentation status\n\n.. |CodeQL| image:: https://github.com/BlueBrain/blueetl-core/actions/workflows/github-code-scanning/codeql/badge.svg\n   :target: https://github.com/BlueBrain/blueetl-core/actions/workflows/github-code-scanning/codeql\n   :alt: CodeQL\n\n.. |PyPI| image:: https://github.com/BlueBrain/blueetl-core/actions/workflows/publish-sdist.yml/badge.svg\n   :target: https://pypi.org/project/blueetl-core/\n   :alt: PyPI\n\n.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10277477.svg\n   :target: https://doi.org/10.5281/zenodo.10277477\n   :alt: DOI\n\n.. local-substitutions\n\n.. |banner| image:: https://raw.githubusercontent.com/BlueBrain/blueetl-core/main/doc/source/_images/BlueETL.jpeg\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Core transformations for BlueETL",
    "version": "0.2.2",
    "project_urls": {
        "Documentation": "https://blueetl-core.readthedocs.io/",
        "Homepage": "https://github.com/BlueBrain/blueetl-core",
        "Repository": "https://github.com/BlueBrain/blueetl-core.git",
        "Tracker": "https://github.com/BlueBrain/blueetl-core/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4d4331601f417b95e7ffc9f468d8d2ec33315eb9e1df9e24ac2f6fa863eb75c0",
                "md5": "9ae620f4e1cb9130af9bb9f263f2c978",
                "sha256": "b0f0f1da1c8527838c6b9f3a5c95ed41004acf21a066b7caea7047b506dc7440"
            },
            "downloads": -1,
            "filename": "blueetl_core-0.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9ae620f4e1cb9130af9bb9f263f2c978",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 21810,
            "upload_time": "2024-04-08T13:23:08",
            "upload_time_iso_8601": "2024-04-08T13:23:08.712823Z",
            "url": "https://files.pythonhosted.org/packages/4d/43/31601f417b95e7ffc9f468d8d2ec33315eb9e1df9e24ac2f6fa863eb75c0/blueetl_core-0.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "89752f777fbbb4653380cd00777de3c6ec9ebab697111424c078c20d23f3cacd",
                "md5": "cb7e42e72ee76993d9291d15da0324c2",
                "sha256": "09e980331be8094d7bd8f2e08a4ddb72a5ee2d849c7e6995264db1554a4a5fbc"
            },
            "downloads": -1,
            "filename": "blueetl-core-0.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "cb7e42e72ee76993d9291d15da0324c2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 211873,
            "upload_time": "2024-04-08T13:23:10",
            "upload_time_iso_8601": "2024-04-08T13:23:10.482957Z",
            "url": "https://files.pythonhosted.org/packages/89/75/2f777fbbb4653380cd00777de3c6ec9ebab697111424c078c20d23f3cacd/blueetl-core-0.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-08 13:23:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "BlueBrain",
    "github_project": "blueetl-core",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "blueetl-core"
}
        
Elapsed time: 0.22214s