Skip to content

BlueBrain/blueetl-core

Repository files navigation

banner

Build Status License codecov.io documentation status 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, 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:

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

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