Skip to content

Commit 6f2cf86

Browse files
committed
Added RST appendix code
1 parent 3f9a410 commit 6f2cf86

File tree

2 files changed

+180
-0
lines changed

2 files changed

+180
-0
lines changed

Appendix-RST/README.rst

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
============================
2+
ABQ Data Entry Application
3+
============================
4+
5+
Description
6+
===========
7+
8+
This program provides entry, retrieval, and reporting on ABQ Agrilabs laboratory data.
9+
10+
Features
11+
--------
12+
13+
* Enter data through validated form
14+
* View historical data
15+
* SQL Database storage
16+
* Generate charts and plots
17+
* Upload CSV extracts to corporate servers
18+
19+
Authors
20+
=======
21+
22+
Alan D Moore, 2021
23+
24+
Requirements
25+
============
26+
27+
One of the following operating systems:
28+
29+
* **Microsoft Windows**: 64-bit Windows 10 or higher
30+
* **Apple macOS**: 64-bit High Sierra or higher
31+
* **Linux**: x86_64 with kernel 4.4.0 or higher. *Debian 10 or Ubuntu 20.04 (or newer) recommended.*
32+
33+
Installation
34+
============
35+
36+
Windows
37+
-------
38+
39+
Double-click the ``ABQ_Data_Entry-1.0-win64.msi`` file to launch the installation wizard.
40+
Shortcuts will appear on your desktop and in the menu after the wizard completes.
41+
42+
macOS
43+
-----
44+
45+
Double-click the ``ABQ_Data_Enter-1.0.dmg`` file to open it,
46+
then drag the ``ABQ-Data-Entry`` application to your desktop or Applications folder.
47+
48+
49+
Linux
50+
-----
51+
Extract ``abq_data_entry_1.0.tar.gz`` into a directory on your system.
52+
``/opt/abq`` is recommended. You can then execute the ``abq`` file from that directory.
53+
54+
You may wish to create a script in the ``/usr/local/bin/`` folder, like so::
55+
56+
#!/bin/sh
57+
# /usr/local/bin/abq
58+
59+
cd /opt/abq
60+
./abq $@
61+
62+
This way you can launch abq from anywhere on the system by typing ``abq``.
63+
64+
Configuration
65+
=============
66+
67+
Configuration for the application is stored in the ``abq_settings.json`` file
68+
in a directory appropriate to your OS. Refer to this table:
69+
70+
========== ==============================================
71+
System Directory
72+
========== ==============================================
73+
Linux, BSD ``$XDG_HOME/`` if defined, else ``~/.config/``
74+
macOS ``~/Library/Application Support/``
75+
Windows ``%HOME%\AppData\Local``
76+
========== ==============================================
77+
78+
The configuration file should be used to set the host and port of the database server,
79+
the connection properties for corporate REST and SFTP servers, and the call-sign for the
80+
weather station nearest the facility. Other configuration options can be configured
81+
from within the application.
82+
83+
General Notes
84+
=============
85+
86+
Please report all bugs to the data analysis department at the Bloomington, IN facility.

Appendix-RST/abq_stylesheet.css

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
BODY {
2+
background-color: #DDF;
3+
font-family: Times New Roman, Serif;
4+
font-size: 16pt;
5+
margin: 0;
6+
}
7+
8+
h1.title {
9+
font-variant: small-caps;
10+
font-size: 20pt;
11+
text-decoration: none;
12+
border-bottom: 4px double silver;
13+
background-color: navy;
14+
color: #EEE;
15+
margin: 0;
16+
padding: .5em 1em;
17+
text-shadow: 2px 2px 5px red;
18+
text-align: center;
19+
}
20+
21+
h1 {
22+
font-size: 1.3em;
23+
text-decoration: underline;
24+
}
25+
26+
h2 {
27+
font-size: 1.1em;
28+
}
29+
30+
UL {
31+
padding-left: 2em;
32+
}
33+
34+
LI {
35+
line-height: 1em;
36+
margin: 0;
37+
}
38+
39+
LI P {
40+
margin: .25em;
41+
padding: 0;
42+
}
43+
44+
pre.literal-block {
45+
background-color: #EEE;
46+
padding: 1em 3em;
47+
border: 2px inset silver;
48+
}
49+
50+
.literal {
51+
background-color: #EEE;
52+
border: 1px solid silver;
53+
font-family: Mono;
54+
}
55+
56+
.document {
57+
padding: 0;
58+
margin-left: auto;
59+
margin-right: auto;
60+
max-width: 50em;
61+
box-shadow: 4px 4px 10px black;
62+
background-color: #EEF;
63+
}
64+
65+
.document>.section {
66+
padding: .5em 2em 0 1em;
67+
}
68+
69+
70+
TABLE {
71+
border: 1px solid silver;
72+
width: 100%;
73+
}
74+
75+
TABLE TH {
76+
border: 1px solid silver;
77+
border-collapse: collapse;
78+
background-color: #CCC;
79+
text-align: left;
80+
font-weight: bold;
81+
padding: 0;
82+
}
83+
84+
TABLE TD {
85+
border: 1px solid silver;
86+
border-collapse: collapse;
87+
background-color: #EEE;
88+
padding: 0;
89+
}
90+
91+
TABLE TD P {
92+
padding: 0;
93+
margin: .25em;
94+
}

0 commit comments

Comments
 (0)