Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Qsettings #519

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Qsettings #519

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1c2afdf
Merge changes add qsettings.
erinn Oct 1, 2022
755c088
Merge branch 'master' into qsettings2
erinn Oct 1, 2022
c0bf099
Update Docs and INI file.
erinn Oct 1, 2022
3e3b994
Merge branch 'ncssar:master' into qsettings2
erinn Oct 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 44 additions & 27 deletions INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,48 @@
# Installation

As of Nov 19, 2016, there is no installation script or program. Installation just involves cloning or downloading this repository, but, there is an important list of prerequisites. You could consider these to be part of the installation procedure:

1. Python 3.4.2 or higher - install for All Users, which may require you to run the installer as Administrator, and also to check 'install for all users' in the Advanced Options, and change the installation directory to C:\Python-<version> to avoid spaces in the directory name, but this will require you to edit the properties of Lib\site-packages in the python install directory to remove the read-only flag (and apply to all subdirectories) in order to allow the following steps
2. Python modules
* PyQt 5.4 or higher (pip install pyqt5)
* reportlab (pip install reportlab)
* pyserial (pip install pyserial)
* requests (pip install requests)
* fdfgen (pip install fdfgen)
* win32api (pip install pypiwin32)
3. GISInternals SDK (http://www.gisinternals.com/release.php - pick the latest release for your platform, such as release-1911-x64-gdal-3-0-0-mapserver-7-4-0, and within that, select the compiled binaries in a single .zip package; life will be easier in later steps if you unzip to C:\ then rename C:\release-..... to C:\GISInternals, such that C:\GISInternals\bin\proj\apps\cs2cs.exe exists (the .msi installers may have a problem detecting your python installation))
4. PDFtk Free (https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/ - download and install the free version; during install, you will be asked if the pdftk directory should be added to your path; make sure you answer 'yes')
5. Adobe Acrobat Reader must be installed and must have been run once to initialize itself and to set itself as the default application for pdf viewing; otherwise the terminal will show a win32api error during printing. Not sure why this is, but, we found a stackoverflow thread where someone else had the same issue.
6. Liberation Sans font, if not already installed through the operating system (acquire the Liberation Sans .ttf file(s), right-click to install). You will know if you are missing it when a generated PDF during print will show up with a bunch of dots instead of letters.

After you have all the files from this repo (download the zip and extract to C:\), and all the above prerequisites are in place, you will need to set up the 'local' directory. As of 8-1-19 there is no code in place to create the local directory for a fresh installation: you will need to create a dir named 'local' in the radiolog install dir (such as C:\radiolog-master\local) and in that directory you will need to place radiolog.cfg (can be blank) and an optional logo file as spelled out below.

# radiolog.cfg optional settings
Optional file local/radiolog.cfg can be used to change various settings. That file is plain text, and has documentation inside it.

If the 'local' directory does not exist yet, i.e. the first time you run radiolog, it will be created as a copy of the 'local_default' directory included as part of the installation.

If new radiolog versions contain new user-definable options, local_default/radiolog.cfg will contain the new options and documentation.
## Binary Installer:
There is a binary installer located here: https://github.com/ncssar/radiolog/releases

Download and run radiolog-setup.exe to install on Windows.

## To Install from Source:

1. Python 3.4.2 or higher - install for All Users, which may require you to run
the installer as Administrator, and also to check 'install for all users' in the
Advanced Options, and change the installation directory to C:\Python-<version>
to avoid spaces in the directory name, but this will require you to edit the
properties of Lib\site-packages in the python install directory to remove the
read-only flag (and apply to all subdirectories) in order to allow the following
steps.
2. Python Modules:
1. pip install -r requirements.txt
3. Adobe Acrobat Reader must be installed and must have been run once to
initialize itself and to set itself as the default application for pdf viewing;
otherwise the terminal will show a win32api error during printing. Not sure why
this is, but, we found a stackoverflow thread where someone else had the same issue.
4. Liberation Sans font, if not already installed through the operating system
(acquire the Liberation Sans .ttf file(s), right-click to install). You will
know if you are missing it when a generated PDF during print will show up with
a bunch of dots instead of letters.

# RadioLog.ini Optional Settings
On Windows settings for RadioLog can be configured in an INI file. This file
on Windows is generally located here:
<Drive>:\Users\<Current User>\AppData\Roaming\NCSSAR\RadioLog.ini

If new RadioLog versions contain new user-definable options,
local_default/Radiolog.ini will contain the new options and documentation.

# radiolog_logo.jpg
You can optionally provide a logo image to be incldued on radiolog printouts (except for clue reports). The file will be scaled to print in the pdf files, so a starting size of 200x200 pixels or less should be fine. Name the file local/radiolog_logo.jpg. Note that a default logo is included in local_default so will be copied in to place the first time you run radiolog. You can then delete local/radiolog_logo.jpg or overwrite it with your own logo.


That should do it! Just run 'python radiolog.py' to run the program. You may want to create a desktop shortcut and use the included icon.
You can optionally provide a logo image to be included on RadioLog printouts
(except for clue reports). The file will be scaled to print in the pdf files,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove '(except for clue reports)' - that applied to clue reports when pdftk was used, but now that reportlog is use for clue reports, the logo will show up there just like the other generated pdfs.

so a starting size of 200x200 pixels or less should be fine. On Windows this
file should be located at:
<Drive>:\Users\<Current User>\AppData\Roaming\NCSSAR\RadioLog\
Name the file radiolog_logo.jpg. Note that a default logo is included in local_default
so will be copied in to place the first time you run RadioLog. You can then
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line (my old wording) is vague - could you suggest a rewording? Maybe just delete the last sentence 'you can then...'

delete radiolog_logo.jpg or overwrite it with your own logo.


That should do it! Just run 'python radiolog.py' to run the program. You may
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'run python radiolog.py' only applies when installed from source - not sure if that's clear in the rendered .md? Even if it's under the install from source header, it might be good to spell out that it doesn't apply to installed-from-binary. Either here or above, it would also be good to spell out that the binary installer gives you an executable to run, instead of running python from the command line. Your choice on wording.

want to create a desktop shortcut and use the included icon.
12 changes: 8 additions & 4 deletions local_default/radiolog.cfg → local_default/Radiolog.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
# change from team to team.

# This file will be read from:
# <radiolog>/local/radiolog.cfg
# where <radiolog> is the main radiolog install path
# ${appConfigLocation}
# where <radiolog> is the main RadioLog install path
# which contains radiolog.py

# - the first line of this file must be [RadioLog]
Expand All @@ -21,7 +21,7 @@
# - to set a different value, uncomment the setting
# line and set its value as needed; incorrect
# or invalid values will be flagged with warnings
# or errors when radiolog is started
# or errors when RadioLog is started

##################################################

Expand Down Expand Up @@ -68,7 +68,7 @@

# logo
# - filename of logo to include in printed forms
# - path is relative to ./local
# - path is relative to ${appDataLocation}
# - default: radiolog_logo.jpg
#logo=radiolog_logo.jpg

Expand Down Expand Up @@ -96,3 +96,7 @@
# a different group, separated from the first group's tabs by a gap
# EXAMPLE: tabGroups=[["NCSOcmd","^1[sel][0-9]+"],["NCSO","^1[tpndovg][0-9]+"],["NCPD","^2[atpnsdelovg][0-9]+"],["TPD","^3[atpnsdelovg][0-9]+"],["GVPD","^4[atpnsdelovg][0-9]+"],["CHP","^22s[0-9]+"],["Numbers","^Team [0-9]+"]]
#tabGroups=[["Numbers","^Team [0-9]+"]]

# continuedIncidentWindowDays

# continuedIncidentWindowDays = 4
Loading