Metadata-Version: 2.1
Name: mosaik.SimConfig
Version: 0.1.0rc20190522133958
Summary: The missing implementation of mosaik's SimConfig dictionary.
Home-page: https://gitlab.com/offis.energy/mosaik/mosaik.simconfig
Author: Bengt Lüers
Author-email: bengt.lueers@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: mosaik-api (>=2.2)

# mosaik SimConfig

The missing implementation of mosaik's SimConfig dictionary.

## Status

* [![pipeline status](https://gitlab.com/offis.energy/mosaik/mosaik.simconfig/badges/master/pipeline.svg)](https://gitlab.com/offis.energy/mosaik/mosaik.simconfig/pipelines/)
* [![coverage report](https://gitlab.com/offis.energy/mosaik/mosaik.simconfig/badges/master/coverage.svg)](https://gitlab.com/offis.energy/mosaik/mosaik.simconfig/-/jobs)

## Ensuring PIP

    python -m ensurepip

## Setting up the Virtual Environment

    python -m venv venv

## Activating the Virtual Environment

Under BASH:

    source venv/bin/activate

Under Windows:

    venv\Scripts\activate

## Installing Requirements

     python -m pip install --upgrade -r requirements.d/venv.txt

## Running the Tests

Under Linux:

    venv/bin/python -m tox

Under Windows:

    venv\Scripts\python -m tox

## Updating the Virtual Environment Requirements

Under Linux:

    venv/bin/python -m pip_review --auto

Under Windows:

    venv\Scripts\python -m pip_review --auto

## Freezing the Virtual Environment Requirements

Under Linux

     venv/bin/python -m pip freeze --all --exclude-editable > requirements.d/venv.txt
     # And remove line beginning with package name

Under Windows

     venv\Scripts\python -m pip freeze --all --exclude-editable > requirements.d/venv.txt
    # And remove line beginning with package name

## Updating the Test Environment Requirements

Under Linux:

    .tox/py36/bin/python -m pip_review --auto

Under Windows:

    venv\Scripts\python -m pip_review --auto

## Freezing the Test Environment Requirements

Under Linux

    .tox/py36/bin/python -m pip freeze --all --exclude-editable > requirements.d/base.txt
    # And remove line beginning with package name

Under Windows

    .tox\py36\Scripts\python -m pip freeze --all --exclude-editable > requirements.d/base.txt
    # And remove line beginning with package name


Changelog
=========

0.1.0 - 2019-03-25
------------------

- [NEW] Initial release on GitLab.com


Authors
=======

Bengt Lüers


