Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Translation software.rst #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Translation software.rst #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 26 additions & 18 deletions docs/Translation software.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,44 +18,52 @@ Step 1: Installing the required packages or downloading a VM
**************************************

* Option 1: To run the software you may want to download a VM from Amazon cloud.

This virtual machine image comes with all
packages installed required to run the MOOCdb pipeline. To get a link to the image and request the pem file, please email
[email protected].

.. important::

* When instantiating this virtual machine on Amazon or locally, please provision the disk space (hard disk)
such that there is atlease three times the size of the decrypted- uncompressed file size of the tracking logs.

* When instantiating this virtual machine on Amazon or locally, please provision the disk space (hard disk)
such that there is atlease three times the size of the decrypted- uncompressed file size of the tracking logs.
* Option 2: Install all the packages on your local machine

The following packages are required on a MOOCdb machine

#. Install ``Unidecode`` package available at
#. Install **Unidecode** package available at

#. Install **ijson** package available at

#. Install ``ijson`` package available at
#. Install **python-setuptools**

#. Install ``python-setuptools``
#. Install **pip** using **sudo easy_install pip**

#. Install ``pip`` using
#. Install **pandas**

``sudo easy_install pip``
#. Install ``pandas``
* Make sure your Pandas version is higher than ``0.14.0``. If it is below that you would have to update Pandas by running
* Make sure your Pandas version is higher than **0.14.0**. If it is below that you would have to update Pandas by running

``pip install pandas --upgrade``
**pip install pandas --upgrade**

* You may have to upgrade ``numpy`` and ``numexpr`` before upgrading ``pandas`` if upgrading ``pandas`` gives you an error.
* You may have to upgrade **numpy** and **numexpr** before upgrading **pandas** if upgrading **pandas** gives you an error.
The command to upgrade numpy and numexpr is the same

``pip install numpy --upgrade``
**pip install numpy --upgrade**

``pip install numexpr --upgrade``
**pip install numexpr --upgrade**

#. Download the code from MOOCdb github:
*``https://github.com/MOOCdb/Translation_software/tree/master/edx_to_MOOCdb_piping/import.openedx.diagnosis``

*``https://github.com/MOOCdb/Translation_software/tree/master/edx_to_MOOCdb_piping/import.openedx.apipe``

`Openedx diagnosis`_

*``https://github.com/MOOCdb/Translation_software/tree/master/edx_to_MOOCdb_piping/import.openedx.qpipe``
`Openedx apipe`_

`Openedx qpipe`_

.. _openedx diagnosis: https://github.com/MOOCdb/Translation_software/tree/master/edx_to_MOOCdb_piping/import.openedx.diagnosis
.. _openedx apipe: https://github.com/MOOCdb/Translation_software/tree/master/edx_to_MOOCdb_piping/import.openedx.apipe
.. _openedx qpipe: https://github.com/MOOCdb/Translation_software/tree/master/edx_to_MOOCdb_piping/import.openedx.qpipe
**************************************
Step 2: Processing the tracking logs
**************************************
Expand Down Expand Up @@ -89,7 +97,7 @@ and contains the detailed clickstream events. These are the events which are rec
* - <course name>_users.csv
- csv
- PII information + meta information like date_joined, last login etc
* - <course name>__course_structure-prod-analytics.json
* - <course name>__couinrse_structure-prod-analytics.json
- JSON
- Course structure in JSON
* - <course name>_wiki_article.csv
Expand Down