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:

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

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. For activating the automatic documentation with MkDocs, see here. To enable the code coverage reports, see here.

Releasing a new version

Create an API Token on Pypi.
Add the API Token to your projects secrets with the name PYPI_TOKEN by visiting this page.
Create a new release on Github.
Create a new tag in the form *.*.*.

For more details, see here.

Repository initiated with fpgmaas/cookiecutter-poetry.

Usage

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')>}

Metadata

Release files for energy_pandas 0.4.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for energy_pandas 0.4.1
File	Size	Uploaded
energy_pandas-0.4.1.tar.gz	17.3 kB	Sep 18, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for energy_pandas 0.4.1
File	Interpreter	ABI	Platform	Reset
energy_pandas-0.4.1-py3-none-any.whl 17.6 kB Sep 18, 2024	Python 3	none	any	Details

Total release size: 34.8 kB

Release files / energy_pandas-0.4.1.tar.gz

Download URL	energy_pandas-0.4.1.tar.gz
Size	17.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`23bd68fe66ab8a824287f36bfee33d7672b42bc4660211f2cf45829304230087`
BLAKE2b-256 checksum How to use checksums	`fc48a24c21d68c4cda41b385215f7690d512e2f51f755132a23f009009254976`
Upload date	Sep 18, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.3 CPython/3.11.10 Linux/6.8.0-1014-azure`

Release files / energy_pandas-0.4.1-py3-none-any.whl

Download URL	energy_pandas-0.4.1-py3-none-any.whl
Size	17.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`b043703d65f83750a52bdae74b69c9d8af790ed498e1af493295c70435999e3e`
BLAKE2b-256 checksum How to use checksums	`f2d345e56634c04d53fb02fb7379fc506d7435dce787f0b6211db4c080fcc32e`
Upload date	Sep 18, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.3 CPython/3.11.10 Linux/6.8.0-1014-azure`