Imaging Client GUI for manual classification
Project description
Client Graphical User Interface
This client GUI is used for manual imaging target classification through the BYU AUVSI imaging server.
Setup
End-user
If you just want to use the client to classify images, and don't plan on doing any development with it, here's how you can set it up.
Ubuntu:
sudo apt install python3-pip python3-tk
pip3 install byu-auvsi-imaging-client
And to run you can simply enter:
./.local/bin/img_gui
You may also consider adding ~/.local/bin/
to your PATH:
export PATH="$HOME/.local/bin:$PATH"
Development
To develop and contribute to this gui, clone the imaging repository.
This gui was built with tkinter in python3 and relies on a few packages
sudo apt install python3-tk python3-tk
./setup/dev_setup.sh
Use
For development you should run the gui in its local directory:
cd ...../src/imaging/client
python gui.py
If installed via pip, simply run it as a script:
./~/.local/bin/img_gui
Sub Functions
This gui is built with with a tkinter tab framework. Each tab is initialized at startup which creates each container label and widget on each tab. Only one tab runs at a time.
lib/client_rest.py
contains all functions that interact with the server
lib/tabX.py
contains the functions for tab X
lib/tab_tools.py
contains helper functions used by multiple tabs
Releasing on Pypi
Travis takes care of most of the heavy lifting when you want to release a new version of the gui onto pip/Pypi. In order to release a new version, you need to do two things:
-
Update the
VERSION
variable in client/setup.py to whatever the new version is going to be called. If you dont do this, the new code will NOT be uploaded onto Pypi! -
Update the
self.version_num
at the top of the fileclient/lib/tab0.py
to display on the gui the correct current version number. -
Create a release tag on github that matches the
VERSION
. (Goto Releases->Create a new Release). Once a commit is tagged as a release, Travis will kick off and build deploy the current code to PyPi and thus to pip.
Future Updates
The header of each file contains possible future improvements
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for byu-auvsi-imaging-client-0.1.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f366b483e00bff64b2870851c3c1440647df5a5d9cb0d8e682d013325aed30e |
|
MD5 | 5441d4a3bffad5b553812dda9e78b002 |
|
BLAKE2b-256 | 075e8e98a44acd87b57ad9e48ded0af27684df770be525719babf2afeca2d1f1 |
Hashes for byu_auvsi_imaging_client-0.1.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 642e5b80e44dcc818f0bc778ee3f369a3942fd8cb900c1931c2053372e08a85f |
|
MD5 | 3403bba61913f4496132898d3e7c2ef4 |
|
BLAKE2b-256 | 495ee226e45b8f849eca803bafff58224b3d6cbea0c01cb60fd932f4ad71ba64 |