Commit a39ad157 authored by Martin Hellwig's avatar Martin Hellwig
Browse files

Changed the readme-file for the OpenStreetMap-Branch

parent be527e3c
# PeerfactSim.KOM, Simonstrator-Version
# PeerfactSim.KOM, Simonstrator-Version, Open-Street-Map Integration
This is PeerfactSim.KOM in the Simonstrator-enabled version. It contains models for common network and physical layer types as well as movement and placement models. Combined with the analyzing and evaluation toolchain, it supports rapid prototyping and performance evaluations of new services, protocols, and overlays.
This branch of the PeerfactSim-project implements the functionality to load real world maps data out of several resources. All relevant modifications are in the `de.tud.kom.p2psim.impl.topology.movement.modularosm`-package. The `ModularMovementModel`-class is the main-class for this approach. This class loads all other classes as defined in the XML-configurable file in the simRunner-project.
## Installation
For the possible implementations of the AttractionGenerator (generates POIs), the map visualization and the transition strategy we have defined interfaces and implemented at least two implementations for each interface.
One configurable interface we copied from the `de.tud.kom.p2psim.impl.topology.movement.modular`-package. In the `de.tud.kom.p2psim.impl.topology.movement.local`-package are some classes, which calculate the routes of the moving nodes. Here you can use some simple algorithmic approaches or use one out of two possible implementations, which use real world street data to navigate the nodes through the sreets to their destination.
Just clone this repository, it already includes an Eclipse project. The project is built using Maven, so you need to install the M2E-extension in Eclipse when working with PeerfactSim.KOM. Furthermore, the project depends on the Simonstrator-API. Which version of the API to use is defined within the VERSION file contained in the root folder of this project.
## Usage
Usually, you do not need to touch a single line of code within this project. It is provided mostly for debugging purposes. In order to configure and run your simulations, please refer to the simonstrator-simRunner project and its documentation.
## Extending PeerfactSim.KOM
In some cases you might want to implement new movement models, network layer routing protocols, or any other kind of "below transport-layer"-functionality. In oder to do so, please create a new feature branch (name convention: [yourname]/[featurename]) and implement you feature there. Once you are finished, please create a merge request and assign it to one of the project maintainers (usually @br ) to get it approved. A description of the feature in the merge request is required, as well as corresponding simRunner configurations for sample simulation runs.
\ No newline at end of file
The code itself is (hopefully) self-explaining. All possible configurations can be made via the XML-config in the simRunner-project.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment