<commit_before><commit_msg>adding install instructions to sphinx doc<commit_after>Installation
============

A working version is installable via pip:
----------------------------------------

::

    pip install optimizer

This is always the latest (stable) branch corresponding to the master
branch on github.


Get a read only copy of libNeuroML
----------------------------------

Install `git`_ and type:

::

    git clone git://github.com/vellamike/optimizer.git

More information on this here:
.. _Git: http://rogerdudler.github.com/git-guide/


Install optimizer
------------------

Use the standard install method for Python packages:


::

    sudo python setup.py install
{'fraction_non_alphanumeric': 0.2108345534407028, 'fraction_numerical': 0.0, 'mean_word_length': 2.257142857142857, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, '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': '5474053', 'n_tokens_mistral': 183, 'n_tokens_neox': 170, 'n_words': 65}