mosaik.HouseholdSim-SemVer


Namemosaik.HouseholdSim-SemVer JSON
Version 2.0.4rc20220703000445 PyPI version JSON
download
home_pagehttps://bitbucket.org/mosaik/mosaik-householdsim
SummaryA simple simulator for household profiles.
upload_time2022-07-03 00:04:53
maintainerBengt Lüers
docs_urlNone
authorStefan Scherfke
requires_python
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            HouseholdSim
============

This is pseudo simulator to serve residual load profiles to mosaik.

Status
------

.. image:: https://gitlab.com/offis.energy/mosaik/mosaik.householdsim_semver/badges/master/pipeline.svg
    :target: https://gitlab.com/offis.energy/mosaik/mosaik.householdsim_semver/-/jobs
    :alt: Pipeline status

.. image:: https://gitlab.com/offis.energy/mosaik/mosaik.householdsim_semver/badges/master/coverage.svg
    :target: https://gitlab.com/offis.energy/mosaik/mosaik.householdsim_semver/commits/master
    :alt: Coverage Report

.. image:: https://img.shields.io/librariesio/release/pypi/mosaik.householdsim_semver
    :target: https://libraries.io/pypi/mosaik.householdsim_semver
    :alt: Libraries status

.. image:: https://img.shields.io/pypi/l/mosaik.householdsim_semver
    :target: https://pypi.org/project/mosaik.householdsim_semver/
    :alt: License badge

.. image:: https://img.shields.io/pypi/v/mosaik.householdsim_semver
    :target: https://pypi.org/project/mosaik.householdsim_semver/#history
    :alt: PyPI version

.. image:: https://img.shields.io/pypi/pyversions/mosaik.householdsim_semver
    :target: https://pypi.org/project/mosaik.householdsim_semver/
    :alt: Python Versions

Installation
------------

::

    $ pip install mosaik-householdsim

Tests
-----

You can run the tests with::

    $ git clone https://bitbucket.org/mosaik/mosaik-householdsim
    $ cd mosaik-householdsim
    $ pip install -r requirements.txt
    $ pip install -e .
    $ pytest
    $ tox


Documentation
-------------

This simulator consists of a a *model* (``householdsim/model.py``) and the
mosaik API implemenation (``householdsim/mosaik.py``).

The model processes the data from a NumPy *\*.npz* file (see
``householdsim/test/test_model.py`` for an example of its layout). Basically,
the file contains a number of load profiles for a given period of time. It
also contains *ID lists* that describe which load profile belongs to which
node ID in a power grid. The first entry in an ID list relates to the first
entry of the profiles list, the second entry in the ID list to the second
load profile and so on. If the number of entires in the ID list is larger than
the number of load profiles, we start again with the first load profile.

Internally, the model works with minute. Since mosaik is based on seconds,
the mosaik API implementation converts between them.

Usually, residual load profiles have a resolution of 15 minutes. It is no
problem for this simulator to step in 1 minute steps, though.


Changelog
=========

2.0.3 – 2019-09-27
------------------

- [FIX] Fixed incompatibility with new arrow version.
- [FIX] Fixed time offset bug.


2.0.2 – 2014-09-22
------------------

- [CHANGE] Updated to mosaik-api 2.0.


2.0.1 – 2014-06-26
------------------

- [CHANGE] Adopted latest changes of the mosaik low-level API.


2.0 – 2014-03-26
----------------

- Updated API implementation for mosaik2.


1.0 – 2014-01-30
----------------

- Initial release.


Authors
=======

The household simulator was created by Stefan Scherfke and Ontje Lünsdorf.



            

Raw data

            {
    "_id": null,
    "home_page": "https://bitbucket.org/mosaik/mosaik-householdsim",
    "name": "mosaik.HouseholdSim-SemVer",
    "maintainer": "Bengt L\u00fcers",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "bengt.lueers@gmail.com",
    "keywords": "",
    "author": "Stefan Scherfke",
    "author_email": "mosaik@offis.de",
    "download_url": "",
    "platform": null,
    "description": "HouseholdSim\n============\n\nThis is pseudo simulator to serve residual load profiles to mosaik.\n\nStatus\n------\n\n.. image:: https://gitlab.com/offis.energy/mosaik/mosaik.householdsim_semver/badges/master/pipeline.svg\n    :target: https://gitlab.com/offis.energy/mosaik/mosaik.householdsim_semver/-/jobs\n    :alt: Pipeline status\n\n.. image:: https://gitlab.com/offis.energy/mosaik/mosaik.householdsim_semver/badges/master/coverage.svg\n    :target: https://gitlab.com/offis.energy/mosaik/mosaik.householdsim_semver/commits/master\n    :alt: Coverage Report\n\n.. image:: https://img.shields.io/librariesio/release/pypi/mosaik.householdsim_semver\n    :target: https://libraries.io/pypi/mosaik.householdsim_semver\n    :alt: Libraries status\n\n.. image:: https://img.shields.io/pypi/l/mosaik.householdsim_semver\n    :target: https://pypi.org/project/mosaik.householdsim_semver/\n    :alt: License badge\n\n.. image:: https://img.shields.io/pypi/v/mosaik.householdsim_semver\n    :target: https://pypi.org/project/mosaik.householdsim_semver/#history\n    :alt: PyPI version\n\n.. image:: https://img.shields.io/pypi/pyversions/mosaik.householdsim_semver\n    :target: https://pypi.org/project/mosaik.householdsim_semver/\n    :alt: Python Versions\n\nInstallation\n------------\n\n::\n\n    $ pip install mosaik-householdsim\n\nTests\n-----\n\nYou can run the tests with::\n\n    $ git clone https://bitbucket.org/mosaik/mosaik-householdsim\n    $ cd mosaik-householdsim\n    $ pip install -r requirements.txt\n    $ pip install -e .\n    $ pytest\n    $ tox\n\n\nDocumentation\n-------------\n\nThis simulator consists of a a *model* (``householdsim/model.py``) and the\nmosaik API implemenation (``householdsim/mosaik.py``).\n\nThe model processes the data from a NumPy *\\*.npz* file (see\n``householdsim/test/test_model.py`` for an example of its layout). Basically,\nthe file contains a number of load profiles for a given period of time. It\nalso contains *ID lists* that describe which load profile belongs to which\nnode ID in a power grid. The first entry in an ID list relates to the first\nentry of the profiles list, the second entry in the ID list to the second\nload profile and so on. If the number of entires in the ID list is larger than\nthe number of load profiles, we start again with the first load profile.\n\nInternally, the model works with minute. Since mosaik is based on seconds,\nthe mosaik API implementation converts between them.\n\nUsually, residual load profiles have a resolution of 15 minutes. It is no\nproblem for this simulator to step in 1 minute steps, though.\n\n\nChangelog\n=========\n\n2.0.3 \u2013 2019-09-27\n------------------\n\n- [FIX] Fixed incompatibility with new arrow version.\n- [FIX] Fixed time offset bug.\n\n\n2.0.2 \u2013 2014-09-22\n------------------\n\n- [CHANGE] Updated to mosaik-api 2.0.\n\n\n2.0.1 \u2013 2014-06-26\n------------------\n\n- [CHANGE] Adopted latest changes of the mosaik low-level API.\n\n\n2.0 \u2013 2014-03-26\n----------------\n\n- Updated API implementation for mosaik2.\n\n\n1.0 \u2013 2014-01-30\n----------------\n\n- Initial release.\n\n\nAuthors\n=======\n\nThe household simulator was created by Stefan Scherfke and Ontje L\u00fcnsdorf.\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A simple simulator for household profiles.",
    "version": "2.0.4rc20220703000445",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "e6cca8d97b997fb032fa8c391402f706",
                "sha256": "3eb66781ce2e4609bdde593d55d4520bc2c8bfac71fbb22520583b7a961d9497"
            },
            "downloads": -1,
            "filename": "mosaik.HouseholdSim_SemVer-2.0.4rc20220703000445-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e6cca8d97b997fb032fa8c391402f706",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 15787,
            "upload_time": "2022-07-03T00:04:53",
            "upload_time_iso_8601": "2022-07-03T00:04:53.396667Z",
            "url": "https://files.pythonhosted.org/packages/a8/25/7ba01475ce8ead293af96a84b69e2ca2640ce5916db502ba56ef12c04214/mosaik.HouseholdSim_SemVer-2.0.4rc20220703000445-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-07-03 00:04:53",
    "github": false,
    "gitlab": false,
    "bitbucket": true,
    "bitbucket_user": "mosaik",
    "bitbucket_project": "mosaik-householdsim",
    "lcname": "mosaik.householdsim-semver"
}
        
Elapsed time: 0.59121s