<commit_before>===============================================================================
PyMTL Installation
===============================================================================

-------------------------------------------------------------------------------
Prerequisites
-------------------------------------------------------------------------------

 - Python2.7
 - virtualenv
 - iverilog                      (for testing generated Verilog HDL)
 - verilator                     (for testing generated Verilog HDL)
 - PARC cross-compiler toolchain (for testing PARC processor model)

-------------------------------------------------------------------------------
BRG Server Setup
-------------------------------------------------------------------------------

When running/developing PyMTL on the BRG servers, you should first run the
setup script. See the OSX/Linux section below for all other installation steps.

::

  % source setup-brg.sh

-------------------------------------------------------------------------------
OSX/Linux Installation
-------------------------------------------------------------------------------

Create a new Python virtualenv and activate it::

  % mkdir ~/venvs
  % virtualenv --python=python2.7 ~/venvs/pymtl
  % source ~/venvs/pymtl/bin/activate

Install Python package prerequisites using pip::

  % pip install yolk pytest pytest-xdist cffi
  % yolk -l

Checkout the repo::

  % mkdir -p ~/vc/git-brg
  % cd ~/vc/git-brg
  % https://github.com/dmlockhart/pymtl.git
  % cd pymtl

Create a build directory and run the tests::

  % mkdir build
  % cd build
  % py.test .. --tb=line

When you're done testing/developing, you can disable the virtualenv::

  % deactivate
<commit_msg>[docs] add greenlets to list of pip requirements<commit_after>===============================================================================
PyMTL Installation
===============================================================================

-------------------------------------------------------------------------------
Prerequisites
-------------------------------------------------------------------------------

 - Python2.7
 - virtualenv
 - iverilog                      (for testing generated Verilog HDL)
 - verilator                     (for testing generated Verilog HDL)
 - PARC cross-compiler toolchain (for testing PARC processor model)

-------------------------------------------------------------------------------
BRG Server Setup
-------------------------------------------------------------------------------

When running/developing PyMTL on the BRG servers, you should first run the
setup script. See the OSX/Linux section below for all other installation steps.

::

  % source setup-brg.sh

-------------------------------------------------------------------------------
OSX/Linux Installation
-------------------------------------------------------------------------------

Create a new Python virtualenv and activate it::

  % mkdir ~/venvs
  % virtualenv --python=python2.7 ~/venvs/pymtl
  % source ~/venvs/pymtl/bin/activate

Install Python package prerequisites using pip::

  % pip install yolk pytest pytest-xdist cffi greenlets
  % yolk -l

Checkout the repo::

  % mkdir -p ~/vc/git-brg
  % cd ~/vc/git-brg
  % https://github.com/dmlockhart/pymtl.git
  % cd pymtl

Create a build directory and run the tests::

  % mkdir build
  % cd build
  % py.test .. --tb=line

When you're done testing/developing, you can disable the virtualenv::

  % deactivate

{'fraction_non_alphanumeric': 0.4110133409026398, 'fraction_numerical': 0.0022707919386886176, 'mean_word_length': 1.3077930582842174, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2694620', 'n_tokens_mistral': 799, 'n_tokens_neox': 751, 'n_words': 250}