<commit_before>=====
Tools
=====

Installation
============

Benchpress is distributed via PyPi and Github. Which means that you can install it as a Python package (from PyPi) or use it directly from an unpacked tarball or git-clone from Github.com.
The installation method of choice is based on what you want to do with Benchpress. Recommendations are as follows.

 * Install Benchpress as a Python packages from PyPi if your sole intent is to `run` benchmarks.
 * Use benchpress directly from clone/tarball if you intend to modify anything. Such as adding benchmarks, changing commands or benchmark suites.

.. note:: Benchpress is designed to work, with minimal friction, in an environment where the user has limited system permissions. Such as shared computing environments eg. clusters and supercomputers. A system-wide installation of Benchpress is untested, however, it should work if you assign write permission, for Benchpress users, to the ``benchmarks`` subfolder.


From pypi.python.org
--------------------

The following shows how to do a user-mode / local installation::

  pip install benchpress --user

Extend your ``$PATH``, such that the commands (`bp_info`, `bp_run`, `bp_times`, `bp_compile`, `and bp_grapher`) are readily available::

  export PATH=$PATH:$HOME/.local/bin

When you are done using Benchpress, purging it from your system is as easy as::

  pip uninstall benchpress

From clone or tarball
---------------------

Clone the repos::

  git clone <EMAIL>@bitbucket.org:bohrium/benchpress.git
  cd benchpress

or download and unpack tarball::

  wget https://bitbucket.org/bohrium/benchpress/get/master.tar.gz
  tar xzvf master.tar.gz
  cd bohrium-benchpress-*

For Benchpress to operate correctly you need to extend two enviroment variables, namely ``PATH`` and ``PYTHONPATH``. Extend ``PATH`` to include the subfolder ``bin`` and ``PYTHONPATH`` to include the subfolder ``module``. You can do this in whatever way your system requires, you will most likely simply be able to do the following::

  source util/setbpenv.bash

Make sure you persists the changes.

Usage
=====

bp_run
------

...

bp_times
--------

...

bp_grapher
----------

...

Implementations / Libraries / Modules<commit_msg>Docs..<commit_after>=====
Tools
=====

Installation
============

Benchpress is distributed via PyPi and Github. Which means that you can install it as a Python package (from PyPi) or use it directly from an unpacked tarball or git-clone from Github.com.
The installation method of choice is based on what you want to do with Benchpress. Recommendations are as follows.

 * Install Benchpress as a Python packages from PyPi if your sole intent is to `run` benchmarks.
 * Use benchpress directly from clone/tarball if you intend to modify anything. Such as adding benchmarks, changing commands or benchmark suites.

.. note:: Benchpress is designed to work, with minimal friction, in an environment where the user has limited system permissions. Such as shared computing environments eg. clusters and supercomputers. A system-wide installation of Benchpress is untested, however, it should work if you assign write permission, for Benchpress users, to the ``benchmarks`` subfolder.


From pypi.python.org
--------------------

The following shows how to do a user-mode / local installation::

  pip install benchpress --user

Extend your ``$PATH``, such that the commands (`bp_info`, `bp_run`, `bp_times`, `bp_compile`, `and bp_grapher`) are readily available::

  export PATH=$PATH:$HOME/.local/bin

When you are done using Benchpress, purging it from your system is as easy as::

  pip uninstall benchpress

From clone or tarball
---------------------

Clone the repos::

  git clone <EMAIL>:bohrium/benchpress.git
  cd benchpress

or download and unpack tarball::

  wget https://bitbucket.org/bohrium/benchpress/get/master.tar.gz
  tar xzvf master.tar.gz
  cd bohrium-benchpress-*

For Benchpress to operate correctly you `must` extend the two ``PATH`` and ``PYTHONPATH``. Extend ``PATH`` to include the subfolder ``bin`` and extend ``PYTHONPATH`` to include the subfolder ``module``. You can do this in whatever way your system requires, you will most likely be able to do the following::

  source util/setbpenv.bash

Make sure you persists the changes.

Usage
=====

bp_run
------

...

bp_times
--------

...

bp_grapher
----------

...

Implementations / Libraries / Modules
{'fraction_non_alphanumeric': 0.1104058036726366, 'fraction_numerical': 0.0, 'mean_word_length': 3.698615548455804, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7350278', 'n_tokens_mistral': 1242, 'n_tokens_neox': 1175, 'n_words': 562}