JAL-2829 fixes and unit tests
[jalview.git] / benchmarking / README
1 To set up benchmarking:
2
3 1. In the jalview directory run 
4   ant makedist
5
6 This builds a jalview.jar file and puts it into dist/
7
8 2. Make a lib directory in benchmarking/ if not already present.
9
10 3. Purge any previous maven dependencies:
11    mvn dependency:purge-local-repository -DactTransitively=false -DreResolve=false
12
13 4. Run
14   mvn install:install-file -Dfile=../dist/jalview.jar -DgroupId=jalview.org -DartifactId=jalview -Dversion=1.0 -Dpackaging=jar -DlocalRepositoryPath=lib
15
16 to install the jalview.jar file in the local maven repository. The pom.xml in the benchmarking references this installation, so if you change the names the pom.xml file will also need to be updated.
17
18 5. Build and run jmh benchmarking. In the benchmarking directory:
19   mvn clean install
20   java -jar target/benchmarks.jar
21   
22   To get JSON output instead use:
23   java -jar target/benchmarks.jar -rf json
24   
25   JSON output can be viewed quickly by drag-dropping on http://jmh.morethan.io/