Metadata-Version: 2.4
Name: oemof.datapackage
Version: 0.0.6b2
Summary: Load oemof energy systems from datapackage data sources.
Home-page: https://github.com/oemof/oemof-datapackage
Author: Stephan Günther, Simon Hilpert, Martin Söthe, Jann Launer, Hendrik Huyskens, Julian Endres, Felix Maurer
Author-email: gnn.code@gmail.com
License: BSD-3-Clause
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Utilities
Requires-Python: >=3.9
License-File: LICENSE
License-File: AUTHORS.rst
Requires-Dist: chardet<6.0,>=5.0
Requires-Dist: datapackage>=1.5.1
Requires-Dist: tableschema
Requires-Dist: oemof.solph
Requires-Dist: pandas>=0.22
Requires-Dist: oemof.network
Requires-Dist: numpy
Provides-Extra: cli
Requires-Dist: click; extra == "cli"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Provides-Extra: plots
Requires-Dist: plotly; extra == "plots"
Requires-Dist: matplotlib; extra == "plots"
Provides-Extra: aggregation
Requires-Dist: tsam; extra == "aggregation"
Provides-Extra: geometry
Requires-Dist: shapely; extra == "geometry"
Requires-Dist: scipy; extra == "geometry"
Requires-Dist: pyproj; extra == "geometry"
Requires-Dist: geojson; extra == "geometry"
Requires-Dist: pyshp; extra == "geometry"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

========
Overview
========



Load oemof energy systems from datapackage data sources.

We plan to use the datapackage idea for oemof-solph without being bound to the internal facade structure of oemof-tabular.

If we do this within the tabular structure, there is a risk of breaking the package for others. That is why we decided to fork the project first and then consider later how we can bring the results back together. We don't know how many people use tabular's internal classes and why. There are now more options in oemof-solph and other repositories exist that offer derived components. So the gap that tabular once filled no longer exists to the same extent. But the datapackage itself is a great idea that should be accessable without the tabular structure.

* Free software: BSD 3-Clause License

Installation
============

Simpy run:

::

    pip install oemof.datapackage


Documentation
=============


https://oemof-datapackage.readthedocs.io/


Development
===========

Please activate pre-commit hooks in order to follow our coding styles:

::

    pip install pre-commit
    pre-commit install

To run the all tests run:

::

    pytest


..    tox

.. Note, to combine the coverage data from all the tox environments run:

.. .. list-table::
    :widths: 10 90
    :stub-columns: 1

    - - Windows
      - ::

            set PYTEST_ADDOPTS=--cov-append
            tox

    - - Other
      - ::

            PYTEST_ADDOPTS=--cov-append tox


Changelog
=========



Unreleased
----------

Features
* Improve the function to infer package metadata `#173 <https://github.com/oemof/oemof-tabular/pull/173>`_
* Add facades `CommodityGHG` and `ConversionGHG` to enable multiple output flows (emissions) `#180 <https://github.com/oemof/oemof-tabular/pull/180>`_

Fixes

* MultiIndexError in postprocessing if more than 2 oemof nodes are given `#174 <https://github.com/oemof/oemof-tabular/issues/174>`_
* Updated dependencies for datapackage and tableschema
* Error due to "fake" foreign keys in datapackage resources


0.0.5 Patch Release - Miraculous Mary (2024-02-23)
-----------------------------------------------------

Features

* Improve reading error message `#134 <https://github.com/oemof/oemof-tabular/pull/134>`_
* Remove facade relicts `#135 <https://github.com/oemof/oemof-tabular/pull/135>`_
* Add dev install version `#147 <https://github.com/oemof/oemof-tabular/pull/147>`_

Fixes

* Remove specific dirs from flake8 & isort `#136 <https://github.com/oemof/oemof-tabular/pull/136>`_
* Update lp-files to pyomo6.7 `#148 <https://github.com/oemof/oemof-tabular/pull/148>`_
* Rework periodic value deserialization `#154 <https://github.com/oemof/oemof-tabular/pull/154>`_
* Fix oemof.solph version to v0.5.2dev1 `#157 <https://github.com/oemof/oemof-tabular/pull/157>`_
* Fix oemof.solph version to v0.5.2.dev1 `#159 <https://github.com/oemof/oemof-tabular/pull/159>`_



0.0.4 Patch Release (2023-08-31)
-----------------------------------------------------

Features

* Add PR template `#129 <https://github.com/oemof/oemof-tabular/pull/129>`_
* Add deprecation warning for python3.8 `#125 <https://github.com/oemof/oemof-tabular/pull/125>`_
* Update to oemof.solph 0.5.1 latest changes `#123 <https://github.com/oemof/oemof-tabular/pull/123>`_
* Add multi-period deserialization `#112 <https://github.com/oemof/oemof-tabular/pull/112>`_
* Add multi-period investment `#108 <https://github.com/oemof/oemof-tabular/pull/108>`_
* Make oemof.solph 0.5.1 work `#107 <https://github.com/oemof/oemof-tabular/pull/107>`_
* Split facades into submodules `#92 <https://github.com/oemof/oemof-tabular/pull/92>`_
* Add postprocessing module `#102 <https://github.com/oemof/oemof-tabular/pull/102>`_

Fixes

* Update neglected CHANGELOG `#130 <https://github.com/oemof/oemof-tabular/pull/130>`_


0.0.3 (2022-01-26)
------------------
Fixes

* Fix link by not setting constraints that limit direction `#38 <https://github.com/oemof/oemof-tabular/pull/38>`_
* Fix storage investment `#33 <https://github.com/oemof/oemof-tabular/pull/33>`_
* Link investment `#28 <https://github.com/oemof/oemof-tabular/pull/28>`_
* Variable cost `#24 <https://github.com/oemof/oemof-tabular/pull/24>`_
* Marginal cost `#23 <https://github.com/oemof/oemof-tabular/pull/23>`_

Features

* Adjust to new oemof.solph structure `#21 <https://github.com/oemof/oemof-tabular/pull/21>`_
* Allow to define custom foreign keys `#39 <https://github.com/oemof/oemof-tabular/pull/39>`_
* Add constraint tests for most facades `#35 <https://github.com/oemof/oemof-tabular/pull/35>`_, `#42 <https://github.com/oemof/oemof-tabular/pull/42>`_
* Reduce number of imported packages `#32 <https://github.com/oemof/oemof-tabular/pull/32>`_, `#49 <https://github.com/oemof/oemof-tabular/pull/49>`_
* Cleaned up the badges in README `#59 <https://github.com/oemof/oemof-tabular/pull/59>`_
* Move most CI services to github actions `#37 <https://github.com/oemof/oemof-tabular/pull/37>`_

0.0.2 (2019-07-08)
------------------

0.0.1 (2018-12-12)
------------------
* Moved the datapackage reader from core `oemof` into this package.
  That means the basic functionality of deserializing energy systems
  from datapackages has finally arrived.
* Moved `Facade` classes from `renpass` into this package.
  The `Facade` classes are designed to complement the datapackage
  reader, by enabling easy construction of energy system components from
  simple datapackage data sources.
* Also moved the example datapackages from `renpass` into this package.
  These datapackages provide a good way of at least testing, that the
  datapackage reader doesn't throw errors.

0.0.0 (2018-11-23)
------------------

* First release on PyPI.
  Pretty much non functional because it only consists of the package
  boilerplate and nothing else. But this is what a version zero is for,
  IMHO.

