benchmarking/README

   1 To set up benchmarking:
   2
   3
   4 1. In the jalview directory run
   5   ant makedist
   6
   7 This builds a jalview.jar file and puts it into dist/
   8
   9
  10 2. Make a lib directory in benchmarking/ if not already present.
  11
  12
  13 3. In the benchmarking directory 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
  19 4. Build and run jmh benchmarking. In the benchmarking directory:
  20         mvn clean install
  21         java -jar target/benchmarks.jar
  22
  23   To get output as a json file use instead:
  24         java -jar target/benchmarks.jar -rf json
  25
  26   JSON files can be visualised using the viewer at http://jmh.morethan.io/
  27
  28   To get help use the standard -h option:
  29         java -jar target/benchmarks.jar -h
  30
  31   More information here:
  32         http://openjdk.java.net/projects/code-tools/jmh/
  33         http://java-performance.info/jmh/
  34
  35
  36  5. If you make changes to the jalview code everything will need to be refreshed, by calling:
  37         mvn dependency:purge-local-repository -DactTransitively=false -DreResolve=false
  38
  39   followed by steps 3 and 4 again.
  40