README.md modifications; Added requirements.txt

README.md

@@ -1,3 +1,22 @@
-# motor_evoked_potentials
+# Motor evoked potentials for multiple sclerosis: A multiyear follow-up dataset.
 
-Motor evoked potentials for multiple sclerosis: A multiyear follow-up dataset.
+# Introduction
+This dataset contains Motor Evoked Potential measurements, performed on Multiple Sclerosis patients. The dataset descriptor can be found at:
+[TODO]().
+
+# Usage
+
+## Structure
+The dataset itself is stored in [mep_dataset.zip](mep_dataset.zip). The general structures is as follows:
+
+* __patient.csv:__ Contains the records for the various patients.
+* __visit.csv:__ Contains the records for the various visits.
+* __test.csv:__ Contains the records for the various tests.
+* __measurement.csv:__ Contains the records for the various measurements.
+* __edss.csv:__ Contains the records for the various edss measurements.
+
+More details about specifics fields can be found in the dataset descriptor.
+
+## Getting started
+It is highly recommended to have a look at the included [jupyter notebook](sample_use_case.ipynb) to familiarize oneself with the dataset.
+It includes a sample use case and goes over how to work with the dataset.

requirements.txt

@@ -0,0 +1,74 @@
+argon2-cffi==20.1.0
+async-generator==1.10
+attrs==20.3.0
+backcall==0.2.0
+bleach==3.3.0
+certifi==2020.12.5
+cffi==1.14.5
+cycler==0.10.0
+decorator==4.4.2
+defusedxml==0.6.0
+entrypoints==0.3
+importlib-metadata==2.0.0
+ipykernel==5.3.4
+ipython==7.21.0
+ipython-genutils==0.2.0
+ipywidgets==7.6.3
+jedi==0.17.2
+Jinja2==2.11.3
+joblib==1.0.1
+jsonschema==3.2.0
+jupyter==1.0.0
+jupyter-client==6.1.7
+jupyter-console==6.2.0
+jupyter-core==4.7.1
+jupyterlab-pygments==0.1.2
+jupyterlab-widgets==1.0.0
+kiwisolver==1.3.1
+MarkupSafe==1.1.1
+matplotlib==3.3.4
+mistune==0.8.4
+nbclient==0.5.3
+nbconvert==6.0.7
+nbformat==5.1.2
+nest-asyncio==1.5.1
+notebook==6.2.0
+numpy==1.19.2
+olefile==0.46
+packaging==20.9
+pandas==1.2.2
+pandocfilters==1.4.3
+parso==0.7.0
+pexpect==4.8.0
+pickleshare==0.7.5
+Pillow==8.1.0
+pip==21.0.1
+prometheus-client==0.9.0
+prompt-toolkit==3.0.8
+ptyprocess==0.7.0
+pycparser==2.20
+Pygments==2.8.0
+pyparsing==2.4.7
+pyrsistent==0.17.3
+python-dateutil==2.8.1
+pytz==2021.1
+pyzmq==20.0.0
+qtconsole==5.0.2
+QtPy==1.9.0
+scikit-learn==0.24.1
+scipy==1.6.1
+Send2Trash==1.5.0
+setuptools==52.0.0.post20210125
+sip==4.19.13
+six==1.15.0
+terminado==0.9.2
+testpath==0.4.4
+threadpoolctl==2.1.0
+tornado==6.1
+tqdm==4.56.0
+traitlets==5.0.5
+wcwidth==0.2.5
+webencodings==0.5.1
+wheel==0.36.2
+widgetsnbextension==3.5.1
+zipp==3.4.0