Skip to content

Commit

Permalink
DOCUMENTATION: Manual updated for latest release of LMEDS
Browse files Browse the repository at this point in the history
- added schematic
- description of new features
- greater clarification in existing text
  • Loading branch information
timmahrt committed May 17, 2016
1 parent 3defaae commit 3590998
Show file tree
Hide file tree
Showing 11 changed files with 320 additions and 82 deletions.
29 changes: 24 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ LMEDS

.. image:: https://coveralls.io/repos/github/timmahrt/LMEDS/badge.svg?branch=master
:target: https://coveralls.io/github/timmahrt/LMEDS?branch=master

.. image:: https://img.shields.io/badge/license-MIT-blue.svg?
:target: http://opensource.org/licenses/MIT

Expand All @@ -24,6 +24,20 @@ different types of perceptual experiments (memory tasks, AXB-type tasks, etc.).
Major revisions
================

Ver 2.3 (May 17, 2015)

- Video now supported with the same controls and functionality as audio

- User scripts utilities can now be run from a web browser for great ease of use

- Sliding scales are now a supported widget

- New syllable-marking page (branch of prominence-marking pages)

- Experiment participants can now relogin and resume from where they left off

- Integration tests added for greater reliability. Also, numerous bugfixes.

Ver 2.2 (Dec 15, 2015)

- Added support for python 3.x (tested on 3.5)
Expand Down Expand Up @@ -60,9 +74,11 @@ Ver 1.0 (December 04, 2013)
Requirements
==============

``Python 2.7.*`` or above
``Python 2.6.*`` or above

``Python 3.3.*`` or above

``Python 3.5.*`` or above
`Click here to see the specific versions of python that praatIO is tested under <https://travis-ci.org/timmahrt/LMEDS>`_


Usage
Expand Down Expand Up @@ -93,5 +109,8 @@ https://github.com/timmahrt/LMEDS, 2016.
Acknowledgements
================

Development of LMEDS was supported by NSF grant **BCS 12-51343**
to Jennifer Cole, José Hualde, and Caroline Smith.
Development of LMEDS was possible thanks to NSF grant **BCS 12-51343** to
Jennifer Cole, José I. Hualde, and Caroline Smith and to the A*MIDEX project
(n° **ANR-11-IDEX-0001-02**) to James Sneed German funded by the
Investissements d'Avenir French Government program,
managed by the French National Research Agency (ANR).
Binary file modified user_manual/LMEDS_manual.pdf
Binary file not shown.
23 changes: 20 additions & 3 deletions user_manual/LMEDS_manual.tex
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,14 @@
\usepackage{hyperref}
\hypersetup{colorlinks=true, linkcolor=red}
\usepackage[most]{tcolorbox}
%\usepackage{minipage}

\setmainfont{Times New Roman}

\title{LMEDS 2.1 Instruction Manual}
\title{LMEDS 2.3 Instruction Manual}
\titlehead{\centering\includegraphics{lmedslogo}}
\author{Tim Mahrt}
\date{November 11, 2015}
\date{May 17, 2016}


\renewcommand\thesection{\arabic{section}}
Expand All @@ -41,8 +42,14 @@

\vspace{5mm}

Stefan Baumann

Jennifer Cole

Núria Esteve Gibert

Martine Grice

Jonathan Howell

José I. Hualde
Expand All @@ -51,6 +58,8 @@

Preethi Jyothi

Janina Kalbertodt

Amelia Kimball

Caroline Smith
Expand All @@ -63,7 +72,15 @@

\begin{tcolorbox}[breakable,colback=white,colframe=green,width=\dimexpr\textwidth+12mm\relax,enlarge left by=-6mm]

\textbf{Development of LMEDS was supported by NSF grant BCS 12-51343 to Jennifer Cole, José Hualde, and Caroline Smith.}
\textbf{Development of LMEDS was possible thanks to }
\begin{itemize}
\item NSF grant BCS 12-51343 to
Jennifer Cole, José I. Hualde, and Caroline Smith
\item A*MIDEX project
(n° ANR-11-IDEX-0001-02) to James Sneed German funded by the
Investissements d'Avenir French Government program,
managed by the French National Research Agency (ANR).
\end{itemize}

\end{tcolorbox}

Expand Down
Binary file added user_manual/lmedsSchematic.pdf
Binary file not shown.
1 change: 1 addition & 0 deletions user_manual/lmedsSchematic.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<mxfile userAgent="Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/50.0.2661.102 Safari/537.36" version="5.5.0.1" editor="www.draw.io" type="device"><diagram>7Vvdk+I2DP9rdqZ9uA4hwHKP7Gcf2k6nO/24J8Yk3sS3Ic45zsL2rz/ZlhMHAmWKNwc38EIiy1+SfpIszFV4u1w/ClKkv/KYZlfDQby+Cu+uhsNgFA7gS1HeDGU6HhtCIliMTA3hif1LkYj9korFtGwxSs4zyYo2MeJ5TiPZohEh+KrN9syz9qwFSeyMDeEpItk29W8Wy9RQx9NRQ/+ZsiTFmafDiWlYkOglEbzKcbqrYfisP6Z5SexQuM8yJTFfOaTwHsQqOIeB1dNyfUszJVorNdPvYUdrvWxBc1za/g4htOl1yDe7dRqDJPCVC5nyhOcku2+oN3p/VI0wgLdULjN4DOCRrpn8R5F/GuPbJ9uSS/Gmm+yLajF8n6mUb2gCpJIcSM28v3Be4BilFPylVkcIlGeey1uecaFXHk4f4KMmKDLC8g+LrKJmd2pLOwWEpJJXIkIu1LIkIqHIpc0XZfhI+ZLCFoBF0IxI9toenaDxJTUfdp0JQVQvy1BwlsvSGfl3RQAGxNEEB0QQfWzpEh7MePbNWVhD0vru1j3u8pUoOaG1TjLYr5arBpcV7eRLpSzyBoQ80B+XNEnU962gRIK8ByX9UtEcRAmwY2AvOCasxgxr2LfMrjEqpetVyiR9KojWyAp8TNvQ9iteqGFuYPLM4XmY3j3c3QE9ESRmoH2n7X72cTid1qt6pUJS68p2GMy2KWAHxe7ozDq0VeNFrqeGlDoOZIxsXabjKHyvPnHY94by6cEVQ4sL1+sj4XqozHFqTxh6pDkVBkUZyZNKBSmIoSySDISrd7BiIE7l1M0sC9s1wa5z23HudqshWPPDGFVJxbyMBCsUKvsGaSIozT3gLdgA3GQbcEMl603EWb5jtB9YY/QKOfvcRMg6etah9JSjp8beCUTP0DpVtIzhwKC1zoX+g99zuLUpomf//P0Zy8eefDdO7cl3/1nExnPLtCsLCh8O9rEpXy4q2Ndx/vUNNgsnCw8OdoKCshmNhYnjYQOb5rgetiYeo6TwfVCz54DSgEjj5iRRoyHSRk3wTXzsdTv4Dq83jpsb7MF0wyW3+Y/2sSgXT5CexbESRVEIXgiG6KZrNc4zjAJqI5FKxpxcbUFZnpjcCvqecVLVhvw15rku5G0Jw3dSFaK7uSDeRXwQngrkR1bxJ4J5KxmvoIeiIi1Lc+QSFBVhQjmIZvADWwLe4QlWN5CC5OYYhQRSxYzDsl+hhgnftpdqojL68ZtVRPZVPnZVSzw4k9B6hd0lkU5ngvn3Uc6krrNekm7XmXQUOI92Jgcfmv3WHf8AdGawPJigLCuFs7ONuptACfHA2kvYDTB3uoTdFlI6aouBLrT2gRS/1cW/SMbwjErXBRVsqXau1k3gZzr1A5t6qcCSd1YZ7al2HqU0etlTV1RiPPfKoo0/NRo74pbNbVw0Yn5zXNzqu7K4gcbTLPQb5G2gUYeTHtA4xDyzt1TiPBxkh0pMRb4PB4mTe3KQ93BxQKj0XtACxKpO8IOFWvj/8YNnXPCzCTo6vlGX4xu9V8HP/qTWn+c7h4zd/sjVgllvng8n95Wx6xSjrBaf4ebOOefrG4WQ8aEHWx/puufbG7MEhJKY5BDqHVWmFLMzDSx4KedQFVU1knnN/l0ng3VWt0fZdWXDu7J9xTlHyJaoBvhQal83AwaQyXrbPLYs4Dc4K3Tp+zD96iJ6S4nGk1o15jxXXt2tSSEJjjBJDq8RqA0MK7xRSmVwb2+GDUsWxzokdFkNB+5nFSTDuxT4wDB2m48Hm5m2q+ijDpPpCqP27uRRFuPrl5CLxfRpMYG9j2lLpR23Wd7LZOwYp2Myn1rVvIvN7IhMm+X1Dpuxt6+92wyu9mIzZ2YzIzSIPaHJk83Aa3Od3fy81/xlILz/Cg==</diagram></mxfile>
23 changes: 23 additions & 0 deletions user_manual/manual_change_history.tex
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@
\section{LMEDS change history}
%%%%%%%%%%%%%%%%%%%%%

May 17, 2016 - LMEDS 2.3

\begin{itemize}
\item Video now supported with the same controls and functionality as audio
\item User script utilities can now be run from a web browser for greater ease of use
\item Pages can now have sliding scales
\item New syllable-marking page (branch of prominence-marking pages)
\item Experiment participants can now relogin and resume from where they left off (if enabled by the experimenter)
\item Integration tests added for greater reliability. Also, numerous bugfixes.
\end{itemize}

December 15, 2015 - LMEDS 2.2

\begin{itemize}
\item Added support for python 3.x (tested on 3.5)
\end{itemize}

September 2015 - LMEDS 2.1

\begin{itemize}
Expand Down Expand Up @@ -43,6 +60,12 @@ \section{LMEDS change history}

\section{LMEDS manual change history}

May 17, 2016

\begin{quote}
Updated the manual to be in line with changes from LMEDS 2.2 and 2.3. Added the workflow schematic. Clarified other parts of text.
\end{quote}

November 11, 2015

\begin{quote}
Expand Down
Loading

0 comments on commit 3590998

Please sign in to comment.