Internal: Lots of Java stuff

README.markdown

@@ -0,0 +1,53 @@
+# Industrial Benchmark
+
+Requires: Java 8 and Apache Maven 3.x
+
+Documentation: The documentation is available online at: https://arxiv.org/abs/1709.09480
+	Source: D. Hein, S. Depeweg, M. Tokic, S. Udluft, A. Hentschel, T.A. Runkler, and V. Sterzing. 
+	"A Benchmark Environment Motivated by Industrial Control Problems". arXiv preprint arXiv:1709.09480, 2017. 
+
+## Citing Industrial Benchmark
+
+To cite Industrial Benchmark, please reference:
+	D. Hein, S. Depeweg, M. Tokic, S. Udluft, A. Hentschel, T.A. Runkler, and V. Sterzing. "A Benchmark Environment 
+		Motivated by Industrial Control Problems". arXiv preprint arXiv:1709.09480, 2017. 
+
+	D. Hein, S. Udluft, M. Tokic, A. Hentschel, T.A. Runkler, and V. Sterzing. "Batch Reinforcement 
+		Learning on the Industrial Benchmark: First Experiences," in 2017 International Joint Conference on Neural
+		Networks (IJCNN), 2017, pp. 4214–4221.
+
+	S. Depeweg, J. M. Hernández-Lobato, F. Doshi-Velez, and S. Udluft. "Learning and
+		policy search in stochastic dynamical systems with bayesian neural networks." arXiv
+		preprint arXiv:1605.07127, 2016.
+
+## Inclusion as a dependency to your Java/Maven project
+
+	<dependency>
+		<groupId>com.siemens.oss.industrialbenchmark</groupId>
+		<artifactId>industrialbenchmark</artifactId>
+		<version>1.1.1</version>
+	</dependency>
+
+
+## Compilation + Run
+
+NOTE: It is important to run the maven clean phase (`mvn clean`, like below)
+when working with this project for the first time.
+This will install the `RLGlue:JavaRLGlueCodec:1.0` dependency into the local repo.
+Without it, compilation will fail.
+
+	mvn clean package
+	java -jar target/industrialbenchmark-*-jar-with-dependencies.jar
+	# or
+	java -jar target/industrialbenchmark-*-jar-with-dependencies.jar src/main/resources/sim.properties
+
+* => a random trajectory is generated
+* => all observable state variables are written to file dyn-observable.csv.
+* => all markov state variables are written to file dyn-markov.csv
+
+# Sample usage in code
+
+An example usage of the industrial benchmark can be found in the class `com.siemens.industrialbenchmark.ExampleMain`.
+It is intented to be a template for data generation.
+
+

pom.xml

@@ -1,22 +1,32 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
+
 	<groupId>com.siemens.oss.industrialbenchmark</groupId>
 	<artifactId>industrialbenchmark</artifactId>
 	<version>1.1.2-SNAPSHOT</version>
 
 	<properties>
-		<javaSource>1.8</javaSource>
-		<javaTarget>1.8</javaTarget>
-		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+		<project.build.encoding>UTF-8</project.build.encoding>
+		<project.build.sourceEncoding>${project.build.encoding}</project.build.sourceEncoding>
+		<project.build.resourceEncoding>${project.build.encoding}</project.build.resourceEncoding>
+		<java.min.version>8</java.min.version>
+
+		<project.mainPackage>com.siemens.industrialbenchmark</project.mainPackage>
+		<project.mainClass>${project.mainPackage}.TrialGuiMain</project.mainClass>
 	</properties>
 
+	<organization>
+		<name>Siemens</name>
+		<url>http://ct.siemens.com</url>
+	</organization>
 	<name>Industrial Benchmark</name>
 	<url>http://github.com/siemens/industrialbenchmark</url>
 	<description>A novel reinforcement learning benchmark, called Industrial Benchmark, is introduced.
 The Industrial Benchmark aims at being be realistic in the sense, that it includes a variety
 of aspects that we found to be vital in industrial applications. It is not designed to be an
 approximation of any real system, but to pose the same hardness and complexity.
 	</description>
+	<inceptionYear>20??</inceptionYear> <!-- TODO Document this! -->
 
 	<licenses>
 		<license>
@@ -27,6 +37,12 @@ approximation of any real system, but to pose the same hardness and complexity.
 		</license>
 	</licenses>
 
+	<packaging>jar</packaging>
+
+	<prerequisites>
+		<maven>2.2.1</maven>
+	</prerequisites>
+
 	<developers>
 		<developer>
 			<name>Michel Tokic</name>
@@ -67,6 +83,57 @@ approximation of any real system, but to pose the same hardness and complexity.
 		</snapshotRepository>
 	</distributionManagement>
 
+	<reporting>
+		<plugins>
+			<!-- NOTE Use the profile "Extensive-Reports" for an extended list of reports. -->
+
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-checkstyle-plugin</artifactId>
+				<version>2.17</version>
+				<configuration>
+					<sourceEncoding>${project.build.sourceEncoding}</sourceEncoding>
+					<linkXref>true</linkXref>
+					<configLocation>src/main/resources/checkstyle.xml</configLocation>
+					<propertyExpansion>java.header.regex.template.file=${basedir}/src/main/resources/java_header_regex_template.txt</propertyExpansion>
+				</configuration>
+			</plugin>
+
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-pmd-plugin</artifactId>
+				<version>3.7</version>
+				<configuration>
+					<aggregate>true</aggregate>
+					<linkXref>true</linkXref>
+					<sourceEncoding>${project.build.sourceEncoding}</sourceEncoding>
+					<targetJdk>1.${java.min.version}</targetJdk>
+					<rulesets>
+						<ruleset>${basedir}/src/main/resources/pmd.xml</ruleset>
+					</rulesets>
+				</configuration>
+			</plugin>
+
+			<plugin>
+				<groupId>org.codehaus.mojo</groupId>
+				<artifactId>findbugs-maven-plugin</artifactId>
+				<version>3.0.4</version>
+			</plugin>
+
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-surefire-report-plugin</artifactId>
+				<version>2.19.1</version>
+			</plugin>
+
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-project-info-reports-plugin</artifactId>
+				<version>2.9</version>
+			</plugin>
+		</plugins>
+	</reporting>
+
 	<dependencies>
 		<dependency>
 			<groupId>org.slf4j</groupId>
@@ -144,9 +211,11 @@ approximation of any real system, but to pose the same hardness and complexity.
 				<artifactId>maven-compiler-plugin</artifactId>
 				<version>2.3.2</version>
 				<configuration>
-					<source>${javaSource}</source>
-					<target>${javaTarget}</target>
+					<source>1.${java.min.version}</source>
+					<target>1.${java.min.version}</target>
 					<encoding>${project.build.sourceEncoding}</encoding>
+					<showDeprecation>true</showDeprecation>
+					<compilerArgument>-Xlint:unchecked</compilerArgument>
 				</configuration>
 			</plugin>
 			<!-- Build deliverables: JAR -->
@@ -162,8 +231,15 @@ approximation of any real system, but to pose the same hardness and complexity.
 								used to specify that all needed libraries are found under lib/ directory. -->
 							<classpathPrefix>lib/</classpathPrefix>
 							<!-- Specifies the main class of the application -->
-							<mainClass>com.siemens.industrialbenchmark.ExampleMain</mainClass>
+							<mainClass>${project.mainClass}</mainClass>
 						</manifest>
+						<manifestEntries>
+							<!--
+								Prevent the local user-name from entering the JAR manifest.
+								This is required for reproducible builds.
+							-->
+							<Built-By />
+						</manifestEntries>
 					</archive>
 				</configuration>
 			</plugin>
@@ -218,21 +294,86 @@ approximation of any real system, but to pose the same hardness and complexity.
 						</configuration>
 					</execution>
 				</executions>
-			</plugin>
-			<!-- Build deliverables: Self-contained JAR with all dependencies -->
-			<plugin>
-				<artifactId>maven-assembly-plugin</artifactId>
+				<!-- Build deliverables: Self-contained JAR with all dependencies -->
 				<configuration>
 					<archive>
 						<manifest>
-							<mainClass>com.siemens.industrialbenchmark.ExampleMain</mainClass>
+							<mainClass>${project.mainClass}</mainClass>
 						</manifest>
 					</archive>
 					<descriptorRefs>
 						<descriptorRef>jar-with-dependencies</descriptorRef>
 					</descriptorRefs>
 				</configuration>
 			</plugin>
+
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-javadoc-plugin</artifactId>
+				<version>2.8</version>
+				<configuration>
+					<charset>${project.build.sourceEncoding}</charset>
+					<encoding>${project.build.sourceEncoding}</encoding>
+				</configuration>
+			</plugin>
+
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-resources-plugin</artifactId>
+				<version>3.0.2</version>
+				<configuration>
+					<encoding>${project.build.resourceEncoding}</encoding>
+				</configuration>
+			</plugin>
+
+			<plugin>
+				<groupId>org.codehaus.mojo</groupId>
+				<artifactId>exec-maven-plugin</artifactId>
+				<version>1.5.0</version>
+				<executions>
+					<execution>
+						<goals>
+							<goal>java</goal>
+						</goals>
+					</execution>
+				</executions>
+				<configuration>
+					<mainClass>${project.mainClass}</mainClass>
+				</configuration>
+			</plugin>
+
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-checkstyle-plugin</artifactId>
+				<version>2.17</version>
+				<configuration>
+					<sourceEncoding>${project.build.sourceEncoding}</sourceEncoding>
+					<linkXref>true</linkXref>
+					<configLocation>src/main/resources/checkstyle.xml</configLocation>
+					<propertyExpansion>java.header.regex.template.file=${basedir}/src/main/resources/java_header_regex_template.txt</propertyExpansion>
+				</configuration>
+			</plugin>
+
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-pmd-plugin</artifactId>
+				<version>3.7</version>
+				<configuration>
+					<aggregate>true</aggregate>
+					<linkXref>true</linkXref>
+					<sourceEncoding>${project.build.sourceEncoding}</sourceEncoding>
+					<targetJdk>1.${java.min.version}</targetJdk>
+					<rulesets>
+						<ruleset>${basedir}/src/main/resources/pmd.xml</ruleset>
+					</rulesets>
+				</configuration>
+			</plugin>
+
+			<plugin>
+				<groupId>org.codehaus.mojo</groupId>
+				<artifactId>findbugs-maven-plugin</artifactId>
+				<version>3.0.4</version>
+			</plugin>
 		</plugins>
 	</build>
 
@@ -255,7 +396,8 @@ approximation of any real system, but to pose the same hardness and complexity.
 							</execution>
 						</executions>
 						<configuration>
-							<excludePackageNames>com.siemens.industrialbenchmark.*</excludePackageNames>
+							<charset>${project.build.sourceEncoding}</charset>
+							<encoding>${project.build.sourceEncoding}</encoding>
 						</configuration>
 					</plugin>
 					<plugin>
@@ -307,5 +449,49 @@ approximation of any real system, but to pose the same hardness and complexity.
 				</plugins>
 			</build>
 		</profile>
+
+		<profile>
+			<id>Extensive-Reports</id>
+			<!--
+				This profile adds additional reports to the site phase.
+				The reports in here create a lot of output (in MB).
+				Thus we do not want to use them to generate the default site,
+				which is uploaded on the web (for potentially many versions).
+			-->
+			<reporting>
+				<plugins>
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-jxr-plugin</artifactId>
+						<version>2.5</version>
+						<configuration>
+							<sourceEncoding>${project.build.sourceEncoding}</sourceEncoding>
+						</configuration>
+					</plugin>
+
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-javadoc-plugin</artifactId>
+						<version>2.8</version>
+						<configuration>
+							<charset>${project.build.sourceEncoding}</charset>
+							<encoding>${project.build.sourceEncoding}</encoding>
+						</configuration>
+					</plugin>
+
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-changelog-plugin</artifactId>
+						<version>2.3</version>
+					</plugin>
+
+					<plugin>
+						<groupId>org.codehaus.mojo</groupId>
+						<artifactId>sonar-maven-plugin</artifactId>
+						<version>3.2</version>
+					</plugin>
+				</plugins>
+			</reporting>
+		</profile>
 	</profiles>
 </project>