<commit_before>.. index:: Quickstart
.. _Quickstart:

Quickstart
==========

tl;dr
-----

For the impatient::

    python setup.py install --user


Getting Started
---------------

Welcome!  This guide will assume that you want to set up IceProd locally on a new machine.

Download the Project
^^^^^^^^^^^^^^^^^^^^

To download the project, check it out from svn::

    $ svn co http://code.icecube.wisc.edu/svn/sandbox/dschultz/iceprod2 iceprod

If you do not need to stay up to date, you may also get an exported version::

    $ svn export http://code.icecube.wisc.edu/svn/sandbox/dschultz/iceprod2 iceprod

Build the Project
^^^^^^^^^^^^^^^^^

The main requirement of IceProd is Python 2.7 or greater.  Python 3 is supported.

IceProd acts like a normal python project, and with the help of `setuptools`
can download and install all required dependencies. If you do not have `setuptools`
installed, you will need to install the dependencies yourself.

Required Dependencies
"""""""""""""""""""""

* tornado >= 4.2
* pyzmq
* jsonschema

If using python < 3.2, the following is also required:

* futures
* backports.ssl_match_hostname

Recommended Dependencies
""""""""""""""""""""""""

* setproctitle
* pycurl
* openssl
* pyasn1

Installation Example
""""""""""""""""""""

The easy way to install dependencies is with pip.  Then install IceProd::

    $ pip install --user tornado pyzmq setproctitle pycurl openssl pyasn1
    $ python setup.py install --user

This will install IceProd and all dependencies into your home directory, under ``~/.local``.


How to Run the Server
"""""""""""""""""""""

To run the server::

    $ python bin/iceprod_server.py

Disabling SSL
"""""""""""""<commit_msg>fix repo location<commit_after>.. index:: Quickstart
.. _Quickstart:

Quickstart
==========

tl;dr
-----

For the impatient::

    pip install --user https://github.com/WIPACrepo/iceprod.git


Getting Started
---------------

Welcome!  This guide will assume that you want to set up IceProd locally on a
new machine.

Download the Project
^^^^^^^^^^^^^^^^^^^^

To download the project, check it out from github::

    $ git clone https://github.com/WIPACrepo/iceprod.git

Build the Project
^^^^^^^^^^^^^^^^^

The main requirement of IceProd is Python 2.7 or greater.  Python 3 is supported.

IceProd acts like a normal python project, and with the help of `setuptools`
can download and install all required dependencies. If you do not have `setuptools`
installed, you will need to install the dependencies yourself.

Required Dependencies
"""""""""""""""""""""

* tornado >= 4.2
* pyzmq
* jsonschema

If using python < 3.2, the following is also required:

* futures
* backports.ssl_match_hostname

Recommended Dependencies
""""""""""""""""""""""""

* setproctitle
* pycurl
* openssl
* pyasn1

Installation Example
""""""""""""""""""""

The easy way to install dependencies is with pip.  Then install IceProd::

    $ pip install --user tornado pyzmq setproctitle pycurl openssl pyasn1
    $ python setup.py install --user

This will install IceProd and all dependencies into your home directory,
under ``~/.local``.


How to Run the Server
"""""""""""""""""""""

To run the server::

    $ python bin/iceprod_server.py

Disabling SSL
"""""""""""""
{'fraction_non_alphanumeric': 0.15922389898367725, 'fraction_numerical': 0.006159531875577456, 'mean_word_length': 3.9436834094368343, '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': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3350129', 'n_tokens_mistral': 1048, 'n_tokens_neox': 996, 'n_words': 374}