# energy-pandas
[](https://img.shields.io/github/v/release/samuelduchesne/energy-pandas)
[](https://github.com/samuelduchesne/energy-pandas/actions/workflows/main.yml?query=branch%3Amain)
[](https://codecov.io/gh/samuelduchesne/energy-pandas)
[](https://img.shields.io/github/commit-activity/m/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')>}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/samuelduchesne/energy-pandas",
"name": "energy_pandas",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Samuel Letellier-Duchesne",
"author_email": "fsamuelduchesne@me.com",
"download_url": "https://files.pythonhosted.org/packages/fc/48/a24c21d68c4cda41b385215f7690d512e2f51f755132a23f009009254976/energy_pandas-0.4.1.tar.gz",
"platform": null,
"description": "# energy-pandas\n\n[](https://img.shields.io/github/v/release/samuelduchesne/energy-pandas)\n[](https://github.com/samuelduchesne/energy-pandas/actions/workflows/main.yml?query=branch%3Amain)\n[](https://codecov.io/gh/samuelduchesne/energy-pandas)\n[](https://img.shields.io/github/commit-activity/m/samuelduchesne/energy-pandas)\n[](https://img.shields.io/github/license/samuelduchesne/energy-pandas)\n\nThis is a template repository for Python projects that use Poetry for their dependency management.\n\n- **Github repository**: <https://github.com/samuelduchesne/energy-pandas/>\n- **Documentation** <https://samuelduchesne.github.io/energy-pandas/>\n\n## Getting started with your project\n\nFirst, create a repository on GitHub with the same name as this project, and then run the following commands:\n\n```bash\ngit init -b main\ngit add .\ngit commit -m \"init commit\"\ngit remote add origin git@github.com:samuelduchesne/energy-pandas.git\ngit push -u origin main\n```\n\nFinally, install the environment and the pre-commit hooks with\n\n```bash\nmake install\n```\n\nYou are now ready to start development on your project!\nThe CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.\n\nTo finalize the set-up for publishing to PyPi or Artifactory, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/publishing/#set-up-for-pypi).\nFor activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github).\nTo enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/codecov/).\n\n## Releasing a new version\n\n- Create an API Token on [Pypi](https://pypi.org/).\n- 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).\n- Create a [new release](https://github.com/samuelduchesne/energy-pandas/releases/new) on Github.\n- Create a new tag in the form `*.*.*`.\n\nFor more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release).\n\n---\n\nRepository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).\n\n## Usage\n\n```python\nfrom energy_pandas import EnergyDataFrame, EnergySeries\n\nedf = EnergyDataFrame(\n {\n \"temp\": EnergySeries(range(0,100), units=\"degC\"),\n \"q_heat\": EnergySeries(range(0,100), units=\"W\"),\n \"q_cool\": EnergySeries(range(0,100), units=\"W\")\n },\n name=\"Zone 1\"\n)\nedf.units\n{'temp': <Unit('degree_Celsius')>, 'q_heat': <Unit('watt')>, 'q_cool': <Unit('watt')>}\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "Building Energy pandas extension",
"version": "0.4.1",
"project_urls": {
"Documentation": "https://samuelduchesne.github.io/energy-pandas/",
"Homepage": "https://github.com/samuelduchesne/energy-pandas",
"Repository": "https://github.com/samuelduchesne/energy-pandas"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f2d345e56634c04d53fb02fb7379fc506d7435dce787f0b6211db4c080fcc32e",
"md5": "316b6612ce29ed49e07635ac9a81738e",
"sha256": "b043703d65f83750a52bdae74b69c9d8af790ed498e1af493295c70435999e3e"
},
"downloads": -1,
"filename": "energy_pandas-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "316b6612ce29ed49e07635ac9a81738e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 17568,
"upload_time": "2024-09-18T21:54:34",
"upload_time_iso_8601": "2024-09-18T21:54:34.605855Z",
"url": "https://files.pythonhosted.org/packages/f2/d3/45e56634c04d53fb02fb7379fc506d7435dce787f0b6211db4c080fcc32e/energy_pandas-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fc48a24c21d68c4cda41b385215f7690d512e2f51f755132a23f009009254976",
"md5": "c5d344662f5793501bae884c946f57a6",
"sha256": "23bd68fe66ab8a824287f36bfee33d7672b42bc4660211f2cf45829304230087"
},
"downloads": -1,
"filename": "energy_pandas-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "c5d344662f5793501bae884c946f57a6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 17269,
"upload_time": "2024-09-18T21:54:36",
"upload_time_iso_8601": "2024-09-18T21:54:36.041117Z",
"url": "https://files.pythonhosted.org/packages/fc/48/a24c21d68c4cda41b385215f7690d512e2f51f755132a23f009009254976/energy_pandas-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-18 21:54:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "samuelduchesne",
"github_project": "energy-pandas",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "energy_pandas"
}
JSON
