Elliptical Pattern Identification

This project host's our work for identifying Gravitational Waves via Radiosonde data. Check out this README for further details.

Table of Contents

1. Getting Started
   • Downloading the Application
   • Using the Application
   • Want To Build the Project Yourself?
2. Bugs
3. Notes To Future Contributors
4. Contributors
5. Acknowledgments
6. License

Getting Started

Downloading the Application

** There currently is no pyinstaller build saved. i will do this in a few weeks when we get a mostly final build on the repo **

1. Navigate to Releases to download the application on your own machine.
2. You should see a list of folders starting with ApplicationForOS where OS is the operating system for the application. Download the folder for your specific operating system.
3. Once you have downloaded the folder, extract the contents.
4. Once you open the now extracted folder, select the dist folder. You should be able to see an application named EllipticalPatternIdentification with some operating system specific file extension like .exe. You can now open the application

Using the Application

1. Once you open the EllipticalPatternIdentification application, you should be able to see buttons to select files to process, along with various parameter inputs for the algorithm, and more.
2. Once you have inputted files into the program, you can use the buttons on the sidebar to look at files and their raw data along with data from the backend algorithms.
3. To actually process files, select the button Process Files. Processing may take a while, the window should update occasionally with the progress of processing the current file. Stopping processing will loose the results of the current file being processed.

Want To Build the Project Yourself?

1. Clone the repository to your local machine
2. Make sure you have the required dependencies installed.
   • Python 3
   • All Usual Python Modules
   • Tkinter Python Module
3. We suggest using anaconda since it has all of the relevant dependencies when you use Spyder.
4. Navigate to src -> main.py
5. Run main.py with your favorite python environment
   • main.py starts up the GUI, and the GUI interfaces with all of the backend algorithms

(back to top)

Bugs

As this application wasn't able to be tested to its fullest extent, bugs most likely will occur. They should be listed under issues. I (Rodney) will be semi-actively monitoring this repository over the summer to account for this. You can also email me at [email protected] if urgent bugs need fixing.

Notes To Future Contributors

In the design of this repository, having as little coupling as possible between the frontend and backend was essential. The front end is important but for testing, we wanted to be able to execute the backend by itself without any other front end code. There are only two locations where the front and backend actually connect, but i think pointing them out will make it so when future changes to the backend actually happen, people will not inevitably ignore the frontend since they don't want to update it.

1. The FileWindow class takes the data which is outputed by the back end and renders it on the screen. To be able to Cohesivly render that data, it obviously needs prior understanding of what data is outputted. To find and edit this code to render different data, navigate here.

2. The BackEndInterface executes the back end. It passes a single file path to ProcessSingleFile, where the backend can be set up and run. Unfortunately, when the frontend executes the backend the backend cant open any matplotlib visuals, it will throw many errors. To find and edit this code to execute the backend in the frontend, navigate here.

Contributors

Initially, this code base was created by Thomas Colligan.

Then, malachiRivkin's and kareece's expanded on Colligan's code, and ported it into Python, in their Original Work for the 2020 solar eclipse project. To contact those two, you can hopefully find malachiRivkin Here and kareece Here.

We have revamped and continued their work at this repository for our Senior Capstone Project. Our information is below. Any questions that aren't answered here should be sent to Dr. Bernards.

Rodney McCoy · Github Profile · Email · Phone

Riley Doyle · Github Profile · Email · Phone

Luis Lopez · Github Profile · Email · Phone

(back to top)

Acknowledgments

This project was also made with the assistance of Dr. Matthew Bernards and Konstantine Geranios, an Associate Professor and Graduate Student respectively, from the Chemical & Biological Engineering Department at the University of Idaho.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)