KylerKupp / python-desktop-app

MIT License
0 stars 0 forks source link

Python Desktop App

Project summary

One-sentence description of the project

Add additional functionality and compatibility to platform for data acquisition, manipulation, and presentation.

Additional information about the project

The current custom designed software is operational and collects data from our instrument every 2-3 seconds and then processes this information through calculations and manipulations in near real-time. These experiments can run for 3-8 hours per day and generate a lot of data, some of which is not needed. Therefore, the data is continuously plotted in real-time, and the software allows us to extract key data points and calculated parameters at specific timepoints throughout the acquisition. Previous students in this course developed a working Python platform that need that needs additional functions and to be able to access data from a new instrument. The goal of this project is to enhance the function of the current Python system for additional functionality.

Installation

Prerequisites

TODO: List what a user needs to have installed before running the installation instructions below (e.g., git, which versions of Ruby/Rails)

Add-ons

TODO: List which add-ons are included in the project, and the purpose each add-on serves in your app.

Installation Steps

TODO: Describe the installation process (making sure you mention bundle install). Instructions need to be such that a user can just copy/paste the commands to get things set up and running.

Functionality

TODO: Write usage instructions. Structuring it as a walkthrough can help structure this section, and showcase your features.

Known Problems

TODO: Describe any known issues, bugs, odd behaviors or code smells. Provide steps to reproduce the problem and/or name a file or a function where the problem lives.

Contributing

TODO: Leave the steps below if you want others to contribute to your project.

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Additional Documentation

TODO: Provide links to additional documentation that may exist in the repo, e.g.,

License

If you haven't already, add a file called LICENSE.txt with the text of the appropriate license. We recommend using the MIT license: https://choosealicense.com/licenses/mit/