|
| 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. |
0 commit comments