<commit_before>%%This is a very basic article template.
%%There is just one section and two subsections.
%--------------------------------------------------
\documentclass[letterpaper]{report}  
%--------------------------------------------------
%Packeges 
%--------------------------------------------------
\usepackage[english]{babel}
\usepackage{amsmath,amssymb,amsfonts} % Typical maths resource packages
\usepackage[dvips]{graphicx}
\usepackage{color}                    % For creating coloured text and background
\usepackage{fancyhdr}                 % For inclusion of title at the top of the page
\usepackage[left=3cm,right=1.5 cm,top=2cm,bottom=2cm,bindingoffset=0cm]{geometry}
\usepackage[explicit]{titlesec}
\usepackage{setspace}
\usepackage{pdfpages}
\usepackage{cite} 
\usepackage{float} 
\usepackage{newclude}
\usepackage{bookmark}
\usepackage{listings}
\usepackage{tikz}
\usepackage{type1cm}
\usepackage{textcomp}
\usepackage{hyperref}                  % For creating hyperlinks in cross
\usetikzlibrary{fit}
   
\definecolor{mygreen}{RGB}{28,172,0} % color values Red, Green, Blue
\definecolor{mylilas}{RGB}{170,55,241}
\definecolor{grey}{rgb}{0.97,0.97,0.97}
\newcommand*\chapterlabel{}
\makeatletter
\def\@makechapterhead#1{%
  \vspace*{10\p@}%
  {\parindent \z@ \centering \reset@font
        \par\nobreak
        \vspace*{2\p@}%
        {\Huge \bfseries \thechapter\quad #1\par\nobreak}
        \par\nobreak
        \vspace*{2\p@}%
    \vskip 40\p@
    %\vskip 100\p@
  }}
\def\@makeschapterhead#1{%
  \vspace*{10\p@}%
  {\parindent \z@ \centering \reset@font
        \par\nobreak
        \vspace*{2\p@}%
        {\Huge \bfseries #1\par\nobreak}
        \par\nobreak
        \vspace*{2\p@}%
    \vskip 100\p@
    %\vskip 100\p@
  }}
\makeatother

\newcounter{N}
\setlength{\parindent}{0ex}
\setlength{\parskip}{1em}

\lstset{language=Matlab,
basicstyle=\footnotesize\ttfamily,
basewidth=0.5em,
morekeywords={matlab2tikz},
keywordstyle=\color{blue},%
morekeywords=[2]{1}, keywordstyle=[2]{\color{black}},
identifierstyle=\color{black},%
stringstyle=\color{mylilas},
commentstyle=\color{mygreen},%
numbers=none,
numberstyle=\tiny\color{black},
stepnumber=2, 
numbersep=10pt,
tabsize=4,
aboveskip=3mm,
belowskip=3mm,
backgroundcolor=\color{grey},
frame=none,
showspaces=false,
showstringspaces=false,
breaklines=true}

\begin{document}
\begin{titlepage}
\begin{center}
\vspace{5cm}
{\bfseries\href{https://www.portfolioeffect.com}{www.portfolioeffect.com} \\
High Frequency Portfolio Analytics\\}
\vspace{8cm}
{\Large \bfseries User Manual \\}
\vspace{0.3cm}
{\Huge\bfseries PortfolioEffect Toolbox \\ for MATLAB \\ }
% ----------------------------------------------------------------
\vspace{1.5cm}
{<NAME> \\ <EMAIL>} \\[14pt]
 % ----------------------------------------------------------------
\vfill
\emph{{Released Under GPL-3 License\\ by Snowfall Systems,
Inc.}}\\[2cm]
{August 20, 2015}
\end{center}
\end{titlepage}

\bookmarksetup{startatroot}
\cleardoublepage
\phantomsection
\addcontentsline{toc}{chapter}{Contents}
\bibliographystyle{amsplain}%}
\renewcommand{\bibname}{Contents}
\tableofcontents 

\chapter{Toolbox Installation}
PortfolioEffect client for MATLAB is provided as a zip archive for all types of
operating systems and as a self-install executable file for Windows. 

\section{Zip Archive (All OS)}
Download zip archive with a toolbox from
PortfolioEfect
\href{https://www.portfolioeffect.com/docs/platform/quant/downloads}{downloads}
or MATLAB Central
\href{http://www.mathworks.com/matlabcentral/fileexchange}{File Exchange}.

Once downloaded, unpack archive into the folder and add it to
MATLAB's path using ``Set Path'' menu. Then call any method of the package in
MATLAB editor to continue with the set-up:
\begin{lstlisting}
+++++++++++++++++++++++++++++++++++++++++++++++++
Welcome to PortfolioEffect Quant Toolbox.

Setup will download required binary files (~5mb).
Please, wait...
SUCCESS. File downloaded to: 
/home/appadmin/.matlab/R2015a/ice9-quant-client-1.0-allinone.jar
Updating java class path file...
SUCCESS. Java class path updated.

Setup complete! Restart Matlab session now.
+++++++++++++++++++++++++++++++++++++++++++++++++
\end{lstlisting}

Restart MATLAB to complete PortfolioEffect toolbox set-up.

\section{Install Wizard (Windows)}
Download self-installer for Windows from PortfolioEfect
\href{https://www.portfolioeffect.com/docs/platform/quant/downloads}{downloads}.
Follow the installation instructions. Once the wizard completes, add the
installation folder to MATLAB's path using ``Set Path'' menu. 
The PortfolioEffect toolbox is now fully configured.

\chapter{Account Credentials}
All portfolio computations are performed on PortfolioEffect cloud servers.
To obtain a free non-professional account, you need to follow a quick sign-up
process on our website:
\href{https://www.portfolioeffect.com/registration}{www.portfolioeffect.com/registration}.\par
Please use a valid sign-up address - it will be used to email your
account activation link.

\section{Locate API Credentials} 
Log in to you account and locate your API credentials on the main page

\includegraphics[width=5in]{img/api-settings.png}
 
\section{Set API Credentials in MATLAB} <commit_msg>Fixed graphics size<commit_after>%%This is a very basic article template.
%%There is just one section and two subsections.
%--------------------------------------------------
\documentclass[letterpaper]{report}  
%--------------------------------------------------
%Packeges 
%--------------------------------------------------
\usepackage[english]{babel}
\usepackage{amsmath,amssymb,amsfonts} % Typical maths resource packages
\usepackage[dvips]{graphicx}
\usepackage{color}                    % For creating coloured text and background
\usepackage{fancyhdr}                 % For inclusion of title at the top of the page
\usepackage[left=3cm,right=1.5 cm,top=2cm,bottom=2cm,bindingoffset=0cm]{geometry}
\usepackage[explicit]{titlesec}
\usepackage{setspace}
\usepackage{pdfpages}
\usepackage{cite} 
\usepackage{float} 
\usepackage{newclude}
\usepackage{bookmark}
\usepackage{listings}
\usepackage{tikz}
\usepackage{type1cm}
\usepackage{textcomp}
\usepackage{hyperref}                  % For creating hyperlinks in cross
\usetikzlibrary{fit}
   
\definecolor{mygreen}{RGB}{28,172,0} % color values Red, Green, Blue
\definecolor{mylilas}{RGB}{170,55,241}
\definecolor{grey}{rgb}{0.97,0.97,0.97}
\newcommand*\chapterlabel{}
\makeatletter
\def\@makechapterhead#1{%
  \vspace*{10\p@}%
  {\parindent \z@ \centering \reset@font
        \par\nobreak
        \vspace*{2\p@}%
        {\Huge \bfseries \thechapter\quad #1\par\nobreak}
        \par\nobreak
        \vspace*{2\p@}%
    \vskip 40\p@
    %\vskip 100\p@
  }}
\def\@makeschapterhead#1{%
  \vspace*{10\p@}%
  {\parindent \z@ \centering \reset@font
        \par\nobreak
        \vspace*{2\p@}%
        {\Huge \bfseries #1\par\nobreak}
        \par\nobreak
        \vspace*{2\p@}%
    \vskip 100\p@
    %\vskip 100\p@
  }}
\makeatother

\newcounter{N}
\setlength{\parindent}{0ex}
\setlength{\parskip}{1em}

\lstset{language=Matlab,
basicstyle=\footnotesize\ttfamily,
basewidth=0.5em,
morekeywords={matlab2tikz},
keywordstyle=\color{blue},%
morekeywords=[2]{1}, keywordstyle=[2]{\color{black}},
identifierstyle=\color{black},%
stringstyle=\color{mylilas},
commentstyle=\color{mygreen},%
numbers=none,
numberstyle=\tiny\color{black},
stepnumber=2, 
numbersep=10pt,
tabsize=4,
aboveskip=3mm,
belowskip=3mm,
backgroundcolor=\color{grey},
frame=none,
showspaces=false,
showstringspaces=false,
breaklines=true}

\begin{document}
\begin{titlepage}
\begin{center}
\vspace{5cm}
{\bfseries\href{https://www.portfolioeffect.com}{www.portfolioeffect.com} \\
High Frequency Portfolio Analytics\\}
\vspace{8cm}
{\Large \bfseries User Manual \\}
\vspace{0.3cm}
{\Huge\bfseries PortfolioEffect Toolbox \\ for MATLAB \\ }
% ----------------------------------------------------------------
\vspace{1.5cm}
{<NAME> \\ <EMAIL>} \\[14pt]
 % ----------------------------------------------------------------
\vfill
\emph{{Released Under GPL-3 License\\ by Snowfall Systems,
Inc.}}\\[2cm]
{August 20, 2015}
\end{center}
\end{titlepage}

\bookmarksetup{startatroot}
\cleardoublepage
\phantomsection
\addcontentsline{toc}{chapter}{Contents}
\bibliographystyle{amsplain}%}
\renewcommand{\bibname}{Contents}
\tableofcontents 

\chapter{Toolbox Installation}
PortfolioEffect client for MATLAB is provided as a zip archive for all types of
operating systems and as a self-install executable file for Windows. 

\section{Zip Archive (All OS)}
Download zip archive with a toolbox from
PortfolioEfect
\href{https://www.portfolioeffect.com/docs/platform/quant/downloads}{downloads}
or MATLAB Central
\href{http://www.mathworks.com/matlabcentral/fileexchange}{File Exchange}.

Once downloaded, unpack archive into the folder and add it to
MATLAB's path using ``Set Path'' menu. Then call any method of the package in
MATLAB editor to continue with the set-up:
\begin{lstlisting}
+++++++++++++++++++++++++++++++++++++++++++++++++
Welcome to PortfolioEffect Quant Toolbox.

Setup will download required binary files (~5mb).
Please, wait...
SUCCESS. File downloaded to: 
/home/appadmin/.matlab/R2015a/ice9-quant-client-1.0-allinone.jar
Updating java class path file...
SUCCESS. Java class path updated.

Setup complete! Restart Matlab session now.
+++++++++++++++++++++++++++++++++++++++++++++++++
\end{lstlisting}

Restart MATLAB to complete PortfolioEffect toolbox set-up.

\section{Install Wizard (Windows)}
Download self-installer for Windows from PortfolioEfect
\href{https://www.portfolioeffect.com/docs/platform/quant/downloads}{downloads}.
Follow the installation instructions. Once the wizard completes, add the
installation folder to MATLAB's path using ``Set Path'' menu. 
The PortfolioEffect toolbox is now fully configured.

\chapter{Account Credentials}
All portfolio computations are performed on PortfolioEffect cloud servers.
To obtain a free non-professional account, you need to follow a quick sign-up
process on our website:
\href{https://www.portfolioeffect.com/registration}{www.portfolioeffect.com/registration}.\par
Please use a valid sign-up address - it will be used to email your
account activation link.

\section{Locate API Credentials} 
Log in to you account and locate your API credentials on the main page

\includegraphics[width=5in,natwidth=768,natheight=300]{img/api-settings.png}
 
\section{Set API Credentials in MATLAB} 
{'fraction_non_alphanumeric': 0.19038553069966682, 'fraction_numerical': 0.018086625416468348, 'mean_word_length': 3.6099166301009213, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 8, 'lorem ipsum': 0, 'www.': 14, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 18, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5393665', 'n_tokens_mistral': 3458, 'n_tokens_neox': 3178, 'n_words': 806}