aeneas-benchmark

The official benchmark suite for aeneas

• Version: 0.0.3 (aeneas 1.7.2)
• Date: 2017-03-04
• Developed by: ReadBeyond
• Lead Developer: Alberto Pettarin
• License: the GNU Affero General Public License Version 3 (AGPL v3)
• Contact: [email protected]
• Quick Links: Results - Code - aeneas

Goal

To benchmark aeneas on different machines and under different I/O and parameter configurations.

Usage

Running the benchmark

1. Clone the repository from GitHub and switch to the master branch:

    $ git clone https://github.com/ReadBeyond/aeneas-benchmark
    $ cd aeneas-benchmark
    $ git checkout master

2. Enter the benchmark directory:

   $ cd benchmark

3. Rename the ENVINFO.editme file to ENVINFO, and edit it with your system info.

4. Run the benchmark suite (it requires several minutes to complete):

   $ python run_benchmark.py --all

If you want to contribute your benchmark, please contact us via email (the email address is written at the beginning of the page).

Creating the static site

1. Run the benchmark (see above) on at least one machine.

2. If you run the benchmark on more than one machine, please copy the *.json files from the other machines into the benchmark/output directory of the machine you want to build the static HTML files (e.g., your personal PC/laptop). Note that it is crucial each machine to have its own (distinct) ENVINFO file.

3. Edit the last lines of the sitebuilder/build_all.sh script, and the output/index.html file, depending on the actual machines you have. (TODO: automate this.)

4. Run:

   $ cd sitebuilder
   $ bash build_all.sh

   The static HTML files are created in the output/ directory.

License

aeneas-benchmark is released under the terms of the GNU Affero General Public License Version 3. See the LICENSE file for details.

Licenses for third party code and files included in aeneas-benchmark can be found in the licenses directory.

No copy rights were harmed in the making of this project.