README.md

1. User Manual

• 1.User Manual (CSE 485/486 NASA Geological Mapping Group)
  • 1.1. Setup
    • 1.1.1. Step 1 - Python Dependencies
    • 1.1.2. Step 2 - Run the app
  • 1.2. Main Screen
  • 1.3. 1.2 Buttons
    • 1.3.1. Open Image and Run Prediction
    • 1.3.2. Detect on Sample Image
    • 1.3.3. Draw
    • 1.3.4. Exit
  • 1.4. Video Link

1.1. Setup

This project is supported on Linux. Not tested on Windows or macOS..

In order to get started clone this repository:

git clone https://github.com/avilla11/GeologicalMapping_12A_2021.git

1.1.1. Step 1 - Python Dependencies

This project requires python3 and pip

This project requires the following Python dependencies:

1. PySimpleGUI
2. PyCDA
3. Numpy
4. OpenCV

To download all the dependencies, simply run scripts/install.py using the command:

python3 scripts/install.py

if for any reason the script fails to install any dependency, manually install them using the following commands:

pip install PySimpleGUI
pip install pycda
pip install opencv-python
pip install numpy

1.1.2. Step 4 - Run the app

Run the app using the following gui.py file:

python3 src/gui.py

1.2. Main Screen

This project has 4 buttons. They are:

1. Open Image and Run Prediction
2. Detect on Sample Image
3. Draw
4. Exit

1.3. 1.2 Buttons

Explanation on Buttons:

1.3.1. Open Image and Run Prediction

Here you can select any image from your computer and open it to run the automated crater detection. Results will be outputted to a CSV in the directory you specify.

1.3.2. Detect on Sample Image

Performs automated crater detection on a sample image from PyCDA. Useful to see how detailed results can be with error correction.

1.3.3. Draw

Allows the user to select any image from their computer and draw on it. Useful to manually draw craters on an image or to cross out craters that the program has incorrectly identified. Note: to use this feature, you must select the image you wish to draw on when the program starts.

1.3.4. Exit

Allows the user to exit the program. The user can also press the x at the top right to quit the program.

1.4. Video Demo of App

See a demo of the app here