fameio 1.8.2__py3-none-any.whl → 2.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- CHANGELOG.md +224 -0
- fameio/scripts/__init__.py +8 -6
- fameio/scripts/__init__.py.license +3 -0
- fameio/scripts/convert_results.py +31 -35
- fameio/scripts/convert_results.py.license +3 -0
- fameio/scripts/make_config.py +14 -17
- fameio/scripts/make_config.py.license +3 -0
- fameio/source/cli/__init__.py +3 -0
- fameio/source/cli/convert_results.py +84 -0
- fameio/source/cli/make_config.py +62 -0
- fameio/source/cli/options.py +58 -0
- fameio/source/cli/parser.py +238 -0
- fameio/source/loader.py +10 -11
- fameio/source/logs.py +90 -35
- fameio/source/results/conversion.py +11 -13
- fameio/source/results/csv_writer.py +16 -5
- fameio/source/results/data_transformer.py +6 -22
- fameio/source/results/input_dao.py +163 -0
- fameio/source/results/reader.py +25 -14
- fameio/source/results/yaml_writer.py +28 -0
- fameio/source/scenario/agent.py +56 -39
- fameio/source/scenario/attribute.py +9 -12
- fameio/source/scenario/contract.py +55 -40
- fameio/source/scenario/exception.py +11 -9
- fameio/source/scenario/generalproperties.py +11 -17
- fameio/source/scenario/scenario.py +19 -14
- fameio/source/schema/agenttype.py +75 -27
- fameio/source/schema/attribute.py +8 -7
- fameio/source/schema/java_packages.py +69 -0
- fameio/source/schema/schema.py +44 -15
- fameio/source/series.py +148 -25
- fameio/source/time.py +8 -8
- fameio/source/tools.py +13 -2
- fameio/source/validator.py +138 -58
- fameio/source/writer.py +120 -113
- fameio-2.1.0.dist-info/LICENSES/Apache-2.0.txt +178 -0
- fameio-2.1.0.dist-info/LICENSES/CC-BY-4.0.txt +395 -0
- fameio-2.1.0.dist-info/LICENSES/CC0-1.0.txt +121 -0
- {fameio-1.8.2.dist-info → fameio-2.1.0.dist-info}/METADATA +706 -660
- fameio-2.1.0.dist-info/RECORD +53 -0
- {fameio-1.8.2.dist-info → fameio-2.1.0.dist-info}/WHEEL +1 -2
- fameio-2.1.0.dist-info/entry_points.txt +4 -0
- fameio/source/cli.py +0 -253
- fameio-1.8.2.dist-info/RECORD +0 -40
- fameio-1.8.2.dist-info/entry_points.txt +0 -3
- fameio-1.8.2.dist-info/top_level.txt +0 -1
- {fameio-1.8.2.dist-info → fameio-2.1.0.dist-info}/LICENSE.txt +0 -0
|
@@ -1,660 +1,706 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: fameio
|
|
3
|
-
Version: 1.
|
|
4
|
-
Summary: Python scripts for operation of FAME models
|
|
5
|
-
Home-page: https://gitlab.com/fame-framework/
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
[](https://badge.fury.io/py/fameio)
|
|
34
|
+
[](https://doi.org/10.21105/joss.04958)
|
|
35
|
+
[](https://doi.org/10.5281/zenodo.4314337)
|
|
36
|
+
[](https://badge.fury.io/py/fameio)
|
|
37
|
+
[](https://gitlab.com/fame-framework/fame-io/commits/main)
|
|
38
|
+
[](https://gitlab.com/fame-framework/fame-io/-/commits/main)
|
|
39
|
+
[](https://github.com/psf/black)
|
|
40
|
+
[](https://api.reuse.software/info/gitlab.com/fame-framework/fame-io)
|
|
41
|
+
[](https://common-changelog.org)
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
# FAME-Io
|
|
47
|
+
Python scripts for FAME models, generation of protobuf input files and conversion of protobuf output files.
|
|
48
|
+
Please visit the [FAME-Wiki](https://gitlab.com/fame-framework/wiki/-/wikis/home) to get an explanation of FAME and its components.
|
|
49
|
+
|
|
50
|
+
# Installation
|
|
51
|
+
We recommend installing `fameio` using PyPI:
|
|
52
|
+
|
|
53
|
+
pip install fameio
|
|
54
|
+
|
|
55
|
+
You may also use `pipx`. For detailed information please refer to the official `pipx` [documentation](https://github.com/pypa/pipx).
|
|
56
|
+
|
|
57
|
+
pipx install fameio
|
|
58
|
+
|
|
59
|
+
`fameio` is currently developed and tested for Python 3.8 or higher.
|
|
60
|
+
See the `pyproject.toml` for a complete listing of dependencies.
|
|
61
|
+
|
|
62
|
+
# Usage
|
|
63
|
+
FAME-Io currently offers two main scripts `makeFameRunConfig` and `convertFameResults`.
|
|
64
|
+
Both are automatically installed with the package.
|
|
65
|
+
The first one creates a protobuf file for FAME applications using YAML definition files and CSV files.
|
|
66
|
+
The latter one reads output files from FAME applications in protobuf format and converts them to CSV files.
|
|
67
|
+
|
|
68
|
+
You may use the [example data](https://gitlab.com/dlr-ve/esy/amiris/examples) provided for the [AMIRIS](https://gitlab.com/dlr-ve/esy/amiris/amiris) model which can be used to simulate electricity markets in [Germany](https://gitlab.com/dlr-ve/esy/amiris/examples/-/tree/main/Germany2019), [Austria](https://gitlab.com/dlr-ve/esy/amiris/examples/-/tree/main/Austria2019), and a simple [proof-of-concept model](https://gitlab.com/dlr-ve/esy/amiris/examples/-/tree/main/Simple).
|
|
69
|
+
|
|
70
|
+
## Make a FAME run configuration
|
|
71
|
+
Digests configuration files in YAML format, combines them with CSV data files and creates a single input file for FAME applications in protobuf format.
|
|
72
|
+
Call structure:
|
|
73
|
+
|
|
74
|
+
makeFameRunConfig -f <path/to/scenario.yaml>
|
|
75
|
+
|
|
76
|
+
You may also specify any of the following arguments:
|
|
77
|
+
|
|
78
|
+
| Command | Action |
|
|
79
|
+
|----------------------|-----------------------------------------------------------------------------------------------------------------|
|
|
80
|
+
| `-l` or `--log` | Sets the logging level. Default is `info`. Options are `debug`, `info`, `warning`, `warn`, `error`, `critical`. |
|
|
81
|
+
| `-lf` or `--logfile` | Sets the logging file. Default is `None`. If `None` is provided, all logs get only printed to the console. |
|
|
82
|
+
| `-o` or `--output` | Sets the path of the compiled protobuf output file. Default is `config.pb`. |
|
|
83
|
+
|
|
84
|
+
This could look as follows:
|
|
85
|
+
|
|
86
|
+
makeFameRunConfig -f <path/to/scenario.yaml> -l debug -lf <path/to/scenario.log> -o <path/to/config.pb>
|
|
87
|
+
|
|
88
|
+
You may also call the configuration builder from any Python script with
|
|
89
|
+
|
|
90
|
+
```python
|
|
91
|
+
from fameio.scripts.make_config import Options, run as make_config
|
|
92
|
+
|
|
93
|
+
make_config({Options.FILE: "path/to/scenario.yaml", })
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Similar to the console call you may also specify custom run config arguments and add it in a dictionary to the function call.
|
|
97
|
+
|
|
98
|
+
```python
|
|
99
|
+
from fameio.scripts.make_config import Options, run as make_config
|
|
100
|
+
|
|
101
|
+
run_config = {Options.FILE: "path/to/scenario.yaml",
|
|
102
|
+
Options.LOG_LEVEL: "info",
|
|
103
|
+
Options.OUTPUT: "output.pb",
|
|
104
|
+
Options.LOG_FILE: "scenario.log",
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
make_config(run_config)
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
You can also use the associated argument parser, to extract the run_config dynamically from a string:
|
|
111
|
+
|
|
112
|
+
```python
|
|
113
|
+
from fameio.scripts.make_config import Options, run as make_config
|
|
114
|
+
from fameio.source.cli.make_config import handle_args
|
|
115
|
+
|
|
116
|
+
my_defaults = {Options.FILE: "path/to/scenario.yaml",
|
|
117
|
+
Options.LOG_LEVEL: "info",
|
|
118
|
+
Options.OUTPUT: "output.pb",
|
|
119
|
+
Options.LOG_FILE: "scenario.log",
|
|
120
|
+
}
|
|
121
|
+
my_arg_string = ['-f', 'my/other/scenario.yaml', '-l', 'error']
|
|
122
|
+
|
|
123
|
+
run_config = handle_args(my_arg_string, my_defaults)
|
|
124
|
+
make_config(run_config)
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
### Scenario YAML
|
|
128
|
+
The "scenario.yaml" file contains all configuration options for a FAME-based simulation.
|
|
129
|
+
It consists of the sections `Schema`, `GeneralProperties`, `Agents` and `Contracts`, all of them described below.
|
|
130
|
+
|
|
131
|
+
#### Schema
|
|
132
|
+
The Schema describes a model's components such as its types of agents, their inputs, what data they exchange, etc.
|
|
133
|
+
It is also used to validate the model inputs provided in the `scenario.yaml`.
|
|
134
|
+
Since the Schema is valid until the model itself is changed, it is recommended to defined it in a separate file and include the file here.
|
|
135
|
+
|
|
136
|
+
Currently, the schema specifies:
|
|
137
|
+
* which type of Agents can be created
|
|
138
|
+
* what type of input attributes an Agent uses
|
|
139
|
+
* what type of Products an Agent can send in Contracts, and
|
|
140
|
+
* the names of the Java packages for the classes corresponding to Agents, DataItems and Portables.
|
|
141
|
+
|
|
142
|
+
The Schema consists of the sections `JavaPackages` and `AgentTypes`.
|
|
143
|
+
|
|
144
|
+
##### JavaPackages
|
|
145
|
+
This section defines the name of the Java packages in which the model code is located.
|
|
146
|
+
A similar data set was formerly specified in the `fameSetup.yaml`, but is now specified in the schema.
|
|
147
|
+
Each of the three sections `Agents`, `DataItems`, and `Portables` contain a list of fully qualified java package names of your model's classes.
|
|
148
|
+
Package names can occur in multiple lists and may overlap.
|
|
149
|
+
It is not necessary (but possible) to specify the nearest enclosing package for each Agent, DataItem or Portable.
|
|
150
|
+
Specifying any super-package will also work.
|
|
151
|
+
Also, package names occur on multiple lists for Agent, DataItem or Portable.
|
|
152
|
+
|
|
153
|
+
For example, for a project with all its
|
|
154
|
+
* Agent-derived java classes located in packages below the package named "agents",
|
|
155
|
+
* DataItem implementation classes in a subpackage named "msg",
|
|
156
|
+
* Portable implementation classes in a subpackages named "portableItems" and "otherPortables",
|
|
157
|
+
|
|
158
|
+
the corresponding section in the schema would look like this:
|
|
159
|
+
|
|
160
|
+
```yaml
|
|
161
|
+
JavaPackages:
|
|
162
|
+
Agents:
|
|
163
|
+
- "agents"
|
|
164
|
+
DataItems:
|
|
165
|
+
- "msg"
|
|
166
|
+
Portables:
|
|
167
|
+
- "portableItems"
|
|
168
|
+
- "otherPortables"
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
##### AgentTypes
|
|
172
|
+
Here, each type of agent that can be created in your FAME-based application is listed, its attributes and its available Products for Contracts.
|
|
173
|
+
The structure of this section
|
|
174
|
+
|
|
175
|
+
```yaml
|
|
176
|
+
AgentTypes:
|
|
177
|
+
MyAgentType:
|
|
178
|
+
Attributes:
|
|
179
|
+
MyAttribute:
|
|
180
|
+
...
|
|
181
|
+
MyOtherAttribute:
|
|
182
|
+
...
|
|
183
|
+
Products: [ 'Product1', 'Product2', 'Product3' ]
|
|
184
|
+
MyOtherAgentWithoutProductsOrAttributes:
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
* `MyAgentType` Java's simple class name of the Agent type
|
|
188
|
+
* `Attributes` indicates that beginning of the attribute definition section for this Agent type
|
|
189
|
+
* `MyAttribute` Name of an attribute as specified in the corresponding Java source code of this Agent type (annotated with "@Input")
|
|
190
|
+
* `MyOtherAttribute` Name of another attribute derived from Java source code
|
|
191
|
+
* `Products` list of Products that this Agent can send in Contracts; derived from Java source code of this Agent type (annotated with "@Product")
|
|
192
|
+
* `MyOtherAgentWithoutProductsOrAttributes` an Agent type that requires neither Attributes nor Products
|
|
193
|
+
|
|
194
|
+
Both Attributes and Products are optional - there could be useful Agents that require neither of them.
|
|
195
|
+
In the above example attribute definition was not shown (indicated by `...`).
|
|
196
|
+
The next example provides details on how to define an attribute:
|
|
197
|
+
|
|
198
|
+
```yaml
|
|
199
|
+
MySimpleAttribute:
|
|
200
|
+
AttributeType: enum
|
|
201
|
+
Mandatory: true
|
|
202
|
+
List: false
|
|
203
|
+
Values: [ 'AllowedValue1', 'AllowedValue2' ]
|
|
204
|
+
Default: 'AllowedValue1'
|
|
205
|
+
Help: 'My help text'
|
|
206
|
+
|
|
207
|
+
MyComplexAttribute:
|
|
208
|
+
AttributeType: block
|
|
209
|
+
NestedAttributes:
|
|
210
|
+
InnerAttributeA:
|
|
211
|
+
AttributeType: integer
|
|
212
|
+
InnerAttributeB:
|
|
213
|
+
AttributeType: double
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
* `MySimpleAttribute`, `MyDoubleList`, `MyComplexAttribute` Names of the attributes as specified in the Java enum annotated with "@Input"
|
|
217
|
+
* `AttributeType` (required) data type of the attribute; see options in table below
|
|
218
|
+
* `Mandatory` (optional - true by default) if true: the attribute is required for this agent and validation will fail if the attribute is missing in the scenario **and** no default is provided
|
|
219
|
+
* `List` (optional - false by default)
|
|
220
|
+
* `AttributeType: time_series` cannot be true
|
|
221
|
+
* `AttributeType: block`
|
|
222
|
+
* if true: any nested element in the scenario must be part of a list element and thus can appear multiple times
|
|
223
|
+
* if false: any nested element in the scenario can only appear once
|
|
224
|
+
* any other AttributeType: the attribute is interpreted as list, i.e. multiple values can be assigned to this attribute in the scenario
|
|
225
|
+
* `NestedAttributes` (required only if `AttributeType: block`, otherwise disallowed) starts an inner Attribute definition block - defined Attributes are sub-elements of `MyComplexAttribute`
|
|
226
|
+
* `Values` (optional - None by default): if present defines a list of allowed values for this attribute
|
|
227
|
+
* `Default` (optional - None by default): if present defines a default value to be used in case the scenario does not specify it
|
|
228
|
+
* `Help` (optional - None by default): if present defines a help text to you attribute
|
|
229
|
+
|
|
230
|
+
| AttributeType | value |
|
|
231
|
+
|---------------|-------------------------------------------------------------------------------------------------------------------------|
|
|
232
|
+
| `integer` | a 32-bit integer value |
|
|
233
|
+
| `double` | a 64-bit floating-point value (integers also allowed) |
|
|
234
|
+
| `long` | a 64-bit integer value |
|
|
235
|
+
| `time_stamp` | either a FAME time stamp string or 64-bit integer value |
|
|
236
|
+
| `string` | any string |
|
|
237
|
+
| `enum` | any string, however, usually tied to a set of allowed `Values` |
|
|
238
|
+
| `time_series` | either a path to a .csv-file or a single 64-bit floating-point value; does not support `List: true` |
|
|
239
|
+
| `block` | this attribute has no value of its own but hosts a group of nested Attributes; implies `NestedAttributes` to be defined |
|
|
240
|
+
|
|
241
|
+
#### GeneralProperties
|
|
242
|
+
Specifies FAME-specific properties of the simulation. Structure:
|
|
243
|
+
|
|
244
|
+
```yaml
|
|
245
|
+
GeneralProperties:
|
|
246
|
+
RunId: 1
|
|
247
|
+
Simulation:
|
|
248
|
+
StartTime: 2011-12-31_23:58:00
|
|
249
|
+
StopTime: 2012-12-30_23:58:00
|
|
250
|
+
RandomSeed: 1
|
|
251
|
+
Output:
|
|
252
|
+
Interval: 100
|
|
253
|
+
Process: 0
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
Parameters:
|
|
257
|
+
* `RunId` an ID that can be given to the simulation; use at your discretion
|
|
258
|
+
* `StartTime` time stamp in the format YYYY-MM-DD_hh:mm:ss; first moment of the simulation.
|
|
259
|
+
* `StopTime` time stamp in the format YYYY-MM-DD_hh:mm:ss; last moment of the simulation - i.e. simulation terminates
|
|
260
|
+
after passing that time stamp
|
|
261
|
+
* `RandomSeed` seed to initialise random number generation; each value leads to a unique series of random numbers.
|
|
262
|
+
* `Interval` number of simulation ticks in between write-to-disk events; may be used for performance optimisations;
|
|
263
|
+
* `Process` id of process that performs write-to-disk operations; leave at 0 to be compatible with single-processes;
|
|
264
|
+
|
|
265
|
+
#### Agents
|
|
266
|
+
Specifies all Agents to be created in the simulation in a list. Each Agent has its own entry.
|
|
267
|
+
Structure:
|
|
268
|
+
|
|
269
|
+
```yaml
|
|
270
|
+
Agents:
|
|
271
|
+
- Type: MyAgentWithInputs
|
|
272
|
+
Id: 1
|
|
273
|
+
Attributes:
|
|
274
|
+
MyEnum: SAME_SHARES
|
|
275
|
+
MyInteger: 2
|
|
276
|
+
MyDouble: 4.2
|
|
277
|
+
MyTimeSeries: "./path/to/time_series.csv"
|
|
278
|
+
|
|
279
|
+
- Type: MyAgentWithoutInputs
|
|
280
|
+
Id: 2
|
|
281
|
+
```
|
|
282
|
+
|
|
283
|
+
Agent Parameters:
|
|
284
|
+
* `Type` Mandatory; Java's simple class name of the agent to be created
|
|
285
|
+
* `Id` Mandatory; simulation-unique id of this agent; if two agents have the same ID, the configuration process will
|
|
286
|
+
stop.
|
|
287
|
+
* `Attributes` Optional; if the agent has any attributes, specify them here in the format "AttributeName: value"; please
|
|
288
|
+
see attribute table above
|
|
289
|
+
|
|
290
|
+
The specified `Attributes` for each agent must match the specified `Attributes` options in the linked Schema (see above).
|
|
291
|
+
For better structure and readability of the `scenario.yaml`, `Attributes` may also be specified in a nested way as demonstrated below.
|
|
292
|
+
|
|
293
|
+
```yaml
|
|
294
|
+
Agents:
|
|
295
|
+
- Type: MyAgentWithInputs
|
|
296
|
+
Id: 1
|
|
297
|
+
Attributes:
|
|
298
|
+
Parent:
|
|
299
|
+
MyEnum: SAME_SHARES
|
|
300
|
+
MyInteger: 2
|
|
301
|
+
Parent2:
|
|
302
|
+
MyDouble: 4.2
|
|
303
|
+
Child:
|
|
304
|
+
MyTimeSeries: "./path/to/time_series.csv"
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
In case Attributes are defined with `List: true` option, lists are assigned to an Attribute or Group:
|
|
308
|
+
|
|
309
|
+
```yaml
|
|
310
|
+
Attributes:
|
|
311
|
+
MyDoubleList: [ 5.2, 4.5, 7, 9.9 ]
|
|
312
|
+
MyListGroup:
|
|
313
|
+
- IntValueA: 5
|
|
314
|
+
IntValueB: 42
|
|
315
|
+
- IntValueA: 7
|
|
316
|
+
IntValueB: 100
|
|
317
|
+
```
|
|
318
|
+
|
|
319
|
+
Here, `MyDoubleList` and `MyListGroup` need to specify `List: true` in the corresponding Schema.
|
|
320
|
+
The shorter `[]`-notation was used to assign a list of floating-point values to `MyDoubleList`.
|
|
321
|
+
Nested items `IntValueA` and `IntValueB` of `MyListGroup` are assigned within a list, allowing the specification of these nested items several times.
|
|
322
|
+
|
|
323
|
+
#### Contracts
|
|
324
|
+
Specifies all Contracts, i.e. repetitive bilateral transactions in between agents.
|
|
325
|
+
Contracts are given as a list.
|
|
326
|
+
We recommend moving Contracts to separate files and to use the `!include` command to integrate them in the scenario.
|
|
327
|
+
|
|
328
|
+
```yaml
|
|
329
|
+
Contracts:
|
|
330
|
+
- SenderId: 1
|
|
331
|
+
ReceiverId: 2
|
|
332
|
+
ProductName: ProductOfAgent_1
|
|
333
|
+
FirstDeliveryTime: -25
|
|
334
|
+
DeliveryIntervalInSteps: 3600
|
|
335
|
+
|
|
336
|
+
- SenderId: 2
|
|
337
|
+
ReceiverId: 1
|
|
338
|
+
ProductName: ProductOfAgent_2
|
|
339
|
+
FirstDeliveryTime: -22
|
|
340
|
+
DeliveryIntervalInSteps: 3600
|
|
341
|
+
Attributes:
|
|
342
|
+
ProductAppendix: value
|
|
343
|
+
TimeOffset: 42
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
Contract Parameters:
|
|
347
|
+
* `SenderId` unique ID of agent sending the product
|
|
348
|
+
* `ReceiverId` unique ID of agent receiving the product
|
|
349
|
+
* `ProductName` name of the product to be sent
|
|
350
|
+
* `FirstDeliveryTime` first time of delivery in the format "seconds after the January 1st 2000, 00:00:00"
|
|
351
|
+
* `DeliveryIntervalInSteps` delay time in between deliveries in seconds
|
|
352
|
+
* `Attributes` can be set to include additional information as `int`, `float`, `enum` or `dict` data types
|
|
353
|
+
|
|
354
|
+
##### Definition of Multiple Similar Contracts
|
|
355
|
+
Often, scenarios contain multiple agents of similar type that also have similar chains of contracts.
|
|
356
|
+
Therefore, FAME-Io supports a compact definition of multiple similar contracts.
|
|
357
|
+
`SenderId` and `ReceiverId` can both be lists and support One-to-N, N-to-One and N-to-N relations like in the following example:
|
|
358
|
+
|
|
359
|
+
```yaml
|
|
360
|
+
Contracts:
|
|
361
|
+
# effectively 3 similar contracts (0 -> 11), (0 -> 12), (0 -> 13)
|
|
362
|
+
# with otherwise identical ProductName, FirstDeliveryTime & DeliveryIntervalInSteps
|
|
363
|
+
- SenderId: 0
|
|
364
|
+
ReceiverId: [ 11, 12, 13 ]
|
|
365
|
+
ProductName: MyOtherProduct
|
|
366
|
+
FirstDeliveryTime: 100
|
|
367
|
+
DeliveryIntervalInSteps: 3600
|
|
368
|
+
|
|
369
|
+
# effectively 3 similar contracts (1 -> 10), (2 -> 10), (3 -> 10)
|
|
370
|
+
# with otherwise identical ProductName, FirstDeliveryTime & DeliveryIntervalInSteps
|
|
371
|
+
- SenderId: [ 1, 2, 3 ]
|
|
372
|
+
ReceiverId: 10
|
|
373
|
+
ProductName: MyProduct
|
|
374
|
+
FirstDeliveryTime: 100
|
|
375
|
+
DeliveryIntervalInSteps: 3600
|
|
376
|
+
|
|
377
|
+
# effectively 3 similar contracts (1 -> 11), (2 -> 12), (3 -> 13)
|
|
378
|
+
# with otherwise identical ProductName, FirstDeliveryTime & DeliveryIntervalInSteps
|
|
379
|
+
- SenderId: [ 1, 2, 3 ]
|
|
380
|
+
ReceiverId: [ 11, 12, 13 ]
|
|
381
|
+
ProductName: MyThirdProduct
|
|
382
|
+
FirstDeliveryTime: 100
|
|
383
|
+
DeliveryIntervalInSteps: 3600
|
|
384
|
+
```
|
|
385
|
+
|
|
386
|
+
Combined with YAML anchors complex contract chains can be easily reduced to a minimum of required configuration.
|
|
387
|
+
The following example is equivalent to the previous one and allows a quick extension of contracts to a new couple of agents e.g. (4;14):
|
|
388
|
+
|
|
389
|
+
```yaml
|
|
390
|
+
Groups:
|
|
391
|
+
- &agentList1: [ 1,2,3 ]
|
|
392
|
+
- &agentList2: [ 11,12,13 ]
|
|
393
|
+
|
|
394
|
+
Contracts:
|
|
395
|
+
- SenderId: 0
|
|
396
|
+
ReceiverId: *agentList2
|
|
397
|
+
ProductName: MyOtherProduct
|
|
398
|
+
FirstDeliveryTime: 100
|
|
399
|
+
DeliveryIntervalInSteps: 3600
|
|
400
|
+
|
|
401
|
+
- SenderId: *agentList1
|
|
402
|
+
ReceiverId: 10
|
|
403
|
+
ProductName: MyProduct
|
|
404
|
+
FirstDeliveryTime: 100
|
|
405
|
+
DeliveryIntervalInSteps: 3600
|
|
406
|
+
|
|
407
|
+
- SenderId: *agentList1
|
|
408
|
+
ReceiverId: *agentList2
|
|
409
|
+
ProductName: MyThirdProduct
|
|
410
|
+
FirstDeliveryTime: 100
|
|
411
|
+
DeliveryIntervalInSteps: 3600
|
|
412
|
+
```
|
|
413
|
+
|
|
414
|
+
### CSV files
|
|
415
|
+
TIME_SERIES inputs are not directly fed into the Scenario YAML file.
|
|
416
|
+
Instead, TIME_SERIES reference a CSV file that can be stored some place else.
|
|
417
|
+
These CSV files follow a specific structure:
|
|
418
|
+
* They must contain exactly two columns.
|
|
419
|
+
* The first column must be a time stamp in form `YYYY-MM-DD_hh:mm:ss`
|
|
420
|
+
* The second column must be a numerical value (either integer or floating-point)
|
|
421
|
+
* The separator of the two columns is a semicolon
|
|
422
|
+
* The data must **not** have headers, except for comments marked with `#`
|
|
423
|
+
|
|
424
|
+
You may add comments using `#`.
|
|
425
|
+
Exemplary content of a valid CSV file:
|
|
426
|
+
|
|
427
|
+
# If you want an optional header, you must use a comment
|
|
428
|
+
2012-01-01_00:00:00;400
|
|
429
|
+
2013-01-01_00:00:00;720.5
|
|
430
|
+
2014-01-01_00:00:00;650
|
|
431
|
+
2015-01-01_00:00:00;99.27772
|
|
432
|
+
2016-01-01_00:00:00;42 # optional comment on this particular data point
|
|
433
|
+
2017-01-01_00:00:00;0.1
|
|
434
|
+
|
|
435
|
+
Please refer also to the detailed article about `TimeStamps` in the [FAME-Wiki](https://gitlab.com/fame-framework/wiki/-/wikis/TimeStamp).
|
|
436
|
+
|
|
437
|
+
### Split and join multiple YAML files
|
|
438
|
+
The user may include other YAML files into a YAML file to divide the content across files as convenient.
|
|
439
|
+
We explicitly recommend using this feature for the `Schema` and `Contracts` sections.
|
|
440
|
+
Otherwise, the scenario.yaml may become crowded.
|
|
441
|
+
|
|
442
|
+
#### Command: !Include
|
|
443
|
+
To hint YAML to load the content of another file use `!include "path/relative/to/including/yaml/file.yml"`.
|
|
444
|
+
You can concatenate !include commands and can use !include in the included file as well.
|
|
445
|
+
The path to the included file is always relative to the file using the !include command.
|
|
446
|
+
So with the following file structure
|
|
447
|
+
|
|
448
|
+
###### file-structure
|
|
449
|
+
```
|
|
450
|
+
a.yaml
|
|
451
|
+
folder/b.yaml
|
|
452
|
+
folder/c.yaml
|
|
453
|
+
folder/deeper_folder/d.yaml
|
|
454
|
+
```
|
|
455
|
+
|
|
456
|
+
the following !include commands work
|
|
457
|
+
|
|
458
|
+
###### in a.yaml
|
|
459
|
+
```
|
|
460
|
+
ToBe: !include "folder/b.yaml"
|
|
461
|
+
OrNot: !include "folder/deeper_folder/d.yaml"
|
|
462
|
+
```
|
|
463
|
+
|
|
464
|
+
###### in b.yaml
|
|
465
|
+
```
|
|
466
|
+
ThatIs: !include "c.yaml"
|
|
467
|
+
TheQuestion: !include "deeper_folder/d.yaml"
|
|
468
|
+
```
|
|
469
|
+
|
|
470
|
+
Provided that
|
|
471
|
+
###### in c.yaml
|
|
472
|
+
```
|
|
473
|
+
Or: maybe
|
|
474
|
+
```
|
|
475
|
+
|
|
476
|
+
###### d.yaml
|
|
477
|
+
```
|
|
478
|
+
not: "?"
|
|
479
|
+
```
|
|
480
|
+
|
|
481
|
+
the resulting file would look like this:
|
|
482
|
+
|
|
483
|
+
###### THe Joined file a.yaml
|
|
484
|
+
```
|
|
485
|
+
ToBe:
|
|
486
|
+
ThatIs:
|
|
487
|
+
Or: maybe
|
|
488
|
+
TheQuestion:
|
|
489
|
+
not: "?"
|
|
490
|
+
OrNot:
|
|
491
|
+
not: "?"
|
|
492
|
+
```
|
|
493
|
+
|
|
494
|
+
You may also specify absolute file paths if preferred by starting with a "/".
|
|
495
|
+
|
|
496
|
+
When specifying only a file path, the complete content of the file is assigned to the given key.
|
|
497
|
+
You always need a key to assign the !include command to.
|
|
498
|
+
However, you cannot combine the value returned from !include with other values in the same key.
|
|
499
|
+
Thus, the following combinations do not work:
|
|
500
|
+
|
|
501
|
+
###### caveats.yml
|
|
502
|
+
```
|
|
503
|
+
!include "file.yaml" # no key assigned
|
|
504
|
+
|
|
505
|
+
Key:
|
|
506
|
+
Some: OtherItem
|
|
507
|
+
!include "file.yaml" # cannot join with other named items
|
|
508
|
+
|
|
509
|
+
List:
|
|
510
|
+
- an: entry
|
|
511
|
+
!include "file.yaml" # cannot directly join with list items, even if !include returns a list
|
|
512
|
+
```
|
|
513
|
+
|
|
514
|
+
#### Integrate specific nodes of YAML files
|
|
515
|
+
Instead of including *all* content in the included file, you may also pick a specific node within that file.
|
|
516
|
+
For this use `!include [<relative/path/to/file.yaml>, Path:To:Field:In:Yaml]`.
|
|
517
|
+
Here, `:` is used in the node-specifying string to select a sequence of nodes to follow - with custom depth.
|
|
518
|
+
Consider the following two files:
|
|
519
|
+
|
|
520
|
+
###### file_to_be_included.yaml
|
|
521
|
+
```yaml
|
|
522
|
+
Set1:
|
|
523
|
+
Subset1:
|
|
524
|
+
Key: Value
|
|
525
|
+
Set2:
|
|
526
|
+
OtherKey: OtherValue
|
|
527
|
+
```
|
|
528
|
+
|
|
529
|
+
###### including_file.yaml
|
|
530
|
+
```yaml
|
|
531
|
+
- Type: MyAgentWithInputs
|
|
532
|
+
Id: 1
|
|
533
|
+
Attributes: !include_node [ file_to_be_included.yaml, Set1:Subset1 ]
|
|
534
|
+
```
|
|
535
|
+
|
|
536
|
+
Compiling "including_file.yaml" results in
|
|
537
|
+
|
|
538
|
+
###### resulting_file.yaml
|
|
539
|
+
```yaml
|
|
540
|
+
- Type: MyAgentWithInputs
|
|
541
|
+
Id: 1
|
|
542
|
+
Attributes:
|
|
543
|
+
Key: Value
|
|
544
|
+
```
|
|
545
|
+
|
|
546
|
+
#### Load multiple files
|
|
547
|
+
Using wildcards in the given path (e.g. "path/to/many/*.yaml") will lead to loading multiple files and assigning their content to the same key.
|
|
548
|
+
You can make use of this feature with or without specifying a node selector.
|
|
549
|
+
However, the elements to be joined across multiple files must be lists.
|
|
550
|
+
These lists are then concatenated into a single list and then assigned to the key in the file calling !include.
|
|
551
|
+
This feature is especially useful for Contracts: You can split the Contracts list into several files and place them in a separate folder.
|
|
552
|
+
Then use !include to re-integrate them into your configuration. An example:
|
|
553
|
+
|
|
554
|
+
###### my_contract1.yaml
|
|
555
|
+
```
|
|
556
|
+
Contracts:
|
|
557
|
+
- ContractA
|
|
558
|
+
- ContractB
|
|
559
|
+
```
|
|
560
|
+
|
|
561
|
+
###### my_contract2.yaml
|
|
562
|
+
```
|
|
563
|
+
Contracts:
|
|
564
|
+
- ContractC
|
|
565
|
+
- ContractD
|
|
566
|
+
- ContractE
|
|
567
|
+
```
|
|
568
|
+
|
|
569
|
+
###### including_file.yaml
|
|
570
|
+
```
|
|
571
|
+
Contracts: [!include "my_contract*.yaml", "Contracts"]
|
|
572
|
+
```
|
|
573
|
+
|
|
574
|
+
results in
|
|
575
|
+
|
|
576
|
+
###### result.yaml
|
|
577
|
+
```
|
|
578
|
+
Contracts:
|
|
579
|
+
- ContractA
|
|
580
|
+
- ContractB
|
|
581
|
+
- ContractC
|
|
582
|
+
- ContractD
|
|
583
|
+
- ContractE
|
|
584
|
+
```
|
|
585
|
+
|
|
586
|
+
#### Ignoring files
|
|
587
|
+
Files that have their name start with "IGNORE_" are not included with the !include command.
|
|
588
|
+
You will see a debug output to notify you that the file was ignored.
|
|
589
|
+
Use this to temporarily take files out ouf your configuration without deleting or moving them.
|
|
590
|
+
|
|
591
|
+
## Read FAME results
|
|
592
|
+
Takes an output file in protobuf format of FAME-based applications and converts it into files in CSV format.
|
|
593
|
+
An individual file for each type of Agent is created in a folder named after the protobuf input file.
|
|
594
|
+
Call structure:
|
|
595
|
+
|
|
596
|
+
convertFameResults -f <./path/to/protobuf_file.pb>
|
|
597
|
+
|
|
598
|
+
You may also specify any of the following arguments:
|
|
599
|
+
|
|
600
|
+
| Command | Action |
|
|
601
|
+
|---------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
602
|
+
| `-l` or `--log` <option> | Sets the logging level. Default is `WARNING`. Options are `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`. |
|
|
603
|
+
| `-lf` or `--logfile` <file> | Sets the logging file. Default is `None`. If `None` is provided, all logs get only printed to the console. |
|
|
604
|
+
| `-a` or `--agents` <list-of-agents> | If specified, only a subset of agents is extracted from the protobuf file. Default is to extract all agents. |
|
|
605
|
+
| `-o` or `--output` | Sets the path to where the generated output files are written to. If not specified, the folder's name is derived from the input file's name. Folder will be created if it does not exist. |
|
|
606
|
+
| `-se` or `--single-export` | Enables export of individual agents to individual files, when present. If not present (the default) one file per `AgentType` is created. |
|
|
607
|
+
| `-m` or `--memory-saving` | When specified, reduces memory usage profile at the cost of runtime. Use only when necessary. |
|
|
608
|
+
| `-cc` or `--complex-column` <option> | Defines how to deal with complex indexed output columns (if any). `IGNORE` ignores complex columns. `SPLIT` creates a separate file for each complex indexed output column. |
|
|
609
|
+
| `-t` or `--time` <option> | Option to define conversion of time steps to given format (default=`UTC`) by `-t/--time {UTC, INT, FAME}` |
|
|
610
|
+
| `--input-recovery` or `--no-input-recovery` | If True, all input data are recovered as well as the outputs (default=False). |
|
|
611
|
+
|
|
612
|
+
Additionally, you may merge TimeSteps of a certain range of steps in the output files to
|
|
613
|
+
i) associate multiple time steps with a common logical time in your simulation
|
|
614
|
+
ii) reduce number of lines in output files
|
|
615
|
+
|
|
616
|
+
For this, add the option `merge-times` and specify the arguments as follows:
|
|
617
|
+
|
|
618
|
+
| Command | Action |
|
|
619
|
+
|---------------------------|------------------------------------------------------------------------------------------|
|
|
620
|
+
| `-fp` or `--focal-point` | TimeStep on which `steps-before` earlier and `steps-after` later TimeSteps are merged on |
|
|
621
|
+
| `-sb` or `--steps-before` | Range of TimeSteps before the `focal-point` they get merged to |
|
|
622
|
+
| `-sa` or `--steps-after` | Range of TimeSteps after the `focal-point` they get merged to |
|
|
623
|
+
|
|
624
|
+
This could look as follows:
|
|
625
|
+
|
|
626
|
+
convertFameResults -f <./path/to/protobuf_file.pb> -l debug -lf <path/to/output.log> -a AgentType1 AgentType2 -o myCsvFolder -m -cc SPLIT merge-times -fp 0 -sb 1799 -sa 1800
|
|
627
|
+
|
|
628
|
+
Make sure that in the range of time steps you specify for merging there is only one value per column in the merged time range.
|
|
629
|
+
If multiple values per column are merged values will get concatenated and might yield unexpected results.
|
|
630
|
+
|
|
631
|
+
You may also call the conversion script from any Python script with:
|
|
632
|
+
|
|
633
|
+
```python
|
|
634
|
+
from fameio.scripts.convert_results import Options, run as convert_results
|
|
635
|
+
|
|
636
|
+
convert_results({Options.FILE: "./path/to/protobuf_file.pb"})
|
|
637
|
+
```
|
|
638
|
+
|
|
639
|
+
Similar to the console call you may also specify custom run config arguments and add it in a dictionary to the function call.
|
|
640
|
+
|
|
641
|
+
```python
|
|
642
|
+
from fameio.scripts.convert_results import Options, run as convert_results
|
|
643
|
+
|
|
644
|
+
run_config = {Options.FILE: "./path/to/protobuf_file.pb",
|
|
645
|
+
Options.LOG_LEVEL: "info",
|
|
646
|
+
Options.LOG_FILE: "scenario.log",
|
|
647
|
+
Options.OUTPUT: "Output",
|
|
648
|
+
Options.AGENT_LIST: ['AgentType1', 'AgentType2'],
|
|
649
|
+
Options.MEMORY_SAVING: False,
|
|
650
|
+
Options.SINGLE_AGENT_EXPORT: False,
|
|
651
|
+
Options.RESOLVE_COMPLEX_FIELD: "SPLIT",
|
|
652
|
+
Options.TIME: "INT",
|
|
653
|
+
Options.TIME_MERGING: {},
|
|
654
|
+
}
|
|
655
|
+
|
|
656
|
+
convert_results(run_config)
|
|
657
|
+
```
|
|
658
|
+
|
|
659
|
+
You can also use the associated argument parser, to extract the run_config dynamically from a string:
|
|
660
|
+
|
|
661
|
+
```python
|
|
662
|
+
from fameio.scripts.convert_results import Options, run as convert_results
|
|
663
|
+
from fameio.source.cli.convert_results import handle_args
|
|
664
|
+
|
|
665
|
+
my_defaults = {Options.FILE: "./path/to/protobuf_file.pb",
|
|
666
|
+
Options.LOG_LEVEL: "info",
|
|
667
|
+
Options.LOG_FILE: "scenario.log",
|
|
668
|
+
Options.OUTPUT: "Output",
|
|
669
|
+
Options.AGENT_LIST: ['AgentType1', 'AgentType2'],
|
|
670
|
+
Options.MEMORY_SAVING: False,
|
|
671
|
+
Options.SINGLE_AGENT_EXPORT: False,
|
|
672
|
+
Options.RESOLVE_COMPLEX_FIELD: "SPLIT",
|
|
673
|
+
Options.TIME: "INT",
|
|
674
|
+
Options.TIME_MERGING: {},
|
|
675
|
+
}
|
|
676
|
+
my_arg_string = ['-f', 'my/other/scenario.yaml', '-l', 'error']
|
|
677
|
+
|
|
678
|
+
run_config = handle_args(my_arg_string, my_defaults)
|
|
679
|
+
convert_results(run_config)
|
|
680
|
+
```
|
|
681
|
+
|
|
682
|
+
## Cite FAME-Io
|
|
683
|
+
If you use FAME-Io for academic work, please cite as follows.
|
|
684
|
+
|
|
685
|
+
Bibtex entry:
|
|
686
|
+
|
|
687
|
+
```
|
|
688
|
+
@article{fameio2023joss,
|
|
689
|
+
author = {Felix Nitsch and Christoph Schimeczek and Ulrich Frey and Benjamin Fuchs},
|
|
690
|
+
title = {FAME-Io: Configuration tools for complex agent-based simulations},
|
|
691
|
+
journal = {Journal of Open Source Software},
|
|
692
|
+
year = {2023},
|
|
693
|
+
doi = {doi: https://doi.org/10.21105/joss.04958}
|
|
694
|
+
}
|
|
695
|
+
```
|
|
696
|
+
|
|
697
|
+
## Available Support
|
|
698
|
+
This is a purely scientific project by (at the moment) one research group.
|
|
699
|
+
Thus, there is no paid technical support available.
|
|
700
|
+
However, we will give our best to answer your questions and provide support.
|
|
701
|
+
|
|
702
|
+
If you experience any trouble with FAME-Io, you may contact the developers via [fame@dlr.de](mailto:fame@dlr.de).
|
|
703
|
+
Please report bugs and make feature requests by filing issues following the provided templates (see also [Contribute](CONTRIBUTING.md)).
|
|
704
|
+
For substantial enhancements, we recommend that you contact us via [fame@dlr.de](mailto:fame@dlr.de) for working
|
|
705
|
+
together on the code in common projects or towards common publications and thus further develop FAME-Io.
|
|
706
|
+
|