energy_pandas 0.4.1
Building Energy pandas extension
Requires Python: <4.0,>=3.9

# energy-pandas

[![Release](https://img.shields.io/github/v/release/samuelduchesne/energy-pandas)](https://img.shields.io/github/v/release/samuelduchesne/energy-pandas)
[![Build status](https://img.shields.io/github/actions/workflow/status/samuelduchesne/energy-pandas/main.yml?branch=main)](https://github.com/samuelduchesne/energy-pandas/actions/workflows/main.yml?query=branch%3Amain)
[![codecov](https://codecov.io/gh/samuelduchesne/energy-pandas/branch/main/graph/badge.svg)](https://codecov.io/gh/samuelduchesne/energy-pandas)
[![Commit activity](https://img.shields.io/github/commit-activity/m/samuelduchesne/energy-pandas)](https://img.shields.io/github/commit-activity/m/samuelduchesne/energy-pandas)
[![License](https://img.shields.io/github/license/samuelduchesne/energy-pandas)](https://img.shields.io/github/license/samuelduchesne/energy-pandas)

This is a template repository for Python projects that use Poetry for their dependency management.

- **Github repository**: <https://github.com/samuelduchesne/energy-pandas/>
- **Documentation** <https://samuelduchesne.github.io/energy-pandas/>

## Getting started with your project

First, create a repository on GitHub with the same name as this project, and then run the following commands:

```bash
git init -b main
git add .
git commit -m "init commit"
git remote add origin git@github.com:samuelduchesne/energy-pandas.git
git push -u origin main
```

Finally, install the environment and the pre-commit hooks with

```bash
make install
```

You are now ready to start development on your project!
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.

To finalize the set-up for publishing to PyPi or Artifactory, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/codecov/).

## Releasing a new version

- Create an API Token on [Pypi](https://pypi.org/).
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/samuelduchesne/energy-pandas/settings/secrets/actions/new).
- Create a [new release](https://github.com/samuelduchesne/energy-pandas/releases/new) on Github.
- Create a new tag in the form `*.*.*`.

For more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release).

---

Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).

## Usage

```python
from energy_pandas import EnergyDataFrame, EnergySeries

edf = EnergyDataFrame(
    {
        "temp": EnergySeries(range(0,100), units="degC"),
        "q_heat": EnergySeries(range(0,100), units="W"),
        "q_cool": EnergySeries(range(0,100), units="W")
    },
    name="Zone 1"
)
edf.units
{'temp': <Unit('degree_Celsius')>, 'q_heat': <Unit('watt')>, 'q_cool': <Unit('watt')>}
```