From ea30d8124863ab785fba8a4f8a32a917cd1d2b62 Mon Sep 17 00:00:00 2001 From: Nithiya Streethran Date: Sat, 28 Nov 2020 01:22:36 +0800 Subject: [PATCH] update readme --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ee395ed..52409dc 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,13 @@ by Nithiya Streethran (nmstreethran at gmail dot com) ## Description of files -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. +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 I did after my graduation. I did not make any major changes to the code or document, so this repository still contains a bunch of standalone scripts and not a package. -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)). +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/v1.0.0), 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). +The list of Python dependencies can be found in [`requirements.txt`](requirements.txt). All Python scripts are organised into relevant directories in [`scripts/`](scripts/). Jupyter notebooks with outputs of these scripts can be viewed in [`jupyter-notebooks/`](jupyter-notebooks/). Tables and images used, in the form of `.png` and `.pdf` files, are in [`images/`](images/). The dissertation document with references, which was compiled using (Xe)LaTeX, can be found in [`docs/`](docs/). -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/`. +**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). ## Document compilation