Commit b9500426 authored by Adam Kučera's avatar Adam Kučera
Browse files

mardown reformatting

parent 0e49805b
......@@ -23,7 +23,7 @@ ResearchGate profile: https://www.researchgate.net/profile/Adam_Kucera/
## Sample Semantic BMS Ontology data
The sample data can be found in the [TestBench/NT-Data/sample.nt](https://gitlab.fi.muni.cz/xkucer16/semanticBMS/raw/master/TestBench/NT-Data/sample.nt) file.
For more information about the data set, see [TestBench readme](https://gitlab.fi.muni.cz/xkucer16/semanticBMS/raw/master/TestBench/README.md).
For more information about the data set, see [TestBench readme](https://gitlab.fi.muni.cz/xkucer16/semanticBMS/tree/master/TestBench/README.md).
## How To Install SemanticBMS
......
......@@ -45,54 +45,77 @@ If you intend to use the provided pre-generated data, proceed directly to step 3
1. [Optional] Run the script .\Generate-CSVs.ps1
The script generates CSV files into the CSV-Data folder.
Optional parameters:
-Sites [Default: 5] - number of sites in the dataset
-Buildings [Default: 5] - number of buildings in each site
-Floors [Default: 3] - number of floors in each building
-Rooms [Default: 10] - number of rooms in each floor
-OutFolder [Default: ".\CSV-Data"] - output folder for the generated CSV
2. [Optional] Run the script .\Generate-Triples.ps1
The script generates an N-Triples file into the NT-Data folder, based on the CSV files located in the .\CSV-Data folder.
Optional parameters:
-InFolder [Default: .\CSV-Data] - location of the source CSV files generated by Generate-CSVs script
-OutFile [Default: .\NT-Data\data.nt] - location of the output NT File
The process of Triples generation is universal and can be performed with existing CSV when using real facility data
instead of a generated mock-up created by Generate-CSVs script.
Pre-generated NT file for the test mock-up with the default size is available in the NT-Data folder as sample.nt.
3. Run the script .\Create-TDB.ps1
The script will create the TDB triplestore using the Apache Jena framework.
Optional parameters:
-TDBPath [Default: \apache-tomcat\webapps\sbms\WEB-INF\tdb] - location of the resulting TDB directory
-NTPath [Default: .\NT-Data\data.nt] - Path to the source NT file
-JenaRoot [Default: \apache-jena-3.2.0] - Path to the directory with the Apache Jena distribution
If you intend to use pre-generated sample dataset, run the command as follows:
```
Create-TDB.ps1 -NTPath .\NT-Data\sample.nt
```
Statistics of the TDB can be found in the <Your tdb location>\stats.opt file.
4. Deploy the Semantic API into the Apache Tomcat (see Readme on the project site)
5. Set up the SemanticAPI to use the created TDB if needed
Update the tdb.path property in the semantics.properties file
6. [Optional] Run the Apache Tomcat
Execute the bin\startup.bat script
This step is recommended if you plan to run several rounds of benchmarks, as the Tomcat container is not started each time
the tests are executed
7. Run the script Performance-Test.ps1
The script will start the performance benchmark and outputs the result to standard output
(Use .\Performance-Test.ps1 | OutFile results.txt to redirect it to a file)
(Use ```.\Performance-Test.ps1 | OutFile results.txt``` to redirect it to a file)
If you did not start the Apache Tomcat in the previous step, use the -ManageTomcat switch. You can also set the path to
the Apache Tomcat installation directory by the -TomcatHome param (Default is C:\apache-tomcat)
8. [Optional] Stop the Apache Tomcat
Execute the bin\shutdown.bat script if you did not use the -ManageTomcat option and started the server manually in the step 6
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