diff --git a/README.org b/README.org index 3003586..d51881b 100644 --- a/README.org +++ b/README.org @@ -42,6 +42,8 @@ This is a self-contained mini-project which is not /directly related/ to the *** Examples/Screenshots +- [[https://git.abbether.net/return-to-ritherdon/ritherdon-charts/wiki][Project's Wiki]] (For more information on the types of charts produced) + At the time of writing, the scripts in this repository produce over one-hundred charts/files. So, here are a selection of the types of charts produced after processing the data in the =data/lm1-exhibiton-all.csv= and @@ -247,6 +249,55 @@ something like the following in the =/data= directory, 104 directories, 100 files #+end_src +With the overview/top layer explained, now is a good time to expand on the +directories produced in =/data/light-meter-1= and =data/light-meter-2=. As an +example, I will focus on the =data/light-meter-1/2021-06-13= directory (line 3 in +code block above). + +#+begin_src shell :results code + tree data/light-meter-1 +#+end_src + +#+RESULTS: +#+begin_src shell +data/light-meter-1 +├── 2021-06-13 +│   ├── 2021-06-13--00.csv +│   ├── 2021-06-13--01.csv +│   ├── 2021-06-13--02.csv +│   ├── 2021-06-13--03.csv +│   ├── 2021-06-13--04.csv +│   ├── 2021-06-13--05.csv +│   ├── 2021-06-13--06.csv +│   ├── 2021-06-13--07.csv +│   ├── 2021-06-13--08.csv +│   ├── 2021-06-13--09.csv # All readings recorded between the hours of 09:00 and 10:00. +│   ├── 2021-06-13--10.csv +│   ├── 2021-06-13--11.csv +│   ├── 2021-06-13--12.csv +│   ├── 2021-06-13--13.csv +│   ├── 2021-06-13--14.csv +│   ├── 2021-06-13--15.csv +│   ├── 2021-06-13--16.csv +│   ├── 2021-06-13--17.csv # All readings recorded between the hours of 17:00 and 18:00. +│   ├── 2021-06-13--18.csv +│   ├── 2021-06-13--19.csv +│   ├── 2021-06-13--20.csv +│   ├── 2021-06-13--21.csv +│   ├── 2021-06-13--22.csv +│   ├── 2021-06-13--23.csv +│   └── 2021-06-13--24.csv +├── 2021-06-13.csv # All readings recorded on 2021-06-13 (13th June 2021). +# This file/directory pattern repeats for all dates upto end of July... +├── 2021-07-30 +│   ├── 2021-07-30--00.csv +│   ├── 2021-07-30--01.csv # All readings recorded between the hours 01:00 and 02:00. +# Usual '2021-07-30--07' type files here... +└── 2021-07-30.csv # All readings recorded on 2021-07-30 (30th July 2021). + +48 directories, 1248 files +#+end_src + *The =/output= directory should now exist in the project's root directory -- with nothing in it.* This is where the charts will go, after running the Python (.py) scripts. The ~separator.sh~ script created it. The project's root directory should @@ -284,10 +335,11 @@ From here, you can either create some charts with the Python (.py) scripts and take a look at them in =/output= or open the CSV files in =/data= and inspect the data. -*** Overview of the CSV files in =/data= - -I need to write this... - *** Overview of Scripts and Charts -I need to write this... +- [[https://git.abbether.net/return-to-ritherdon/ritherdon-charts/wiki][Project's Wiki]] + +To stop this file growing too much, as I write more scripts which creates more +charts, all the overviews/summaries/breakdowns of the scripts and charts are in +the [[https://git.abbether.net/return-to-ritherdon/ritherdon-charts/wiki][wiki]]. Some scripts and charts entries might be out-of-date or missing, +though.