Metadata-Version: 2.1
Name: midas-sndata
Version: 2.0.0
Summary: A Midas module for the Smart Nord dataset.
Author-email: Stephan Balduin <stephan.balduin@offis.de>
Project-URL: Documentation, https://midas-mosaik.gitlab.io/midas
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: midas_powerseries>=2.0.0
Requires-Dist: tables
Requires-Dist: pandas
Requires-Dist: numpy<2

# Midas Smart Nord Data Simulator

## Description

This package contains a midas module providing a simulator for the Smart Nord data set.

Although this package is intended to be used with midas, it can be used in any mosaik simulation scenario.

## Installation

This package will usually installed automatically together with `midas-mosaik` if you opt-in for the `base` extra. 
It is available on pypi, so you can install it manually with

```bash
pip install midas-sndata
```

## Usage

The complete documentation is available at https://midas-mosaik.gitlab.io/midas.

### Inside of midas
To use the powergrid inside of midas, just add `sndata` to your modules

```yaml
my_scenario:
  modules:
    - sndata
    - ...
```

and configure it with:

```yaml
  sndata_params:
    my_grid_scope:
      step_size: 900  # <-- Default value
      grid_name: my_grid_scope
      active_mapping: 
        1: [[Land_0, 1.0], [Land_2, 1.5]]
        3: [[House_000, 1.0]]
```

The mapping has to the the grid that you're using

## License

This software is released under the GNU Lesser General Public License (LGPL). 
See the license file for more information about the details.
