Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
madsbk committed Apr 26, 2017
1 parent 6ba8ec5 commit 6d7a856
Showing 1 changed file with 4 additions and 29 deletions.
33 changes: 4 additions & 29 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,14 @@
:target: http://benchpress.readthedocs.org/
:alt: Documentation Status

.. image:: https://pypip.in/version/benchpress/badge.svg
:target: https://pypi.python.org/pypi/benchpress/
:alt: Latest Version

.. image:: https://pypip.in/py_versions/benchpress/badge.svg
:target: https://pypi.python.org/pypi/benchpress/
:alt: Supported Python versions

.. image:: https://pypip.in/implementation/benchpress/badge.svg
:target: https://pypi.python.org/pypi/benchpress/
:alt: Supported Python implementations
.. image:: https://badge.fury.io/py/benchpress.svg
:target: https://badge.fury.io/py/benchpress

Quick Start
===========

Fire up your terminal, and::

# Clone the repos
git clone git@github.com:bh107/benchpress.git

# Enter the root
cd benchpress

# Source environment vars
source util/setbpenv.bash

You now have the Benchpress commands, ``bp-run``, ``bp-times``, ``bp-info``, ``bp-compile``, and ``bp-grapher`` ready at your finger-tips along with all the benchmarks and suites.

Go ahead and run the `python_numpy` suite, executing each benchmark in the suite twice::

bp-run NOREPOS suites/python_numpy.py --runs 2 --output my_run.json

The above will store results from the run in the file `my_run.json`. You can inspect the elapsed wall-clock by executing::

bp-times my_run.json
# Install using PyPi
pip install benchpress --user

0 comments on commit 6d7a856

Please sign in to comment.