README.md
author Jan Vrany <jan.vrany@fit.cvut.cz>
Mon, 21 Mar 2016 13:15:35 +0100
changeset 314 9ac0be200068
parent 300 7644dc89cdad
permissions -rw-r--r--
CI: Added CI scripts for Pharo ...to make Jenkins setup easier. To run CalipeL/S tests on Pharo, simply execute: wget -O "ci-pharo-common.sh" https://bitbucket.org/janvrany/jv-calipel/raw/tip/s/pharo/ci/ci-pharo-tests.sh | bash -x To run standard set ob benchmarks on Pharo, run wget -O "ci-pharo-common.sh" https://bitbucket.org/janvrany/jv-calipel/raw/tip/s/pharo/ci/ci-pharo-benchmarks.sh | bash -x
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
260
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
     1
![CalipeL](https://bitbucket.org/janvrany/jv-calipel/raw/71925d2ae258ffe413e495ea680e65a1834b4c13/web/public/images/logo.png)
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
     2
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
     3
*Benchmarking made easy*
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
     4
296
5c907ddba18b Minor edits in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 286
diff changeset
     5
CalipeL is a simple tool to ease development and maintenance
260
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
     6
of benchmarks and performance regressions. CalipeL has been heavily 
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
     7
inspired by [SUnit][1] and [Caliper][2]
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
     8
296
5c907ddba18b Minor edits in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 286
diff changeset
     9
The basic ideas that drove the development:
260
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    10
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    11
- Benchmarking and (especially) interpreting benchmark results is always
296
5c907ddba18b Minor edits in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 286
diff changeset
    12
  a monkey business. The tool should produce raw numbers, letting the 
300
7644dc89cdad Oops, fixed another typo in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 299
diff changeset
    13
  user to use whichever statistics she needs to make up (desired) results. 
299
26fa4f7e4b8e Fixed typos in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 296
diff changeset
    14
- Benchmark results should be kept and managed at a single place so one
260
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    15
  can view and retrieve all past benchmark results pretty much the same
296
5c907ddba18b Minor edits in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 286
diff changeset
    16
  way as one can view and retrieve past versions of the software from 
299
26fa4f7e4b8e Fixed typos in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 296
diff changeset
    17
  a source code management tool. 
260
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    18
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    19
## Features
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    20
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    21
- *simple* - creating a benchmark is as simple as writing a method in a class
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    22
- *flexible* - a special set-up and/or warm-up routines could be specified at benchmark-level as well as set of parameters to allow fine-grained measurements
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    23
under different conditions 
296
5c907ddba18b Minor edits in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 286
diff changeset
    24
- *batch runner* - contains a batch runner allowing one to run benchmarks from a command line or at CI servers such as Jenkins. 
260
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    25
- *web* - comes with simple web interface to gather and process benchmark results. [Example...](https://swing.fit.cvut.cz/calipel)
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    26
286
930f7307f70b Updated README
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 260
diff changeset
    27
## Supported Languages / Runtimes
260
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    28
286
930f7307f70b Updated README
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 260
diff changeset
    29
* [Smalltalk/X jv-branch][6]
260
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    30
* [Pharo][5]
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    31
296
5c907ddba18b Minor edits in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 286
diff changeset
    32
Planned (would be nice if somebody does it)
260
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    33
286
930f7307f70b Updated README
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 260
diff changeset
    34
* Java (on hold)
260
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    35
* Ruby
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    36
* Python
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    37
286
930f7307f70b Updated README
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 260
diff changeset
    38
## Installation
930f7307f70b Updated README
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 260
diff changeset
    39
299
26fa4f7e4b8e Fixed typos in README.md
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 296
diff changeset
    40
See [Installation instruction](https://bitbucket.org/janvrany/jv-calipel/wiki/Installation.md) on [wiki][3].
286
930f7307f70b Updated README
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 260
diff changeset
    41
260
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    42
## More Information
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    43
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    44
...could be found on [wiki][3].
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    45
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    46
## Authors
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    47
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    48
* Jan Vraný `<jan.vrany [*] fit.cvut.cz>`
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    49
* Marcel Hlopko `<marcel [*] hlopko.com>`
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    50
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    51
[1]: http://sunit.sourceforge.net/
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    52
[2]: https://code.google.com/p/caliper/
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    53
[3]: https://bitbucket.org/janvrany/jv-calipel/wiki/Home
cd63f2ae1a72 Some work on documentation
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 245
diff changeset
    54
[4]: http://www.exept.de/de/products/smalltalkx
286
930f7307f70b Updated README
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 260
diff changeset
    55
[5]: http://www.pharo-project.org/home
930f7307f70b Updated README
Jan Vrany <jan.vrany@fit.cvut.cz>
parents: 260
diff changeset
    56
[6]: https://swing.fit.cvut.cz/projects/stx-jv/