Squashed commit of the following:

commit dc24a624fb Author: Craig Oates <craig@craigoates.net> Date: Fri Nov 5 15:45:36 2021 +0000 update README title. commit ffd668b920 Author: Craig Oates <craig@craigoates.net> Date: Fri Nov 5 15:42:15 2021 +0000 update README. commit 3c15bf541e Author: Craig Oates <craig@craigoates.net> Date: Sun May 9 00:26:07 2021 +0100 change save_filtered_flickers to use writerow. It was using writewrows before this but writerow makes it easier to change. This is probably a nothing change but hey-ho! commit c73f5b2d25 Author: Craig Oates <craig@craigoates.net> Date: Sun May 9 00:19:07 2021 +0100 add fix to stop duplicating entries in find_readings_with_lights_on. The function was originally looping through the set of readings for a particular time-stamp. If there was more than one reading above 39, it would append that particular time-stamp every time the if-statement was true -- as it looped through each reading for said time-stamp. This change adds a break and a variable to track if the time-stamp should be added to the list -- after it has broke out of the if-block. commit f35fdd611a Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 21:27:54 2021 +0100 add comments to flicker.py explaining process. These comments explain how each 'section' works with the data. There mostly here for when I come back to this months/years from now and I've forgotten how this code works. The other scenarios this is for -- although very unlikely -- is other people new to the project and need a helping hand. commit 2e602e9082 Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 21:01:25 2021 +0100 filter readings (over herz and light levels threshold). Having filtered down the list to readings which suppass the Hertz threshold (4+ per-second at time of writing), the code here filters it down even more. This bit of code searches for readings within this already filtered list for any readings which activate the light in the gallery (with the threshold matching that of 'gallery1' which in anything over 39). It then proceeds to save the results. commit 80cf014c21 Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 20:56:40 2021 +0100 add save function for filtered flickers list. This could do with being generalised with the other save functions (in io_services). For now, it's job is to save the list of readings which contain four or more readings-per-second and at least one of them is over 39. The specificness of the 39 is because the test data used is from 'factory1' (Light Meter) and that is the threshold for triggering the lights connected to 'gallery1' in the gallery. commit 7bfd06cf03 Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 19:27:03 2021 +0100 implement find_flicker feature. This functions goes through the list of readings and forms a dictionary of time-stamps, with light readings beyond a specified readings-per-second threshold, and the reading for said time-stamp. The results are then saved to the specified file, using 'save_rps_totals' function. commit 2cbecc0d2c Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 17:25:06 2021 +0100 add save function for time-stamps with readings above threshold. This is not exactly encoded into the code itself. It's implied and needs to be used with that in mind. It's more of 'save list' function. I will probably rename/refactor this in the future depending on how the project develops. commit 263bfe40fd Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 17:22:44 2021 +0100 move 'data service' files to data_services file. Part of a move to clean-up flicker.py -- making it a place to call the functions in a way which is easy to 'switch' functions off via comments. commit ee0853b3dd Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 16:37:50 2021 +0100 create data_services.py Part of the move to clean-up flicker.py and make the code more modular (for potential improve in REPL usage?). commit 0f6fdc22fa Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 16:35:50 2021 +0100 add readings-per-sec.csv file to gitignore. It was getting in the way and doesn't need to be part of the commit history. It's only purpose is to output the results -- to be used else where. commit d9742dc43b Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 16:30:54 2021 +0100 remove redundant (save) code. commit 9fb282db1f Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 16:30:07 2021 +0100 move save_rps_totals function to io_services. Part of code clean-up. commit 26b01f38f5 Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 16:16:43 2021 +0100 tally readings per second using list of tuples. This replaces the original way of doing it with a dictionary. The change was brought about because the previous data loading function was omitting duplicate entries (I.E. multiple readings from the same second in time). commit a4f6142137 Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 16:15:49 2021 +0100 fix string interpolation bug in print_list function. commit b149ce3a8d Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 16:02:14 2021 +0100 change return type to list in load_raw_data. I made the mistake of not realising the dictionary was 'removing' duplicate entries by simply not adding the 'second' reading for a given time interval. An example of this is as follows, there are two readings within the fifty-sixth second (E.G. 07:03:56) but the second was being omitted from the dictionary storing the data after it was loaded into memory. I changed the return type to a list of tuples to preserve the raw part of the data (I.E. multiple readings per second). The intention here is so I can start from the 'raw' data without needing to load the data in numerous times during run-time. I've omitted the 'Id' column because I have no need for it in this context. If I do need it, though, I can add an extra item to the returned tuple (I.E. add r[0] to append) . This bug came about because I took most of the code from the initial 'load data' function. The original function converted the raw CSV data into a dictionary which tallied the total readings per second before returning it. This function doesn't do that. It leaves the data in a more raw state. commit 8f9df9462b Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 15:13:22 2021 +0100 import io_services into flicker.py. I, also, removed the load_data function. This is part of the gradual move to transfer 'service' based functions out of flicker.py. The aim here is to reduce the need for duplicating code or make it easier to make function calls when needing a particular piece of data (or transformation of data). commit 18d0470d43 Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 15:11:32 2021 +0100 create log_services.py. Houses a collection of print-based functions to help relay information in the terminal. The biggest motivation for this was to make the dictionaries easier to read when printing them in the terminal. commit 47636b3b18 Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 15:02:07 2021 +0100 create io_services.py. The inital services files. This provides a function to load the CSV file of the raw test data (factory1 Light Meter). commit 25277572c0 Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 15:00:40 2021 +0100 begin moving code to 'services'. I've began getting into a mess with trying to use duplicated code and data. I've began to move functions to their own services folder and files to help reduce the duplication. commit b93a207ba3 Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 13:13:40 2021 +0100 rename reading-per-sec-tallies.csv to readings-per-sec.csv. Did this because for ease of typing. commit 7c9feab1b2 Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 13:11:52 2021 +0100 put code into functions and 'main' in flicker.py. This is just so I can start to 'turn things on and off' (via comments). commit 51f0d3e4bf Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 12:52:41 2021 +0100 update file names to new test-data file names. This is part of a previous commit which shortended the file housing the test data. commit f0cbce52f6 Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 12:48:40 2021 +0100 rename test data files. Because I'm only testing and getting a proof-of-concept up and running, the longer and more specific files is not worth the effort right now. They are unwieldy to type and getting in the way. I've renamed them to smaller names with the intention to use more specific file names when things start to settle in the direction of the project. commit 9b87d742df Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 00:18:10 2021 +0100 create 23-04-2021-readings-per-sec.csv ('results' file). This file houses the data flicker.py computes/generates. commit e04617ae13 Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 00:13:45 2021 +0100 delete original flicker.py (moved to src). Just basic organisation. I accidently created flicker.py at the repositories root. I meant to create it in 'src'. I'd already pushed the commit before I spotted my mistake hence the 'mess' in the git history. commit dc05b3481d Author: Craig Oates <craig@craigoates.net> Date: Sat May 8 00:01:37 2021 +0100 create flicker.py and csv parsing code. The code in this file is mostly to get the ball moving in this repository. This file opens the 'light-meter-sample-readings-23-04-2021-ritherdon.csv' file and tallies-up the number of requests per second groups. After that, it writes the results to 23-04-2021-readings-per-sec.csv. As an example (to help explain), it counts and stores how many times the light meter (factory1) took a reading at the rate of two times per second. In this instance, there were 2955 instances of the light meter taking two readings per second. This roughly equates to 10% of the days readings was at a rate of two requests per second. 28% of the time the light meter was recording at four requests per second, 18% for one and 44% for three. commit 77ee5318ec Author: Craig Oates <craig@craigoates.net> Date: Fri May 7 23:59:10 2021 +0100 create 'lite' sample data set. The main file I was using was too big and taking too long to process. Whilst I got things moving in this repository, I removed a lot of the data to help speed-up the development process. This should be a temporary file and I expect this to be deleted at some point in the future. commit aeaf2dc258 Author: Craig Oates <craig@craigoates.net> Date: Fri May 7 20:27:02 2021 +0100 create flicker.py. This is the 'main' file if you will. commit 734097fcc9 Author: Craig Oates <craig@craigoates.net> Date: Fri May 7 20:17:24 2021 +0100 import initial light meter readings 23-04-2021. This is a .csv file and will be used and the initial test data this project will aim to breakdown into a list of readings for each second. At the moment, I'm being vague with my desciption of what 'breakdown' means here because this is just a proof-of-concept. I don't expect this file to remain around for too long in the repository. commit 0078370093 Author: Craig Oates <craig@craigoates.net> Date: Fri May 7 20:16:01 2021 +0100 create requirements.txt.
3 years ago · 39943892ae
3 changed files with 151 additions and 2 deletions
--- a/README.md
+++ b/README.md
@ -1,3 +1,125 @@
-# flicker
+# Return to Ritherdon: Flicker

-Data analysis on the light meter readings taken with the Light Meter project. The main area of study is the health and safety concerns regarding epilepsy.
+This a Python 3 project which provides a breakdown of the data
+produced by 'Personal Flash in Real-Time' artwork. The data analysis
+provided by Flicker is for the health and safety assessment concerns
+regarding epilepsy -- when the artwork is exhibited in a public
+(I.E. art gallery) setting. This code base has no immediate bearing on
+the 'Personal Flash in Real-Time' artwork and its various
+components. This is strictly data analysis (for health and safety).
+
+'Personal Flash in Real-Time' is an artwork which consists of three
+smaller projects. They are:
+
+- [Light Meter](https://git.abbether.net/return-to-ritherdon/light-meter)
+- [Relay](https://git.abbether.net/return-to-ritherdon/relay)
+- [Midpoint](https://git.abbether.net/return-to-ritherdon/midpoint)
+- [Personal Flash in Real-Time Documentation](https://git.abbether.net/return-to-ritherdon/rtr-docs) (This provides documentation for the whole project/artwork)
+
+The data Flicker breaks down is the SQLite database used by the
+Midpoint project. Light Meter is responsible for taking and sending
+light readings (in the various welding booths in Ritherdon) and
+sending them to Midpoint -- where they are stored. Relay is
+responsible for requesting those light readings (from Midpoint) and
+controlling the lights connected to it/them in the art gallery
+(I.E. Castlefield) based on those light readings.
+
+For the health and safety assessment, please use the following link:
+
+- [Health and Safety Assessment](https://git.abbether.net/return-to-ritherdon/rtr-docs/src/branch/master/health-and-safety/photosensitive_epilepsy.md)
+
+The assessment goes through and explains **how to interpret the
+data** -- which is outside the scope of this document. 
+
+## Project Set-up
+
+This assumes you are using Linux, specifically Debian or Ubuntu, and
+have Python 3 already installed. Other environments have not been
+tested.
+
+After you can cloned the repository, you will need to set-up a Python
+virtual environment and install its requirements.
+
+```bash
+git clone http://git.abbether.net/return-to-ritherdon/flicker.git
+cd flicker
+
+# Adjust the location for your 'venv' to whatever you prefer. This is
+# just a default example.
+python3 -m venv venv
+
+# Activate the virtual environment.
+source venv/bin/activate
+
+# Install the projects requirements.
+pip install -r requirements.txt
+```
+
+From there, you should already have the data which needs
+processing. Because of the nature of this repository, I have
+transferred the data to it manually. There is no automated way to get
+the latest version of the data. I do not have any plans to add this as
+a feature.
+
+The project structure should look something like the following,
+
+```console
+flicker/
+├── LICENSE
+├── README.md
+├── requirements.txt
+└── src
+    ├── data
+    │   ├── test-data.csv
+    │   └── test-data-lite.csv
+    ├── flicker.py
+    └── services
+        ├── data_services.py
+        ├── io_services.py
+        └── log_services.py
+```
+
+**Note: You will need to create the `results` folder and its 'result
+files' separately.** This is because they are included in the
+`.gitignore` file -- so the commit history does not get clogged-up.
+
+To finalise setting up the project and begin the analysis, run the
+following commands,
+
+```bash
+# Make sure you have activated the virtual environment. Can ignore if
+# you already have.
+# cd flicker
+source venv/bin/activate
+
+# These files are used for intermediate storage whilst processing the
+# data. The 'final' results are stored in 'filtered_flicker_entries.csv'
+mkdir data/results
+touch readings-per-sec.csv
+touch readings_above_threshold.csv
+touch flicker_list.csv
+touch filtered_flicker_entries.csv
+
+# To start the data processing -- which might take a while...
+python src/flicker.py
+```
+
+For how the analysis is done, read the `flicker.py` file (I.E. the
+'main'/entry-point file). Each stage is separated and documented
+within it. You can quickly jump to said file by clicking the link
+below:
+
+- [flicker.py](https://git.abbether.net/return-to-ritherdon/flicker/src/branch/master/src/flicker.py)
+
+Essentially, this is just a glorified script but I have separated out
+the logic into various files and directories because that's just how I
+like to roll. Was this necessary? Not really. It is what it is,
+though. How the files are connected are shown in the diagram below.
+
+![System Overview](attachments/system-overview.png)
+
+The main reason for separating out the code like this was because I
+felt like it aided in explaining what the code was doing in
+`flicker.py` via the use of comments. I could document things at a
+high level in `flicker.py` and you could dig down into the various
+function calls if you need/want to.
--- a/attachments/system-overview.dot
+++ b/attachments/system-overview.dot
@ -0,0 +1,27 @@
+digraph overview {
+	subgraph cluster0 {
+		style = filled;
+		color = lightblue;
+		node[style = filled, color = white, fontname = Arial;];
+		d;
+		i;
+		l;
+	}
+	label = "Flicker Overview";
+	fontname = Arial;
+	fontsize = 20;
+	labelloc = top;
+	f [fontname = Arial, label = "flicker.py"];
+	d [fontname = Arial, label = "data_services.py"];
+	i [fontname = Arial, label = "io_services.py"];
+	l [fontname = Arial, label = "log_services.py"];
+	data [fontname = Arial, label = "The various data (.csv) files", shape = rectangle];
+	
+	f -> d;
+	d -> f;
+	f -> i;
+	i -> f;
+	f -> l;
+	i -> data;
+	data -> i;
+}
--- a/attachments/system-overview.png
+++ b/attachments/system-overview.png