LWTools 1.0.2

Tool for LMT data analysis

LMT Widget Tool (LWT)

LMT Widget Tool is as tool for the Live Mouse Tracker (LMT) data analysis for users without programming experience.

You will find more information about LMT on its website and publication.

In our tool, we use the LMT-Analysis v1.0.5 with few changes in files for our tool to work.

1. Download

First of all, you will need to download the folder which contains all of the files to run the tool:



First of all, move the zipped folder on your desktop. Once it's done, make sure to unzip the zipped folder you just download (download 7-Zip for free to unzip zipped folders if you don't have it already on your computer).
To unzip, you have to do a right-click on the folder, then click on "7-Zip" and "Extract here". If you are using a Windows 11 version, do a right-click on the zipped folder, then click on "Show more options", then "7-Zip" and "Extract here".

2. Installation

2.1. Python

To make the tool work, you will need a specific version of Python. Download the 3.10 Python version here. Go down until the 'Files' section and install 'Windows installer (64-bit)' (64-bit is recommended but if your computer is on a 32-bit OS you should download the 32-bit version).



Then, execute the .exe file you just downloaded.

:warning: WARNING

During the installation, make sure to check the box "Add python.exe to PATH" and click on "Install now" until Python is installed:

2.2. Jupyter Lab

Once you have installed Python, open your command prompt. To open the command prompt, press the keys Windows + R, then type "cmd" and press Enter. Here, put the following command :

pip install jupyterlab==3.5.0

2.3. Python Requirements (See requirements.txt)

Here is a visualisation of the packages that will be downloaded later :

• lxml==4.9.1
• affine==2.3.1
• networkx==2.8.5
• matplotlib==3.5.2
• pandas==1.4.3
• seaborn==0.11.2
• dabest==2023.2.14
• statsmodels==0.13.2
• tabulate==0.8.10
• ipywidgets==8.0.3

In your command prompt, you need to change your directory path to install these packages. To do that, you have to copy the path of the downloaded folder into (e.g. : C:\Users\guest\Desktop\LMT_Widget_Tool-LWT-main) and paste the path you just copied in your command prompt (yes, there is a space between 'cd' and your pasted path):

cd paste\your\path\here

Then, to install all the packages from the previous list in your command prompt, do it with the command:

pip install -r requirements.txt

3. Launch Jupyter Lab

Each time you want to launch Jupyter Lab, you will have to open you command prompt and use the following command :

jupyter lab

4. Launch the tool

Once Jupyter Lab is launched, open the folder '...\LMT_Widget_Tool-LWT-main\scripts' in Jupter Lab and open the file :

LMT_Widget_Tool.ipynb

:warning: WARNING

Before using the tool, make sure to restart the kernel to clear it :



Sometimes you will need to restart the kernel when it seems that the tool crashed, but don’t do it when it’s running !

First, you will have to execute the first cell code to install the packages for the tool. Once all the packages are installed, close JupyterLab and close the Kernel by pressing the keys "Ctrl + C" inside of your command prompt. Then restart JupyterLab in your command prompt using :

jupyter lab

Here you can enjoy the analysis !

Order for analysis

Rebuild databases and convert into csv files

The first part will rebuild the databases by deleting the data and rebuild them using the detections and export these data into csv files. It is recommanded to do timebins of 5 or 10 minutes for each bin

:warning: Warning

The second part is optional. It is usefull only if you want to convert your data into csv using different timebins. So be careful with this code cell, use it only if you want to change the timebins of your data.

The third part will merge the csv files created into one csv file which will be used by the tool for the analysis.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

LMT_Widget_Tool is released under the GNU GPL v3.0 licence. See the LICENSE file.

Copyright (C) 2023 IGF - CNRS - INSERM - Université de Montpellier

LMT_Widget_Tool uses the LMT-analysis code provided on GitHub. This code is also under the GNU GPL v3.0 licence. GNU GPL ?