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.1.tar.gz (36.7 kB view details)

Uploaded Source

Built Distribution

friendly_data-0.3.1-py3-none-any.whl (41.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: friendly_data-0.3.1.tar.gz
  • Upload date:
  • Size: 36.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for friendly_data-0.3.1.tar.gz
Algorithm Hash digest
SHA256 a6f54d6260b74ad9dfba7c8ed543b2ca6ce0f6f2a810698eb94fc3636c55039b
MD5 cce647e5f41aedbf163f5ce649c4c52b
BLAKE2b-256 3c80a08a441c9af31180229fa83129aec08c564b3478f25764870dfe4d5f2b61

See more details on using hashes here.

File details

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

File metadata

  • Download URL: friendly_data-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 41.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for friendly_data-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9ac25aa3fee5966ada2159d4132c2d807dd4df2f8e79ee75ec375cd880e3fd89
MD5 03c24fc3bd700852c8e10fda3e0c70ef
BLAKE2b-256 912633a3f920a11467d2dfeb18392273594b42e377bfd5f9a0bb450726503bd6

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