% Generated by Sphinx.
\def\sphinxdocclass{report}
\documentclass[letterpaper,10pt,english]{sphinxmanual}
\usepackage[utf8]{inputenc}
\DeclareUnicodeCharacter{00A0}{\nobreakspace}
\usepackage{cmap}
\usepackage[T1]{fontenc}
\usepackage{babel}
\usepackage{times}
\usepackage[Bjarne]{fncychap}
\usepackage{longtable}
\usepackage{sphinx}
\usepackage{multirow}


\title{CCHR Documentation}
\date{October 03, 2013}
\release{1.0}
\author{NORC}
\newcommand{\sphinxlogo}{}
\renewcommand{\releasename}{Release}
\makeindex

\makeatletter
\def\PYG@reset{\let\PYG@it=\relax \let\PYG@bf=\relax%
    \let\PYG@ul=\relax \let\PYG@tc=\relax%
    \let\PYG@bc=\relax \let\PYG@ff=\relax}
\def\PYG@tok#1{\csname PYG@tok@#1\endcsname}
\def\PYG@toks#1+{\ifx\relax#1\empty\else%
    \PYG@tok{#1}\expandafter\PYG@toks\fi}
\def\PYG@do#1{\PYG@bc{\PYG@tc{\PYG@ul{%
    \PYG@it{\PYG@bf{\PYG@ff{#1}}}}}}}
\def\PYG#1#2{\PYG@reset\PYG@toks#1+\relax+\PYG@do{#2}}

\expandafter\def\csname PYG@tok@gd\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.63,0.00,0.00}{##1}}}
\expandafter\def\csname PYG@tok@gu\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.50,0.00,0.50}{##1}}}
\expandafter\def\csname PYG@tok@gt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.27,0.87}{##1}}}
\expandafter\def\csname PYG@tok@gs\endcsname{\let\PYG@bf=\textbf}
\expandafter\def\csname PYG@tok@gr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{1.00,0.00,0.00}{##1}}}
\expandafter\def\csname PYG@tok@cm\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
\expandafter\def\csname PYG@tok@vg\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
\expandafter\def\csname PYG@tok@m\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
\expandafter\def\csname PYG@tok@mh\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
\expandafter\def\csname PYG@tok@cs\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}
\expandafter\def\csname PYG@tok@ge\endcsname{\let\PYG@it=\textit}
\expandafter\def\csname PYG@tok@vc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
\expandafter\def\csname PYG@tok@il\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
\expandafter\def\csname PYG@tok@go\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.20,0.20,0.20}{##1}}}
\expandafter\def\csname PYG@tok@cp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
\expandafter\def\csname PYG@tok@gi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.63,0.00}{##1}}}
\expandafter\def\csname PYG@tok@gh\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.00,0.50}{##1}}}
\expandafter\def\csname PYG@tok@ni\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.84,0.33,0.22}{##1}}}
\expandafter\def\csname PYG@tok@nl\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.13,0.44}{##1}}}
\expandafter\def\csname PYG@tok@nn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}}
\expandafter\def\csname PYG@tok@no\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.38,0.68,0.84}{##1}}}
\expandafter\def\csname PYG@tok@na\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
\expandafter\def\csname PYG@tok@nb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
\expandafter\def\csname PYG@tok@nc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.05,0.52,0.71}{##1}}}
\expandafter\def\csname PYG@tok@nd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.33,0.33,0.33}{##1}}}
\expandafter\def\csname PYG@tok@ne\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
\expandafter\def\csname PYG@tok@nf\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.49}{##1}}}
\expandafter\def\csname PYG@tok@si\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.44,0.63,0.82}{##1}}}
\expandafter\def\csname PYG@tok@s2\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
\expandafter\def\csname PYG@tok@vi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
\expandafter\def\csname PYG@tok@nt\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.02,0.16,0.45}{##1}}}
\expandafter\def\csname PYG@tok@nv\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.38,0.84}{##1}}}
\expandafter\def\csname PYG@tok@s1\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
\expandafter\def\csname PYG@tok@gp\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}}
\expandafter\def\csname PYG@tok@sh\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
\expandafter\def\csname PYG@tok@ow\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
\expandafter\def\csname PYG@tok@sx\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.78,0.36,0.04}{##1}}}
\expandafter\def\csname PYG@tok@bp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
\expandafter\def\csname PYG@tok@c1\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
\expandafter\def\csname PYG@tok@kc\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
\expandafter\def\csname PYG@tok@c\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}}
\expandafter\def\csname PYG@tok@mf\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
\expandafter\def\csname PYG@tok@err\endcsname{\def\PYG@bc##1{\setlength{\fboxsep}{0pt}\fcolorbox[rgb]{1.00,0.00,0.00}{1,1,1}{\strut ##1}}}
\expandafter\def\csname PYG@tok@kd\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
\expandafter\def\csname PYG@tok@ss\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.32,0.47,0.09}{##1}}}
\expandafter\def\csname PYG@tok@sr\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.14,0.33,0.53}{##1}}}
\expandafter\def\csname PYG@tok@mo\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
\expandafter\def\csname PYG@tok@mi\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.13,0.50,0.31}{##1}}}
\expandafter\def\csname PYG@tok@kn\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
\expandafter\def\csname PYG@tok@o\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.40,0.40,0.40}{##1}}}
\expandafter\def\csname PYG@tok@kr\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
\expandafter\def\csname PYG@tok@s\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
\expandafter\def\csname PYG@tok@kp\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
\expandafter\def\csname PYG@tok@w\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.73,0.73,0.73}{##1}}}
\expandafter\def\csname PYG@tok@kt\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.56,0.13,0.00}{##1}}}
\expandafter\def\csname PYG@tok@sc\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
\expandafter\def\csname PYG@tok@sb\endcsname{\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
\expandafter\def\csname PYG@tok@k\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.00,0.44,0.13}{##1}}}
\expandafter\def\csname PYG@tok@se\endcsname{\let\PYG@bf=\textbf\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}
\expandafter\def\csname PYG@tok@sd\endcsname{\let\PYG@it=\textit\def\PYG@tc##1{\textcolor[rgb]{0.25,0.44,0.63}{##1}}}

\def\PYGZbs{\char`\\}
\def\PYGZus{\char`\_}
\def\PYGZob{\char`\{}
\def\PYGZcb{\char`\}}
\def\PYGZca{\char`\^}
\def\PYGZam{\char`\&}
\def\PYGZlt{\char`\<}
\def\PYGZgt{\char`\>}
\def\PYGZsh{\char`\#}
\def\PYGZpc{\char`\%}
\def\PYGZdl{\char`\$}
\def\PYGZhy{\char`\-}
\def\PYGZsq{\char`\'}
\def\PYGZdq{\char`\"}
\def\PYGZti{\char`\~}
% for compatibility with earlier versions
\def\PYGZat{@}
\def\PYGZlb{[}
\def\PYGZrb{]}
\makeatother

\begin{document}

\maketitle
\tableofcontents
\phantomsection\label{index::doc}



\chapter{Indices and tables}
\label{index:indices-and-tables}\label{index:cchrrd}\begin{itemize}
\item {} 
\emph{genindex}

\item {} 
\emph{search}

\end{itemize}


\section{Overview}
\label{index:overview}

\subsection{Introduction}
\label{overview/intro:introduction}\label{overview/intro::doc}

\subsubsection{History}
\label{overview/intro:history}
Insert Project History


\subsubsection{Project Mission}
\label{overview/intro:project-mission}
The CCHRRD Conversion Software's mission is to provide an open source expert coding system
for harmonizing  parsed criminal history records obtained from the NLETS III system.

To provide maximum flexibility, the Conversion Software is licensed under the \href{http://opensource.org/licenses/MIT}{MIT license}.
\begin{quote}
\end{quote}


\subsubsection{Current Development Status}
\label{overview/intro:current-development-status}
With the release of version 1.0, the CCHRRD Conversion Software has achieved its first production release.

Version 1.02.a is currently under development at NORC and includes a new predictive modeling component to
make predictions at offense codes that are not supported by the current business rules.


\subsection{Requirements}
\label{overview/reqs:requirements}\label{overview/reqs::doc}
This guide assumes you are installing this software on a dedicated application server that meets the following requirements:


\subsubsection{Hardware}
\label{overview/reqs:hardware}
In order to optimize performance of the criminal history record conversion system, NORC recommends the following minimum hardware configuration:
\begin{itemize}
\item {} 
Microsoft Windows Server 2008

\item {} 
16 GB of RAM (32 GB preferred)

\item {} 
200 GB Hard Drive (or read/write access to a 200+ GB network drive)

\item {} 
You have write access to the directory where the software will be installed

\item {} 
At least one multi-core, high speed Intel or AMD processor (4 preferred)

\end{itemize}

\begin{notice}{note}{Note:}
Increased RAM, hard drive space, processer speed, or number of processors may improve performance.
\end{notice}


\subsubsection{Software}
\label{overview/reqs:software}
The criminal history records conversion system has the following application dependencies:
\begin{itemize}
\item {} 
\href{http://www.python.org/download/releases/2.7/}{Python 2.7} development environment and runtime libraries

\item {} 
NORC Python-ETL open source library. See {\hyperref[install/install:norc-python-etl]{\emph{NORC Python-ETL}}} section in the install guide for installation details.

\item {} 
\href{http://www.7-zip.org/download.html}{7-Zip} file archiver

\item {} 
\href{http://dev.mysql.com/downloads/}{MySQL} database platform version 5.X

\item {} 
Mercurial, Git or Apache Subversion source code control system (optional)

\item {} 
SAS 9.X (required for working with SAS files)

\end{itemize}
\begin{quote}
\end{quote}


\subsubsection{Security}
\label{overview/reqs:security}
The end user should expect to store the data, both raw and converted, on a password protected, role-based network drive.
Likewise, the applications server and its file structure should follow secure, least privileges best practices.
If a separate database server is created it and its file structure should also follow the same practices.
The entire system should be firewalled to prevent the opportunity for outside, hostile intrusion.
Access points will need to remain equally secure.
To eliminate the chance of malware spreading or unwarranted penetration,
NORC recommends granting entry to the various environments via VPN/Citrix or some other remote login and desktop emulation method.


\subsection{Project Directory Structure}
\label{overview/structure:project-directory-structure}\label{overview/structure::doc}

\subsection{Input}
\label{overview/io:input}\label{overview/io::doc}

\subsubsection{NLETS Files}
\label{overview/io:nlets-files}

\subsection{Output}
\label{overview/io:output}

\subsubsection{Standardized Database}
\label{overview/io:standardized-database}

\subsubsection{Recidivism Research Database}
\label{overview/io:recidivism-research-database}

\subsubsection{SPSS Flat Files}
\label{overview/io:spss-flat-files}

\subsection{Introduction to the User Interface}
\label{overview/ui:introduction-to-the-user-interface}\label{overview/ui::doc}

\section{Installation}
\label{index:installation}

\subsection{Installation Guide}
\label{install/install::doc}\label{install/install:installation-guide}
This is a guide to the BJS CCHRRD Conversion Software Package installation process.


\subsubsection{Installing Dependencies}
\label{install/install:installing-dependencies}

\paragraph{NORC Python-ETL}
\label{install/install:norc-python-etl}\label{install/install:id1}
sadasda


\chapter{CMD}
\label{index:cmd}

\section{\texttt{\_\_init\_\_}}
\label{cmd/__init__:module-src.cmd.__init__}\label{cmd/__init__::doc}\label{cmd/__init__:init}\index{src.cmd.\_\_init\_\_ (module)}\index{Cmd (class in src.cmd.\_\_init\_\_)}

\begin{fulllineitems}
\phantomsection\label{cmd/__init__:src.cmd.__init__.Cmd}\pysiglinewithargsret{\strong{class }\code{src.cmd.\_\_init\_\_.}\bfcode{Cmd}}{\emph{args}}{}~\index{flush() (src.cmd.\_\_init\_\_.Cmd method)}

\begin{fulllineitems}
\phantomsection\label{cmd/__init__:src.cmd.__init__.Cmd.flush}\pysiglinewithargsret{\bfcode{flush}}{}{}
\end{fulllineitems}

\index{get\_ns() (src.cmd.\_\_init\_\_.Cmd method)}

\begin{fulllineitems}
\phantomsection\label{cmd/__init__:src.cmd.__init__.Cmd.get_ns}\pysiglinewithargsret{\bfcode{get\_ns}}{}{}
Lookup the Pyro nameserver. Start the nameserver if not already started

\end{fulllineitems}

\index{run() (src.cmd.\_\_init\_\_.Cmd method)}

\begin{fulllineitems}
\phantomsection\label{cmd/__init__:src.cmd.__init__.Cmd.run}\pysiglinewithargsret{\bfcode{run}}{}{}
Create the cmd control logging directories and run the command.

\end{fulllineitems}

\index{start() (src.cmd.\_\_init\_\_.Cmd method)}

\begin{fulllineitems}
\phantomsection\label{cmd/__init__:src.cmd.__init__.Cmd.start}\pysiglinewithargsret{\bfcode{start}}{}{}
\end{fulllineitems}

\index{worker() (src.cmd.\_\_init\_\_.Cmd method)}

\begin{fulllineitems}
\phantomsection\label{cmd/__init__:src.cmd.__init__.Cmd.worker}\pysiglinewithargsret{\bfcode{worker}}{\emph{input}, \emph{output}, \emph{semaphore}}{}
\end{fulllineitems}


\end{fulllineitems}



\section{\texttt{Account Management}}
\label{cmd/account::doc}\label{cmd/account:account-management}\label{cmd/account:module-src.cmd.account}\index{src.cmd.account (module)}\index{add\_user() (in module src.cmd.account)}

\begin{fulllineitems}
\phantomsection\label{cmd/account:src.cmd.account.add_user}\pysiglinewithargsret{\code{src.cmd.account.}\bfcode{add\_user}}{\emph{cmd}}{}
The add\_user cmd allows a current user to add an additional user.

usage example:

\begin{Verbatim}[commandchars=\\\{\}]
\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{cchrrd} \PYG{n}{add\PYGZus{}user}
\end{Verbatim}

This command assumes that MySQL logs are currently disabled and/or in a restricted directory: 
See \href{http://dev.mysql.com/doc/refman/5.1/en/password-logging.html}{http://dev.mysql.com/doc/refman/5.1/en/password-logging.html} for more details.

\end{fulllineitems}

\index{drop\_user() (in module src.cmd.account)}

\begin{fulllineitems}
\phantomsection\label{cmd/account:src.cmd.account.drop_user}\pysiglinewithargsret{\code{src.cmd.account.}\bfcode{drop\_user}}{\emph{cmd}}{}
The drop\_user cmd allows a current user to drop an existing user from the database, including their own user account.

All users that have access to system are treated as administrators. Any user have rightst to drop any and all users from the database.

Usage Example:

\begin{Verbatim}[commandchars=\\\{\}]
\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{cchrrd} \PYG{n}{drop\PYGZus{}user}
\end{Verbatim}

\end{fulllineitems}

\index{update\_user() (in module src.cmd.account)}

\begin{fulllineitems}
\phantomsection\label{cmd/account:src.cmd.account.update_user}\pysiglinewithargsret{\code{src.cmd.account.}\bfcode{update\_user}}{\emph{cmd}}{}
The update\_user cmd allows a current user to update user name and password for a user, including their own username and/or password.

This command assumes that MySQL logs are currently disabled and/or in a restricted directory: 
See \href{http://dev.mysql.com/doc/refman/5.1/en/password-logging.html}{http://dev.mysql.com/doc/refman/5.1/en/password-logging.html} for more details.

All users that have access to system are treated as administrators. Any user can update any username or password for all users.

Usage Example:

\begin{Verbatim}[commandchars=\\\{\}]
\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{cchrrd} \PYG{n}{update\PYGZus{}user}
\end{Verbatim}

\end{fulllineitems}



\section{\texttt{activate}}
\label{cmd/activate:module-src.cmd.activate}\label{cmd/activate::doc}\label{cmd/activate:activate}\index{src.cmd.activate (module)}\index{activate() (in module src.cmd.activate)}

\begin{fulllineitems}
\phantomsection\label{cmd/activate:src.cmd.activate.activate}\pysiglinewithargsret{\code{src.cmd.activate.}\bfcode{activate}}{\emph{cmd}}{}
The activate command allows a user to set the current working project.

To illustrate, if example\_project\_1 is the current working project and the user would like to switch to 
example\_project\_2 they would run the following command.

\begin{Verbatim}[commandchars=\\\{\}]
\PYG{g+gp}{\PYGZgt{}\PYGZgt{}\PYGZgt{} }\PYG{n}{cchrrd} \PYG{n}{activate} \PYG{o}{\PYGZhy{}}\PYG{n}{n} \PYG{n}{example\PYGZus{}project\PYGZus{}2}
\PYG{g+go}{example\PYGZus{}project\PYGZus{}2 has been activated and is the current project.}
\end{Verbatim}

\end{fulllineitems}



\section{\texttt{cleanup}}
\label{cmd/cleanup:module-src.cmd.cleanup}\label{cmd/cleanup::doc}\label{cmd/cleanup:cleanup}\index{src.cmd.cleanup (module)}\index{cleanup() (in module src.cmd.cleanup)}

\begin{fulllineitems}
\phantomsection\label{cmd/cleanup:src.cmd.cleanup.cleanup}\pysiglinewithargsret{\code{src.cmd.cleanup.}\bfcode{cleanup}}{\emph{cmd}}{}
\end{fulllineitems}



\section{\texttt{compare}}
\label{cmd/compare:compare}\label{cmd/compare::doc}\label{cmd/compare:module-src.cmd.compare}\index{src.cmd.compare (module)}\index{compare() (in module src.cmd.compare)}

\begin{fulllineitems}
\phantomsection\label{cmd/compare:src.cmd.compare.compare}\pysiglinewithargsret{\code{src.cmd.compare.}\bfcode{compare}}{\emph{cmd}}{}
\end{fulllineitems}



\section{\texttt{convert}}
\label{cmd/convert:module-src.cmd.convert}\label{cmd/convert::doc}\label{cmd/convert:convert}\index{src.cmd.convert (module)}\index{convert() (in module src.cmd.convert)}

\begin{fulllineitems}
\phantomsection\label{cmd/convert:src.cmd.convert.convert}\pysiglinewithargsret{\code{src.cmd.convert.}\bfcode{convert}}{\emph{cmd}}{}
\end{fulllineitems}



\section{\texttt{copy\_rules}}
\label{cmd/copy_rules:module-src.cmd.copy_rules}\label{cmd/copy_rules::doc}\label{cmd/copy_rules:copy-rules}\index{src.cmd.copy\_rules (module)}\index{copy\_rules() (in module src.cmd.copy\_rules)}

\begin{fulllineitems}
\phantomsection\label{cmd/copy_rules:src.cmd.copy_rules.copy_rules}\pysiglinewithargsret{\code{src.cmd.copy\_rules.}\bfcode{copy\_rules}}{\emph{cmd}}{}
\end{fulllineitems}



\section{\texttt{Load Recidivsm Database}}
\label{cmd/load_recid_db:module-src.cmd.load_recid_db}\label{cmd/load_recid_db:load-recidivsm-database}\label{cmd/load_recid_db::doc}\index{src.cmd.load\_recid\_db (module)}\index{load\_recid\_db() (in module src.cmd.load\_recid\_db)}

\begin{fulllineitems}
\phantomsection\label{cmd/load_recid_db:src.cmd.load_recid_db.load_recid_db}\pysiglinewithargsret{\code{src.cmd.load\_recid\_db.}\bfcode{load\_recid\_db}}{\emph{cmd}}{}
\end{fulllineitems}



\section{\texttt{Load Recidivism Flat Files}}
\label{cmd/load_recid_flat:load-recidivism-flat-files}\label{cmd/load_recid_flat::doc}\label{cmd/load_recid_flat:module-src.cmd.load_recid_flat}\index{src.cmd.load\_recid\_flat (module)}\index{load\_recid\_flat() (in module src.cmd.load\_recid\_flat)}

\begin{fulllineitems}
\phantomsection\label{cmd/load_recid_flat:src.cmd.load_recid_flat.load_recid_flat}\pysiglinewithargsret{\code{src.cmd.load\_recid\_flat.}\bfcode{load\_recid\_flat}}{\emph{cmd}}{}
\end{fulllineitems}



\section{\texttt{Load Rules}}
\label{cmd/load_rules:load-rules}\label{cmd/load_rules:module-src.cmd.load_rules}\label{cmd/load_rules::doc}\index{src.cmd.load\_rules (module)}\index{load\_rules() (in module src.cmd.load\_rules)}

\begin{fulllineitems}
\phantomsection\label{cmd/load_rules:src.cmd.load_rules.load_rules}\pysiglinewithargsret{\code{src.cmd.load\_rules.}\bfcode{load\_rules}}{\emph{cmd}}{}
\end{fulllineitems}



\section{\texttt{New Project}}
\label{cmd/new::doc}\label{cmd/new:module-src.cmd.new}\label{cmd/new:new-project}\index{src.cmd.new (module)}\index{new\_project() (in module src.cmd.new)}

\begin{fulllineitems}
\phantomsection\label{cmd/new:src.cmd.new.new_project}\pysiglinewithargsret{\code{src.cmd.new.}\bfcode{new\_project}}{\emph{cmd}}{}
Creates a new project.

@param args: The command line parameters.

As listed under cchrrrd.py new\_project -h the following command line 
parameters are accepted by new\_project.

name: The name of the project.

project\_dir: The path to the top level directory for the BJSConvert output.
\begin{description}
\item[{in\_dir: The path to the directory containing the NLETS raw bar delimited }] \leavevmode
segment files and the spss sample file \emph{(required)}.

\item[{meta\_dir: The path to the directory containing the project metadata files. }] \leavevmode
Default: \textbf{root\_dir}/bjs\_rules/metadata.

\item[{rule\_dir: The path to the directory containing the project rules.}] \leavevmode
Default: \textbf{root\_dir}/bjs\_rules/rules.

\item[{follow\_period: The number of years after the date of release arrest }] \leavevmode
to include in the recidivism database and flat files.

\item[{threads: The number of threads to use when running the recidivism }] \leavevmode
transform phase. Default: 50

\end{description}

cores: The number of cores the system has available to use. Default: 4

verbose: A debug option to set debug logging to verbose. Default: False

host: Name of database host to connect to. Default: localhost.

port: TCP port of MySQL server. Default: standard port (3306).

db\_stand\_name: Name of standardized database. Default: \textbf{project name}

db\_stand\_user: The user to authenticate as. Default: root.

db\_stand\_pass: The password to authenticate with. Default: pass.

db\_recid\_name: Name of recidivism database. Default: {\color{red}\bfseries{}**}project name**\_recid

db\_recid\_user: The user to authenticate as. Default: root.

db\_recid\_pass: The password to authenticate with. Default: pass.

\end{fulllineitems}



\section{\texttt{Run PreProcess Rules}}
\label{cmd/pre_process:run-preprocess-rules}\label{cmd/pre_process::doc}\label{cmd/pre_process:module-src.cmd.pre_process}\index{src.cmd.pre\_process (module)}\index{pre\_process() (in module src.cmd.pre\_process)}

\begin{fulllineitems}
\phantomsection\label{cmd/pre_process:src.cmd.pre_process.pre_process}\pysiglinewithargsret{\code{src.cmd.pre\_process.}\bfcode{pre\_process}}{\emph{cmd}}{}
\end{fulllineitems}



\section{\texttt{Run Process Rules}}
\label{cmd/process:module-src.cmd.process}\label{cmd/process::doc}\label{cmd/process:run-process-rules}\index{src.cmd.process (module)}\index{process() (in module src.cmd.process)}

\begin{fulllineitems}
\phantomsection\label{cmd/process:src.cmd.process.process}\pysiglinewithargsret{\code{src.cmd.process.}\bfcode{process}}{\emph{cmd}}{}
Spawns a process subprocess for segments.

\end{fulllineitems}



\section{\texttt{Stage Data}}
\label{cmd/stage:stage-data}\label{cmd/stage::doc}\label{cmd/stage:module-src.cmd.stage}\index{src.cmd.stage (module)}\index{stage() (in module src.cmd.stage)}

\begin{fulllineitems}
\phantomsection\label{cmd/stage:src.cmd.stage.stage}\pysiglinewithargsret{\code{src.cmd.stage.}\bfcode{stage}}{\emph{cmd}}{}
\end{fulllineitems}



\section{\texttt{Run System Tests}}
\label{cmd/test:module-src.cmd.test}\label{cmd/test:run-system-tests}\label{cmd/test::doc}\index{src.cmd.test (module)}\index{test() (in module src.cmd.test)}

\begin{fulllineitems}
\phantomsection\label{cmd/test:src.cmd.test.test}\pysiglinewithargsret{\code{src.cmd.test.}\bfcode{test}}{\emph{cmd}}{}
\end{fulllineitems}



\section{\texttt{Transform data from Standardized format into Recidivism format}}
\label{cmd/transform::doc}\label{cmd/transform:module-src.cmd.transform}\label{cmd/transform:transform-data-from-standardized-format-into-recidivism-format}\index{src.cmd.transform (module)}\index{transform() (in module src.cmd.transform)}

\begin{fulllineitems}
\phantomsection\label{cmd/transform:src.cmd.transform.transform}\pysiglinewithargsret{\code{src.cmd.transform.}\bfcode{transform}}{\emph{cmd}}{}
\end{fulllineitems}



\section{\texttt{Update Project Metadata}}
\label{cmd/update_metadata:update-project-metadata}\label{cmd/update_metadata::doc}\label{cmd/update_metadata:module-src.cmd.update_metadata}\index{src.cmd.update\_metadata (module)}\index{update\_metadata() (in module src.cmd.update\_metadata)}

\begin{fulllineitems}
\phantomsection\label{cmd/update_metadata:src.cmd.update_metadata.update_metadata}\pysiglinewithargsret{\code{src.cmd.update\_metadata.}\bfcode{update\_metadata}}{\emph{cmd}}{}
\end{fulllineitems}



\section{\texttt{Validate Business Rules}}
\label{cmd/validate_rules:module-src.cmd.validate_rules}\label{cmd/validate_rules:validate-business-rules}\label{cmd/validate_rules::doc}\index{src.cmd.validate\_rules (module)}\index{validate\_rules() (in module src.cmd.validate\_rules)}

\begin{fulllineitems}
\phantomsection\label{cmd/validate_rules:src.cmd.validate_rules.validate_rules}\pysiglinewithargsret{\code{src.cmd.validate\_rules.}\bfcode{validate\_rules}}{\emph{cmd}}{}
\end{fulllineitems}



\renewcommand{\indexname}{Python Module Index}
\begin{theindex}
\def\bigletter#1{{\Large\sffamily#1}\nopagebreak\vspace{1mm}}
\bigletter{s}
\item {\texttt{src.cmd.\_\_init\_\_}}, \pageref{cmd/__init__:module-src.cmd.__init__}
\item {\texttt{src.cmd.account}}, \pageref{cmd/account:module-src.cmd.account}
\item {\texttt{src.cmd.activate}}, \pageref{cmd/activate:module-src.cmd.activate}
\item {\texttt{src.cmd.cleanup}}, \pageref{cmd/cleanup:module-src.cmd.cleanup}
\item {\texttt{src.cmd.compare}}, \pageref{cmd/compare:module-src.cmd.compare}
\item {\texttt{src.cmd.convert}}, \pageref{cmd/convert:module-src.cmd.convert}
\item {\texttt{src.cmd.copy\_rules}}, \pageref{cmd/copy_rules:module-src.cmd.copy_rules}
\item {\texttt{src.cmd.load\_recid\_db}}, \pageref{cmd/load_recid_db:module-src.cmd.load_recid_db}
\item {\texttt{src.cmd.load\_recid\_flat}}, \pageref{cmd/load_recid_flat:module-src.cmd.load_recid_flat}
\item {\texttt{src.cmd.load\_rules}}, \pageref{cmd/load_rules:module-src.cmd.load_rules}
\item {\texttt{src.cmd.new}}, \pageref{cmd/new:module-src.cmd.new}
\item {\texttt{src.cmd.pre\_process}}, \pageref{cmd/pre_process:module-src.cmd.pre_process}
\item {\texttt{src.cmd.process}}, \pageref{cmd/process:module-src.cmd.process}
\item {\texttt{src.cmd.stage}}, \pageref{cmd/stage:module-src.cmd.stage}
\item {\texttt{src.cmd.test}}, \pageref{cmd/test:module-src.cmd.test}
\item {\texttt{src.cmd.transform}}, \pageref{cmd/transform:module-src.cmd.transform}
\item {\texttt{src.cmd.update\_metadata}}, \pageref{cmd/update_metadata:module-src.cmd.update_metadata}
\item {\texttt{src.cmd.validate\_rules}}, \pageref{cmd/validate_rules:module-src.cmd.validate_rules}
\end{theindex}

\renewcommand{\indexname}{Index}
\printindex
\end{document}
