Skip to content

Commit ea30d81

Browse files
committed
update readme
1 parent f07ab0e commit ea30d81

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ by Nithiya Streethran (nmstreethran at gmail dot com)
88

99
## Description of files
1010

11-
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.
11+
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.
1212

13-
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)).
13+
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)).
1414

15-
**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).
15+
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/).
1616

17-
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/`.
17+
**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).
1818

1919
## Document compilation
2020

0 commit comments

Comments
 (0)