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.


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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 3

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