comparison docs/Instructions/Instructions.tex @ 2264:556b79c72eee

Change folder name 'scripts' to 'python'

         		\item \texttt{keygen.php}: generates a unique file name for saved results
             	\item \texttt{pseudo.php}: allows for pseudo-random selection from a range of configuration XML files
 				\item \texttt{save.php}: PHP script to store result XML files to web server
         		\item PHP analysis scripts % ELABORATE
         	\end{itemize}
+         \textbf{Python scripts (\texttt{./python/})}
+        	\begin{itemize}
+        		\item Helpful Python and PHP scripts for extraction and visualisation of data.\\ 
+        	\end{itemize}
         \textbf{Output files (\texttt{./saves/})}
         	\begin{itemize}
         		\item The output XML files of tests will be stored here by default by the \texttt{pythonServer.py} script.\\ 
-        	\end{itemize}
-        \textbf{Auxiliary scripts (\texttt{./scripts/})}
-        	\begin{itemize}
-        		\item Helpful Python and PHP scripts for extraction and visualisation of data.\\ 
         	\end{itemize}
         \textbf{Test creation tool (\texttt{./test\_create/})}
         	\begin{itemize}
         		\item Webpage for easily setting up your own test without having to delve into the XML.\\ 
         	\end{itemize}

 		\item Download the tool (see Section~\ref{sec:installation})
 		\item Copy the tool to a PHP-enabled web server if you have access to one. 
 		\item Go to \path{test_create.html} and configure your test.
 		\item Save your test file in the folder \path{.\tests\}.
 		\item Your test will be live at \path{[web server address]/index.html?url=tests/[testname].xml}. If you are not using a web server, you can simulate one locally by running 
-		\path{scripts/pythonServer.py} (requires Python), after which you can access the test at \\ % hack
+		\path{python/pythonServer.py} (requires Python), after which you can access the test at \\ % hack
 		\path{http://localhost:8000/index.html?url=tests/[testname].xml}
 	\end{itemize}
 
 \clearpage
 

 			
 				\texttt{cd /Users/John/Documents/WebAudioEvaluationToolbox/}
 				
 			Then hit enter and run the Python script by typing
 
-				\texttt{python scripts/pythonServer.py}
+				\texttt{python python/pythonServer.py}
 
 			and hit enter again. See also Figure \ref{fig:terminal}.
 			
 			\begin{figure}[htbp]
 	                \begin{center}

 \section{Analysis and diagnostics}
 	\subsection{In the browser}
 		See `analysis.html' in the main folder: immediate visualisation of (by default) all results in the `saves/' folder. 
 
 	\subsection{Python scripts}
-		The package includes Python (2.7) scripts (in `scripts/') to extract ratings and comments, generate visualisations of ratings and timelines, and produce a fully fledged report. 
+		The package includes Python (2.7) scripts (in `python/') to extract ratings and comments, generate visualisations of ratings and timelines, and produce a fully fledged report. 
 
 		Visualisation requires the free matplotlib toolbox (http://matplotlib.org), numpy and scipy. 
-		By default, the scripts can be run from the `scripts' folder, with the result files in the `saves' folder (the default location where result XMLs are stored). Each script takes the XML file folder as an argument, along with other arguments in some cases.
+		By default, the scripts can be run from the `python' folder, with the result files in the `saves' folder (the default location where result XMLs are stored). Each script takes the XML file folder as an argument, along with other arguments in some cases.
 		Note: to avoid all kinds of problems, please avoid using spaces in file and folder names (this may work on some systems, but others don't like it). 
 
 		\subsubsection{comment\_parser.py}
 			Extracts comments from the output XML files corresponding with the different subjects found in `saves/'. It creates a folder per `audioholder'/page it finds, and stores a CSV file with comments for every `audioelement'/fragment within these respective `audioholders'/pages. In this CSV file, every line corresponds with a subject/output XML file. Depending on the settings, the first column containing the name of the corresponding XML file can be omitted (for anonymisation). 
 			Beware of Excel: sometimes the UTF-8 is not properly imported, leading to problems with special characters in the comments (particularly cumbersome for foreign languages).