Skip to main content

A frictionless data package implementation for energy system data.

Project description

unittests coverage docs

A frictionless data package implementation for energy data; maintained by the SENTINEL collaboration.

This package provides a Python API and CLI utilities to read/write and manage Energy (systems) data as a frictionless data package. The Python API includes easy conversion to and from standard Python data structures common in data analysis; e.g. pandas.DataFrame, xarray.DataArray, xarray.Dataset, etc.

It introduces energy modelling terminology by relying on an external (but loosely coupled) registry that collates commonly used variables and associated metadata. If someone outside of the energy modelling community wants to make use this package, it should be relatively striaghtforward to point to a different registry while continuing to use the same workflow. Read more in the documentation.

Installation

You can install (or update) the package with pip:

$ pip install [-U] friendly-data

As the registry is coupled loosely, so that it can be updated much faster. This will accomodate to an evolving data vocabulary of the community. So it is recommended to update the registry regularly, eventhough you might not want to update the main package. You can do this with:

$ pip install -U friendly-data-registry

If your workflow also includes converting your data packages into IAMC format, you will need the optional dependencies; which can be installed at any time like this (leaving out the -U will not upgrade the main package):

$ pip install [-U] friendly-data[extras]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

friendly_data-0.3.3.tar.gz (43.1 kB view details)

Uploaded Source

Built Distribution

friendly_data-0.3.3-py3-none-any.whl (49.3 kB view details)

Uploaded Python 3

File details

Details for the file friendly_data-0.3.3.tar.gz.

File metadata

  • Download URL: friendly_data-0.3.3.tar.gz
  • Upload date:
  • Size: 43.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

File hashes

Hashes for friendly_data-0.3.3.tar.gz
Algorithm Hash digest
SHA256 6769dc18c1030fe31d2b5377d842aea28d8b953de5f23d5ff247f3c0dd6093cf
MD5 3413473437c13dd852478c8f3103e151
BLAKE2b-256 984fc903ad1b372e081b9ac1f24bb33a46281824d020261a7e2aa39af221b9ae

See more details on using hashes here.

File details

Details for the file friendly_data-0.3.3-py3-none-any.whl.

File metadata

  • Download URL: friendly_data-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 49.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

File hashes

Hashes for friendly_data-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e0b5a84d44e71cdbf300b2aba68269762ee4ec1988705481b23e0e2328e52ce1
MD5 764c21d1e0ff255eac87eb7029f4018c
BLAKE2b-256 74e47c3b4618db61223e72bc2ba2eecef0e4f85968fd26f12612afc1bf6ae298

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page