https://github.com/protojour/mikrokosmos
A (test) data generator and scenario simulation framework
https://github.com/protojour/mikrokosmos
Last synced: 6 months ago
JSON representation
A (test) data generator and scenario simulation framework
- Host: GitHub
- URL: https://github.com/protojour/mikrokosmos
- Owner: protojour
- License: mit
- Created: 2020-02-06T13:18:41.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-06-16T13:42:38.000Z (over 5 years ago)
- Last Synced: 2025-02-12T12:47:23.671Z (8 months ago)
- Language: Python
- Size: 27.3 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Mikrokosmos
===========
**A (test) data generator and scenario simulation framework**
Mikrokosmos allows you to define and run scenarios of simulated events through its command line client, `mikro`. Scenarios are described as YAML files [...]. Simulation data can be output in multiple formats – logs, json data etc.
Mikrokosmos was designed specifically to generate test data, so most of its included functionality is geared towards this. If you have an idea for how its functionality can be extended for other uses, let us know.
Installation
------------
Mikrokosmos requires Python 3.6 or higher, and is tested with PyPy3.
```bash
$ pip install --user mikrokosmos
```
Usage
-----
Generate static data from a scenario:
```bash
$ mikro gen scenario.yml
```
Generate static data with JSON indentation, redirect to file:
```bash
$ mikro gen -n 4 scenario.yml > data.json
```
Planned functionality
---------------------
- [x] Data generation (random etc.)
- [x] Simple JSON output
- [ ] Configurable output (separate JSON files, logs)
- [ ] Environments and populations
- [ ] Environment state, per-object state, resources
- [ ] State machines for processes?
- [ ] Activity and events simulated over time
- [ ] Realtime simulations
License
-------
Mikrokosmos is copyright © 2020 Protojour AS, and is licensed under MIT. See [LICENSE.txt](https://github.com/protojour/mikrokosmos/blob/master/LICENSE.txt) for details.