From f07ab0ed7f740ff26f0a51630da4d15c395b7a28 Mon Sep 17 00:00:00 2001 From: Nithiya Streethran Date: Sat, 28 Nov 2020 01:09:12 +0800 Subject: [PATCH] update readme and .gitignore --- .gitignore | 3 +-- README.md | 16 +++++++++------- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/.gitignore b/.gitignore index d001722..0669c38 100644 --- a/.gitignore +++ b/.gitignore @@ -364,10 +364,9 @@ TSWLatexianTemp* # standalone packages *.sta -# Visual Studio Code +# User files *.code-workspace .vscode/ -requirements.sh # User folders data/ diff --git a/README.md b/README.md index cff006c..ee395ed 100644 --- a/README.md +++ b/README.md @@ -2,19 +2,21 @@ [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2875795.svg)](https://doi.org/10.5281/zenodo.2875795) -**This repository is an archive of files. I am not working on this project at the moment. Please submit an [issue](https://github.com/nmstreethran/WindTurbineClassification/issues) if you have any comments.** +***Specification of 'normal' wind turbine operating behaviour for rapid anomaly detection: through the use of machine learning algorithms*** -**Unfortunately, the datasets are proprietary and I do not own the rights to distribute them to the public.** +by Nithiya Streethran (nmstreethran at gmail dot com) ---- +## Description of files -***Specification of 'normal' wind turbine operating behaviour for rapid anomaly detection: through the use of machine learning algorithms*** +This repository is an archive of files created for my master's dissertation, which was completed between May and August 2017 at Heriot-Watt University and Natural Power Consultants. This was also my very first Python project. Unsurprisingly, these files needed some formatting to improve readability, which did after graduating with a master's degree in Renewable Energy Engineering. I did not make any major changes to the code, so this repository still contains a bunch of standalone scripts and not a package. -by Nithiya Streethran (nmstreethran at gmail dot com) +The `current` branch has the formatted code and dissertation files. The dissertation can be viewed [here](docs/nms_dissertation.pdf) [[PDF download](https://raw.githubusercontent.com/nmstreethran/WindTurbineClassification/current/docs/nms_dissertation.pdf)]. The original submission can be accessed using [this branch](https://github.com/nmstreethran/WindTurbineClassification/tree/b07072256df783c69c2736d1e38302d5df451887), or by downloading the [v1.0.0 archive](https://github.com/nmstreethran/WindTurbineClassification/releases/tag/v1.0.0) (also available on [Zenodo](https://doi.org/10.5281/zenodo.2875804)). + +**Unfortunately, the datasets are proprietary and I do not own the rights to distribute them to the public.** As a result, I will not be making any further improvements to the code. If you would like me to explain the method I have used, or have any questions, please let me know, preferably through an [issue](https://github.com/nmstreethran/WindTurbineClassification/issues). -An archive of files from my master's dissertation, completed between May and August 2017 at Heriot-Watt University and Natural Power Consultants. The dissertation can be viewed [here](docs/nms_dissertation.pdf) [[download](https://raw.githubusercontent.com/nmstreethran/WindTurbineClassification/current/docs/nms_dissertation.pdf)]. +The list of dependencies can be found in `requirements.txt`. All Python scripts are organised into relevant directories in `scripts/`. The outputs of these scripts can be viewed in the Jupyter notebooks in `jupyter-notebooks/`. Tables and images used, in the form of `.png` and `.pdf` files, are in `images/`. The dissertation document, which is compiled using LaTeX, can be found in `docs/`. -The files in this repository are modified versions of my original submission. This has been done mainly to format and improve readability; no major changes were made. The original files can be viewed [here](https://github.com/nmstreethran/WindTurbineClassification/tree/b07072256df783c69c2736d1e38302d5df451887) [[v1.0.0 archive](https://github.com/nmstreethran/WindTurbineClassification/releases/tag/v1.0.0)]. +## Document compilation To compile the LaTeX document, use the following commands within the `docs` directory: