This repository contains the Open edX platform release "hotfix-2016-03-17" with ANALYSE module.

ANALYSE is learning analytics tool developed for Open edX. This is a beta release which extends the learning analytics functionality of Open edX with 12 new visualizations. A new tab has been addded in the course dashboard to access ANALYSE. Some of the features are the next:

• The learning analytics dashboard has 3 visualizations related to exercises, 4 related to videos and 4 related to general course activity
• The instructors of a course can access the information about the aggregate of all students in a course an also each student individually. That allows instructor to keep track about how the course is progressing and control each student separately
• The students in a course can access their own information only which can be used for self-awareness and reflect on their learning process
• The different indicators are processed in background in regular intervals of time as schedule jobs by the use of Celery Beat

For more information you can visit ANALYSE

• In this version, we have solved several bugs in the metrics, e.g. we have corrected the visualizations when the data are null and we have adapted the code to release Cypress and Dogwood.
• Now, the scalability of the module is improved, making a distinction between new events and already processed events. The code is executed only when there are new events, instead of taking into account all events (old and new).
• In addition, we have improved scalability in different charts to avoid overlap of different values.
• We have used two palette with 6 primary colors, one for course activity and video activity and another for video events.

For the installation of ANALYSE, you have two options:

• Option 1: Use this full repository of Open edX which has the both the "hotfix-2016-03-17" release and ANALYSE module.


• Option 2: Take ANALYSE code and insert it in a different Open edX release. The ANALYSE tool has been tested in the last two releases: Cypress and Dogwood. We have not tested it in other releases and there is no warranty for the program.

The functionality of ANALYSE has been added as a new django application. If you want to add ANALYSE in Open edX in your Open edX release, you have to add different files and folders of this repository:
• /lms/djangoapps/learning_analytics/
• /lms/static/js/learning_analytics/
• /lms/static/sass/course/learning_analytics/
• /lms/templates/learning_analytics/
• /lms/envs/devstack_analytics.py

Moreover, you have to rewrite the files from Open edX that has been modified to introduce ANALYSE (you can compare your files with the repository, with diff) :
• /setup.py: Add the line "learning_analytics = lms.djangoapps.courseware.tabs:LATab"
• /lms/djangoapps/courseware/tabs.py: Add class LATab(CourseTab)
• /common/lib/xmodule/xmodule/tabs.py: Add the line "(CourseTab.load('learning_analytics'),)"
• /lms/static/sass/_build-course.scss: Add the line with the import of learning analytics
• /lms/urls.py: Add the if with the comment, # Learning analytics module if is enabled
• /common/djangoapps/track/backends/django.py: Add the import timezone and the line tldat.time = timezone.now()

Finally, you have to modify a file of configurartion because edX doesn't actually use the MySQL tracking backend:
• /edx/app/edxapp/lms.auth.json . You can use sudo nano /edx/app/edxapp/lms.auth.json and then add the next lines:
  
  - "TRACKING_BACKENDS": { "sql": { "ENGINE": "track.backends.django.DjangoBackend" } },
  
  - "EVENT_TRACKING_BACKENDS": { "sql": { "ENGINE": "track.backends.django.DjangoBackend" } },
  You can add this code between the lines ' "CREDIT_PROVIDER_SECRET_KEYS": {}, ' and ' "DATABASES": { ' .


You have to migrate the tables of MySQL with:
./manage.py lms makemigrations learning_analytics --settings=devstack_analytics
./manage.py lms migrate learning_analytics --settings=devstack_analytics

If your new tab isn't showing up, try the following:
sudo su edxapp
pip install -e /edx/app/edxapp/edx-platform

Moreover, if you want put the module in a course created before, you have to export the course and modify:
policies/folder/policy.json, add: "name":"learning_analytics" and "type":"learning_analytics".

In order for the high level indicators to be calculated, we will not be doing it in real time as it would mean a lot of processing and extremely high amounts of data managing, and it would slow down the platform. We compute them using the Celery Beat scheduler, which starts task at regular intervals. We will use this tool so as to calculate every indicator in the module every 30 seconds. Celery Beat needs to be activated and configured so that it run the task which updates the indicators in background.

Note: If you install the module in mode of OpenedX Fullstack, you need install google-api-python-client and add the content of devstack_analytics.py in aws.py, in the end.

The code in this repository is licensed under version 3 of the AGPL unless otherwise noted. Please see the LICENSE file for details with. The next additional term should be also taken into account:

• Required to preserve the author attributions on the new added work for the development of ANALYSE

If you're having trouble with the installation or how to use ANALYSE feel free to contact and we will do our best to help you out.

If you are interested in contributing to the development of ANALYSE we will be happy to help. For bug solving changes feel free to send a pull request. In case you would like to make a major change or to develop new functionality, please contact before starting your development, so that we can find the best way to make it work.

ANALYSE has been developed in the Gradient lab, which is the e-learning laboratory inside the GAST group, as a part of the Department of Telematic Engineering, at the University Carlos III of Madrid (Spain). The main people involved in the design and implementation of this tool have been the following:

• José Antonio Gascón Pinedo - Universidad Carlos III de Madrid - jgascon@pa.uc3m.es
• José Antonio Ruipérez Valiente - IMDEA Networks Institute and Universidad Carlos III de Madrid- jruipere@it.uc3m.es
• Pedro Jose Muñoz Merino - Universidad Carlos III de Madrid - pedmume@it.uc3m.es
• Héctor Javier Pijeira Díaz - Universidad Carlos III de Madrid (by implementing his Final Year Project)
• Javier Santofimia Ruiz - Universidad Carlos III de Madrid (by implementing his Final Year Project)
• Javier Ignacio Orcoyen Chaves - Universidad Carlos III de Madrid (by implementing his Final Year Project)
• Carlos Delgado Kloos - Universidad Carlos III de Madrid

• The "eMadrid" project (Regional Government of Madrid) under grant S2013/ICE-2715
• The RESET project (Ministry of Economy and Competiveness) under grant TIN2014-53199-C3-1-R