diff --git a/README.md b/README.md index 37a36da..3b574b9 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,22 @@ # AutoImpute + Automatic imputation tool for MPhil ACS dissertation Developed for Python 3 (tested with 3.5.2 on Ubuntu 16.04). -### Requirements (tested versions) +### Requirements * Numpy (1.14.0) -* Scipy (1.10.0) \ No newline at end of file +* Scipy (1.10.0) + +### Instructions + +Run `python3 auto_impute/auto_impute.py` for help. + +### Directories + +* `auto_impute` - source code for AutoImpute +* `data` - various data files for testing and investigations +* `investigations` - Jupyter notebooks used for running experiments +* `tests` - the unit test suite