A large-scale agent-based simulation model of a securities exchange built using the Play framework
While the Play framework requires JDK 6+, I would recommend that you go ahead and install JDK 8 direct from Oracle. Once your JDK has been installed, then you can download and install Play. Mac, Linux, and Windows users can download Play (and its dependencies) direct from the website.
Additionally, Mac users can install the Play framework (and dependencies) via Homebrew (assuming of course that you have installed Homebrew) using the following command in a terminal:
$ brew install activator
The project uses the sbt-scoverage plugin to generate test coverage statistics. To run the tests with coverage enabled simply run the following command in a terminal from the project root directory:
$ sbt clean coverage test
After the tests have finished you can then run
$ sbt coverageReport
to generate the reports. The generated code coverage reports can be found inside target/scoverage-report.
The API documentation for the project is very much a work in progress. To generate the most current version of the documentation simply run the sbt doc command from the project root directory:
$ sbt doc
The above command generates the documentation and places it under the target directory. The root file for the documentation is located at target/scala-2.11/api/index.html. To view the documentation, simply open this file in your favorite browser.