Metadata-Version: 2.4
Name: oemof.eesyplan
Version: 0.0.1
Summary: SHORT DESCRIPTION
Keywords: 
Author-email: Open Plan Community and oemof developer group <contact@oemof.org>
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-Expression: MIT
Classifier: Development Status :: 5 - Production/Stable
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 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Utilities
License-File: LICENSE
Requires-Dist: oemof-network
Requires-Dist: oemof-solph
Requires-Dist: oemof-datapackage
Requires-Dist: sphinx ; extra == "docs"
Requires-Dist: sphinx_rtd_theme ; extra == "docs"
Requires-Dist: oemof ; extra == "dummy"
Requires-Dist: pytest ; extra == "test"
Requires-Dist: coverage ; extra == "test"
Requires-Dist: pvlib ; extra == "test"
Requires-Dist: demandlib ; extra == "test"
Requires-Dist: tox ; extra == "test"
Requires-Dist: oemof-visio ; extra == "test"
Project-URL: Changelog, https://oemof-eesyplan.readthedocs.io/en/latest/changelog.html
Project-URL: Documentation, https://oemof-eesyplan.readthedocs.io/
Project-URL: Homepage, https://github.com/oemof/oemof-eesyplan
Project-URL: Issue Tracker, https://github.com/oemof/oemof-eesyplan/issues/
Provides-Extra: docs
Provides-Extra: dummy
Provides-Extra: examples
Provides-Extra: test

=====================================
Easy Energy System Planing - eesyPlan
=====================================

The Easy Energy System Planing library is part of the `oemof <https://github.com/oemof/>`_ family.

.. start-badges

.. list-table::
    :stub-columns: 1

    * - docs
      - |docs|
    * - tests
      - |github-actions| |coveralls| |codecov_stable|
    * - package
      - |version| |wheel| |supported-versions| |supported-implementations| |commits-since|
.. |docs| image:: https://readthedocs.org/projects/oemof-eesyplan/badge/?style=flat
    :target: https://oemof-eesyplan.readthedocs.io/en/latest/
    :alt: Documentation Status

.. |github-actions| image:: https://github.com/oemof/oemof-eesyplan/actions/workflows/github-actions.yml/badge.svg
    :alt: GitHub Actions Build Status
    :target: https://github.com/oemof/oemof-eesyplan/actions

.. |coveralls| image:: https://coveralls.io/repos/github/oemof/oemof-eesyplan/badge.svg
    :alt: Coveralls coverage status
    :target: https://coveralls.io/github/oemof/oemof-eesyplan

.. |codecov_stable| image:: https://codecov.io/gh/oemof/oemof-eesyplan/branch/main/graph/badge.svg
   :alt: Codecov Coverage Status
   :target: https://codecov.io/gh/oemof/oemof-eesyplan

.. |codecov_dev| image:: https://codecov.io/gh/oemof/oemof-eesyplan/branch/dev/graph/badge.svg
   :alt: Codecov Coverage Status
   :target: https://codecov.io/gh/oemof/oemof-eesyplan

.. |version| image:: https://img.shields.io/pypi/v/oemof-eesyplan.svg
    :alt: PyPI Package latest release
    :target: https://pypi.org/project/oemof-eesyplan

.. |wheel| image:: https://img.shields.io/pypi/wheel/oemof-eesyplan.svg
    :alt: PyPI Wheel
    :target: https://pypi.org/project/oemof-eesyplan

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/oemof-eesyplan.svg
    :alt: Supported versions
    :target: https://pypi.org/project/oemof-eesyplan

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/oemof-eesyplan.svg
    :alt: Supported implementations
    :target: https://pypi.org/project/oemof-eesyplan

.. |commits-since| image:: https://img.shields.io/github/commits-since/oemof/oemof-eesyplan/v0.0.1.svg
    :alt: Commits since latest release
    :target: https://github.com/oemof/oemof-eesyplan/compare/v0.0.1...main



.. end-badges

SHORT DESCRIPTION

* Free software: MIT license

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

::

    pip install oemof-eesyplan

You can also install the in-development version with::

    pip install https://github.com/oemof/oemof-eesyplan/archive/main.zip


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


https://oemof-eesyplan.readthedocs.io/en/latest/


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

To run all the tests run::

    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

