Commit dbdd10ee authored by Michael Osetinski's avatar Michael Osetinski
Browse files

Updated README.md

parent 871e21a6
Pipeline #89579 passed with stage
in 3 minutes and 21 seconds
......@@ -46,7 +46,7 @@ The last command `main.bat` will compile the model and run it in a server contai
__NOTE:__ Autopilot EMAM model works only in _Windows 64 bit_ environment.
To run the RMIModelServer, one has to run the `run.bat` or `run.sh` scripts located in `RMIModelServer/scripts/` directory.
To run the RMIModelServer, one has to run the `run.bat` or `run.sh` scripts located in `RMIModelServer/scripts/` directory. Pay attention to the version of the RMIModelServer. The filename of the form `rmi-model-server-*.jar` (where * stands for some version) in `run.bat` should match the generated jar-file in the `RMIModelServer/target/` directory.
# Installation
......@@ -100,7 +100,7 @@ To install and configure SQLite, follow these steps below:
1. [Download SQLite](https://www.sqlite.org/download.html) from there homepage and install.
2. Create the database
* For Mac/Linux users, use the script _docs/DBScripts/sqlite-create-script.sh_
* For windows users, run the command(this should in _docs/DBScripts_): `sqlite3 world.sql ".read sqlite-world.sql"`
* For windows users, run the command(this should in _docs/DBScripts_): `sqlite3 world.db ".read sqlite-world.sql"`
The generated SQLite database file will be deployed by `scripts/deploy.sh` or `scripts/deploy.bat` automatically after the project is built.
......@@ -147,7 +147,13 @@ Once logged in the administration tool, the following tabs have to be visited an
* Download [postgres JDBC driver](https://jdbc.postgresql.org/) for the OS of the machine, which is to run the _SmartFoxServer_ (we use version _42.1.4_), if you choose to use postgres.
* Download [sqlite JDBC driver](https://bitbucket.org/xerial/sqlite-jdbc/downloads/) if you choose to use sqlite.
* Copy the driver and place it at `<SmartFoxServer directory>/lib`
3. Zone Configurator:
3. Prepare Java FMI library:
* Download [Java FMI library](https://ptolemy.berkeley.edu/java/jfmi/)
* Open your downloaded archive and extract the file `lib/jna.jar` to `<SmartFoxServer directory>/lib`
4. Prepare simulation dependencies:
* Download from the [simulation repository](https://git.rwth-aachen.de/monticore/EmbeddedMontiArc/simulators/simulation/) all 4 fmu-files located in the `lib` directory
* Place the downloaded files at `<SmartFoxServer directory>/lib`
5. Zone Configurator:
* in _Zone Configurator_:
* add new zone
* in _General_ tab set _Zone name_ to `World`
......@@ -231,7 +237,7 @@ To allow verbose loggin, which is important for _SimulationLanguage_ module, one
# Sample OSM maps
To download a map file from OpenStreetMap one can use the [OSM export tool](https://www.openstreetmap.org/export).
To download a map file from OpenStreetMap one can use the [OSM export tool](https://www.openstreetmap.org/export). The example map `Aachen.osm` can be found in the `main/resources` directory.
__NOTE:__ download of very broad world is likely to fail using the GUI (Export button). Instead one can use the external sources listed in the bottom left part of the screen. We use mostly the _Overpass API_.
......@@ -269,7 +275,7 @@ Scenarios together with respective vehicles/tracks are saved to the database and
### Sample scenarios
One can find a [Sample scenario](https://github.com/MontiSim/server/releases/tag/portable) available for download. To upload it correctly, one needs both _Sample.osm_ and _Sample.sim_ files.
One can find a [Sample scenario](https://git.rwth-aachen.de/monticore/EmbeddedMontiArc/simulators/server/tree/master/main/resources) available for download. To upload it correctly, one needs both _Sample.osm_ and _Sample.sim_ files.
## Simulation
......@@ -304,6 +310,7 @@ If an error occur, while the portable simulator is used, make sure the __portabl
## Login button not working
First of all, make sure the AllInOne folder contains some map file.
It might be the case that the first time the visualization application is loaded in a browser, the login button does not work and an error is thrown in the browser console. This is quite likely to be a problem with loading the webapp resources, thus we advice the webapp to be reloaded with __disabled cache__ option.
* in _Chrome_ this is possible by opening _Developer Tools_ going to _Network_ and enabling _disable cache_ checkbox
......
Supports Markdown
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