{"id":13721733,"url":"https://sentinel-energy.github.io/friendly_data/","last_synced_at":"2025-05-07T14:30:41.515Z","repository":{"id":42007972,"uuid":"239746613","full_name":"sentinel-energy/friendly_data","owner":"sentinel-energy","description":"Data format to interoperate between models and frameworks","archived":false,"fork":false,"pushed_at":"2022-07-13T12:34:41.000Z","size":4881,"stargazers_count":12,"open_issues_count":9,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-06T05:46:57.214Z","etag":null,"topics":["analysis","datapackage","python","tabular-data"],"latest_commit_sha":null,"homepage":"https://sentinel-energy.github.io/friendly_data/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sentinel-energy.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-11T11:34:03.000Z","updated_at":"2024-07-17T16:19:12.000Z","dependencies_parsed_at":"2022-08-12T02:10:52.288Z","dependency_job_id":null,"html_url":"https://github.com/sentinel-energy/friendly_data","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sentinel-energy%2Ffriendly_data","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sentinel-energy%2Ffriendly_data/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sentinel-energy%2Ffriendly_data/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sentinel-energy%2Ffriendly_data/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sentinel-energy","download_url":"https://codeload.github.com/sentinel-energy/friendly_data/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252895472,"owners_count":21821167,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analysis","datapackage","python","tabular-data"],"created_at":"2024-08-03T01:01:20.693Z","updated_at":"2025-05-07T14:30:39.964Z","avatar_url":"https://github.com/sentinel-energy.png","language":"Python","funding_links":[],"categories":["Energy Systems"],"sub_categories":["Energy System Modeling Frameworks"],"readme":"Frictionless Energy data - Friendly data\n========================================\n|unittests| |coverage| |docs|\n\nA frictionless_ data package implementation for energy data;\nmaintained by the `SENTINEL collaboration`_.\n\nThis package provides a Python API and CLI utilities to read/write and\nmanage Energy (systems) data as a frictionless data package.  The\nPython API includes easy conversion to and from standard Python data\nstructures common in data analysis; e.g. ``pandas.DataFrame``,\n``xarray.DataArray``, ``xarray.Dataset``, etc.\n\nIt introduces energy modelling terminology by relying on an external\n(but loosely coupled) registry_ that collates commonly used variables\nand associated metadata.  If someone outside of the energy modelling\ncommunity wants to make use this package, it should be relatively\nstriaghtforward to point to a different registry while continuing to\nuse the same workflow.  Read more in the documentation_.\n\n.. _frictionless:\n   https://frictionlessdata.io/\n\n.. _`SENTINEL collaboration`:\n   https://sentinel.energy/\n\n.. _registry:\n   https://github.com/sentinel-energy/friendly_data_registry\n\n.. _documentation:\n   https://sentinel-energy.github.io/friendly_data/\n\n.. |unittests| image:: https://github.com/sentinel-energy/friendly_data/workflows/Unit%20tests/badge.svg\n   :target: https://github.com/sentinel-energy/friendly_data/actions?query=workflow%3A%22Unit+tests%22\n\n.. |coverage| image:: https://codecov.io/gh/sentinel-energy/friendly_data/branch/master/graph/badge.svg\n  :target: https://codecov.io/gh/sentinel-energy/friendly_data\n\n.. |docs| image:: https://github.com/sentinel-energy/friendly_data/workflows/Publish%20docs/badge.svg\n  :target: https://github.com/sentinel-energy/friendly_data/actions?query=workflow%3A%22Publish+docs%22\n\n\nInstallation\n------------\n\nYou can install (or update) the package with ``pip``::\n\n  $ pip install [-U] friendly-data\n    \nAs the registry is coupled loosely, so that it can be updated much\nfaster.  This will accomodate to an evolving data vocabulary of the\ncommunity.  So it is recommended to update the registry regularly, eventhough you might not want to update the main package.  You can do this with::\n\n  $ pip install -U friendly-data-registry\n\nIf your workflow also includes converting your data packages into IAMC\nformat, you will need the optional dependencies; which can be\ninstalled at any time like this (leaving out the `-U` will not upgrade\nthe main package)::\n\n  $ pip install [-U] friendly-data[extras]\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/sentinel-energy.github.io%2Ffriendly_data%2F","html_url":"https://awesome.ecosyste.ms/projects/sentinel-energy.github.io%2Ffriendly_data%2F","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/sentinel-energy.github.io%2Ffriendly_data%2F/lists"}