Frictionless Energy data

Common medium to facilitate the flow of data between energy and environmental models in a way that can be automated.
https://sentinel-energy.github.io/friendly_data/

Keywords

analysis datapackage python tabular-data

Keywords from Contributors

energy-system

Last synced: 3 months ago
JSON representation

Acceptance Criteria

• Revelant topics? false
• External users? true
• Open source license? true
• Active? false
• Fork? false

Repository metadata

Data format to interoperate between models and frameworks

• Host: GitHub
• URL: https://sentinel-energy.github.io/friendly_data/
• Owner: sentinel-energy
• License: apache-2.0
• Created: 2020-02-11T11:34:03.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-07-13T12:34:41.000Z (over 3 years ago)
• Last Synced: 2025-09-23T17:57:04.051Z (3 months ago)
• Topics: analysis, datapackage, python, tabular-data
• Language: Python
• Homepage: https://sentinel-energy.github.io/friendly_data/
• Size: 4.65 MB
• Stars: 12
• Watchers: 3
• Forks: 2
• Open Issues: 9
• Releases: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

README.rst

          Frictionless Energy data - Friendly data
========================================
|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_.

.. _frictionless:
   https://frictionlessdata.io/

.. _`SENTINEL collaboration`:
   https://sentinel.energy/

.. _registry:
   https://github.com/sentinel-energy/friendly_data_registry

.. _documentation:
   https://sentinel-energy.github.io/friendly_data/

.. |unittests| image:: https://github.com/sentinel-energy/friendly_data/workflows/Unit%20tests/badge.svg
   :target: https://github.com/sentinel-energy/friendly_data/actions?query=workflow%3A%22Unit+tests%22

.. |coverage| image:: https://codecov.io/gh/sentinel-energy/friendly_data/branch/master/graph/badge.svg
  :target: https://codecov.io/gh/sentinel-energy/friendly_data

.. |docs| image:: https://github.com/sentinel-energy/friendly_data/workflows/Publish%20docs/badge.svg
  :target: https://github.com/sentinel-energy/friendly_data/actions?query=workflow%3A%22Publish+docs%22


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]

        

---

Owner metadata

• Name: SENTINEL
• Login: sentinel-energy
• Email:
• Kind: organization
• Description: Sustainable Energy Transitions
• Website: https://sentinel.energy/
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/49453662?v=4
• Repositories: 2
• Last ynced at: 2023-03-11T05:52:19.742Z
• Profile URL: https://github.com/sentinel-energy

---

GitHub Events

Total

• Watch event: 1

Last Year

• Watch event: 1

---

Committers metadata

Last synced: 3 months ago

Name	Email	Commits
Suvayu Ali	f****x@g****m	447
Suvayu Ali	s****u@u****m	7
Stefan Pfenninger	s****n@p****g	2

Committer domains:

• pfenninger.org: 1

---

Issue and Pull Request metadata

Last synced: 4 months ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/sentinel-energy/friendly_data

---

---

---

Package metadata

• Total packages: 1
• Total downloads:
  • pypi: 246 last-month
• Total dependent packages: 1
• Total dependent repositories: 1
• Total versions: 8
• Total maintainers: 2

---

Dependencies

Score: 9.66459564425378