Browse Source

Updated README

Updated README to include some guidelines for the use of the new Excel file.
Jan Yperman 2 years ago
parent
commit
bfba8748a7
1 changed files with 9 additions and 0 deletions
  1. 9 0
      README.md

+ 9 - 0
README.md

@@ -43,6 +43,8 @@ Besides these files the dataset also contains textfiles for each of the actual t
 More details about specifics fields can be found in the dataset descriptor.
 
 ## Getting started
+
+### Python
 It is highly recommended to have a look at the included [code/jupyter notebook](code/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.
 
@@ -61,6 +63,13 @@ conda create --name mep python=3 pandas numpy matplotlib scipy scikit-learn tqdm
 ```
 which creates an environment called "mep" that contains the required packages.
 
+### Microsoft Excel
+While the recommended starting point to exploring the data is the aforementioned Jupyter notebook, we have also included an [Excel file](code/mep_dataset_excel.xlsm) which can serve as a data exploration tool. This file contains all the data except the full time series data. We have added the possibility of visualizing the time series on demand, by clicking the "Visualize time series" button (to the right of the table in the 'EP data' sheet). This will create a new worksheet containing a graph of the currently selected EP measurement.
+
+For this to work you need to:
+* Allow macro execution: Excel will by default warn you that it has disabled running macros in the Excel sheet. To use the time series visualization you will need to use the "Enable Content" button to enable macros.
+* The time series will need to be unzipped in the location where it is stored as a zip file in this repository. That is, you need to unzip [data/mep_dataset.zip](data/mep_dataset.zip). The Excel file (which should be in the 'code' directory) will look for the data in the place where it is by default in the repository (in the 'data' directory). This is just the default place where it will look for the files, but you may change this by modifying the column 'filename' in the Excel file.
+
 # License
 
 <a rel="license" href="https://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work, including the provided code, is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International Public License</a>.