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

Uploaded Source

Built Distribution

friendly_data-0.3.2-py3-none-any.whl (42.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: friendly_data-0.3.2.tar.gz
  • Upload date:
  • Size: 37.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.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.2.tar.gz
Algorithm Hash digest
SHA256 fdeb1717b87f350d9c083bcc2330089d8067489a7df549e161b275ecdac036d1
MD5 8faa4cdf064bc3534816e6ac804a71b1
BLAKE2b-256 4c45ea9802ef56517dcd8509d91d29e0ffac8ac2eff6db45cc0b07ee6f47301d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: friendly_data-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 42.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8fa9243b2bdfa807330a886df8de485afd499834dd3f52ba902793ff8c51f007
MD5 5792ff092ddda461e627eefcc4b6fa82
BLAKE2b-256 bc23a9af60ca2f84c0cd6330050a338b9edbe7fe54557dc703331bc60185f348

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