From a76bf4a54d019c89cf3581f61f6f08d48e39587b Mon Sep 17 00:00:00 2001 From: aakarshg Date: Mon, 28 Oct 2019 15:50:31 -0400 Subject: [PATCH] updated readme --- CHANGELOG.rst | 3 +-- README.rst | 34 +++++++++++++++++++++++++++++++--- 2 files changed, 32 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 226e6f5..89c1785 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,5 @@ Changelog Version 0.1 =========== -- Feature A added +- uperf data comparison in elasticsearch ran through ripsaw - FIX: nasty bug #1729 fixed -- add your changes here! diff --git a/README.rst b/README.rst index e78a104..8e8384f 100644 --- a/README.rst +++ b/README.rst @@ -2,10 +2,38 @@ touchstone ========== -To compare two benchmark results - +Framework to help data comparison between 2 similar datasets. Description =========== +Touchstone is a framework written in python that provides you an apples to apples comparison +between 2 similar datasets. + +Touchstone currently supports comparison of the following docs: + +| Benchmark | Database | Harness | +|----------------|------------------|---------------| +| Uperf | Elasticsearch | Ripsaw | + +Usage +===== + +It is suggested to use a venv to install and run touchstone. + +``` +python -m venv /path/to/new/virtual/environment +source /path/to/new/virtual/environment/bin/activate +git clone https://github.com/cloud-bulldozer/touchstone +python setup.py develop +touchstone_compare -h +``` + +For example: + +To compare 2 runs of uperf data indexed into elasticsearch server marquez.perf.lab.eng.rdu2.redhat.com ran through ripsaw, +which generated 2 uuids: [6c5d0257-57e4-54f0-9c98-e149af8b4a5c 70cbb0eb-8bb6-58e3-b92a-cb802a74bb52] -A longer description of your project goes here... +You'd be running it as follows: +``` +touchstone_compare uperf elasticsearch ripsaw -url marquez.perf.lab.eng.rdu2.redhat.com marquez.perf.lab.eng.rdu2.redhat.com -u 6c5d0257-57e4-54f0-9c98-e149af8b4a5c 70cbb0eb-8bb6-58e3-b92a-cb802a74bb52 +```