dave-core 1.3.3
DAVE is a tool for automatic energy grid generation
Requires Python: >=3.11
Keywords: power system, gas system, network, modeling, automation, grid, energy, DAVE

=========
DAVE_core
=========

.. start-badges

.. list-table::
    :stub-columns: 1

    * - package
      - |version| |commits-since| |download| |licence| |wheel| |supported-versions|
    * - docs
      - |docs|
    * - tests
      - |github-actions| |coveralls| |codecov|
    * - code
      - |black| |isort| |ruff|

.. |download| image:: https://pepy.tech/badge/dave-core
    :alt: pepy
    :target: https://pepy.tech/project/dave-core

.. |version| image:: https://img.shields.io/pypi/v/dave_core.svg
    :alt: PyPI Package latest release
    :target: https://pypi.org/project/dave_core

.. |wheel| image:: https://img.shields.io/pypi/wheel/dave_core.svg
    :alt: PyPI Wheel
    :target: https://pypi.org/project/dave_core

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/dave_core.svg
    :alt: Supported versions
    :target: https://pypi.org/project/dave_core


.. |docs| image:: https://readthedocs.org/projects/dave-core/badge/?version=latest
    :target: https://dave-core.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

.. |github-actions| image:: https://github.com/DaveFoss/DAVE_core/actions/workflows/github-actions.yml/badge.svg
    :alt: GitHub Actions Build Status
    :target: https://github.com/DaveFoss/DAVE_core/actions


.. |coveralls| image:: https://coveralls.io/repos/github/DaveFoss/DAVE_core/badge.svg?branch=main
    :alt: Coverage Status
    :target: https://coveralls.io/github/DaveFoss/DAVE_core?branch=main

.. |codecov| image:: https://codecov.io/gh/DaveFoss/DAVE_core/branch/main/graphs/badge.svg?branch=main
    :alt: Coverage Status
    :target: https://app.codecov.io/github/DaveFoss/DAVE_core

.. |commits-since| image:: https://img.shields.io/github/commits-since/DaveFoss/DAVE_core/v1.3.3.svg
    :alt: Commits since latest release
    :target: https://github.com/DaveFoss/DAVE_core/compare/v1.3.3...main

.. |licence| image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
   :target: https://github.com/DaveFoss/DAVE_core/blob/main/LICENSE
   :alt: BSD

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black

.. |isort| image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
    :target: https://pycqa.github.io/isort/

.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
    :target: https://github.com/astral-sh/ruff
    :alt: Ruff

.. end-badges


DAVE is an softwaretool for a automatic generation of region-specific energy grid models. The resulting grid models are based on open data from different sources.


This code ist based on and explained in the following publicationat :

- `Banze, T., Kneiske, T.M. Open data for energy networks: introducing DAVE—a data fusion tool for automated network generation. Sci Rep 14, 1938 (2024). <https://doi.org/10.1038/s41598-024-52199-w>`_

More on DAVE is published on the webside http://databutler.energy


Installation
============

::

    pip install dave-core

You can also install the in-development version with::

    pip install https://github.com/DaveFoss/DAVE_core/archive/develop.zip


Documentation
=============


https://dave-core.readthedocs.io


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