Browse Source

add /docs directory and initial versions of (doc) files in it.

I've stubbed out each file for this commit. I need to go in and write the main
content for them all (apart from sql-statements.org). I was originally going to
put a breakdown of what each (Python) script does in the wiki but I changed my
mind. The wiki, used by Gitea, doesn't allow .org files and I quite like the
option to run code in any of the (doc) files if needed (using org-babbel).

I need to update README.org to reflect this change.
master
Craig Oates 1 year ago
parent
commit
8e0f9845a9
  1. 21
      docs/dailies-overlayed.org
  2. 20
      docs/dailies-side-by-side.org
  3. 19
      docs/daily-breakdowns.org
  4. 19
      docs/day-to-day-comparisons.org
  5. 25
      docs/lm1-hourly-totals.org
  6. 13
      docs/sql-statements.org

21
docs/dailies-overlayed.org

@ -0,0 +1,21 @@
* Overview of =dailies-overlayed.py= Script
I have assumed you have ran ~./separator.sh~ and ~./totalilator.sh~, created a
virtual-environment (venv) (~python3 -m venv venv~) and installed the dependencies
(via ~pip -r install requirements.txt~). See the project's [[file:../README.org][README]] for more
information on setting the repository up.
#+begin_src shell
cd <PATH TO RITHERDON-CHARTS>
# Activate the virtual-environment if you haven't...
source venv/bin/activate
# Run the script...
python dailies-overlayed.py
#+end_src
* What the Script Does
This needs to be written...

20
docs/dailies-side-by-side.org

@ -0,0 +1,20 @@
* Overview of =dailies-side-by-side.py= Script
I have assumed you have ran ~./separator.sh~ and ~./totalilator.sh~, created a
virtual-environment (venv) (~python3 -m venv venv~) and installed the dependencies
(via ~pip -r install requirements.txt~). See the project's [[file:../README.org][README]] for more
information on setting the repository up.
#+begin_src shell
cd <PATH TO RITHERDON-CHARTS>
# Activate the virtual-environment if you haven't...
source venv/bin/activate
# Run the script...
python dailies-side-by-side.py
#+end_src
* What the Script Does
This needs to be written...

19
docs/daily-breakdowns.org

@ -0,0 +1,19 @@
* Overview of =daily-breakdowns.py= Script
I have assumed you have ran ~./separator.sh~ and ~./totalilator.sh~, created a
virtual-environment (venv) (~python3 -m venv venv~) and installed the dependencies
(via ~pip -r install requirements.txt~). See the project's [[file:../README.org][README]] for more
information on setting the repository up.
#+begin_src shell
cd <PATH TO RITHERDON-CHARTS>
# Activate the virtual-environment if you haven't...
source venv/bin/activate
# Run the script...
python daily-breakdowns.py
#+end_src
* What the Script Does
This needs to be written...

19
docs/day-to-day-comparisons.org

@ -0,0 +1,19 @@
* Overview of =day-to-day-comparisons.py= Script
I have assumed you have ran ~./separator.sh~ and ~./totalilator.sh~, created a
virtual-environment (venv) (~python3 -m venv venv~) and installed the dependencies
(via ~pip -r install requirements.txt~). See the project's [[file:../README.org][README]] for more
information on setting the repository up.
#+begin_src shell
cd <PATH TO RITHERDON-CHARTS>
# Activate the virtual-environment if you haven't...
source venv/bin/activate
# Run the script...
python day-to-day-comparisons.py
#+end_src
* What the Script Does
This needs to be written...

25
docs/lm1-hourly-totals.org

@ -0,0 +1,25 @@
* Overview of =lm1-hourly-totals.py= and =lm2-hourly-totals.py= Scripts
I have assumed you have ran ~./separator.sh~ and ~./totalilator.sh~, created a
virtual-environment (venv) (~python3 -m venv venv~) and installed the dependencies
(via ~pip -r install requirements.txt~). See the project's [[file:../README.org][README]] for more
information on setting the repository up.
#+begin_src shell
cd <PATH TO RITHERDON-CHARTS>
# Activate the virtual-environment if you haven't...
source venv/bin/activate
# Run the script for generating the chart for Light Meter 1...
python lm1-hourly-totals.py
# Run the script for generating the chart for Light Meter 2...
python lm2-hourly-totals.py
#+end_src
* What the Script Does
This needs to be written...

13
docs/sql-statements.org

@ -0,0 +1,13 @@
* Overview of =sql-statements.sql=
This is an artefact of the project's origins. I needed to export the data from
the database before I could work with said data (more context provided in
[[file:../README.org][README]]). You /should/ never need or have the means to run this script. I have
added it to this repository as a backup more than anything else.
If you open =sql-statements.sql= you will notice I used specific dates when
selecting the data to export. This is because the database contained data from
outside the exhibition's run-time and was not needed from this particular
mini-project. For the sake of completeness, the exhibition's run-time was from
the 13^th June 2021 to 1^st August and I used a SQLite3 database to store the
data.
Loading…
Cancel
Save