Skip to content

Latest commit

 

History

History
82 lines (67 loc) · 6.02 KB

README.md

File metadata and controls

82 lines (67 loc) · 6.02 KB

Logo

cometrics is a Windows-based computer program that allows for the real-time coregistration of frequency- and duration-based behavior metrics, physiological signals from an Empatica E4, and video data.
Explore the docs »

Get it from Microsoft

Download cometrics
Report Bug · Request Feature

Contributors Forks Stargazers Issues MIT License

cometrics GUI

Introduction

Cometrics has been designed to integrate directly into the workflow of the Severe Behavior Department at the Munroe-Meyer Institute in the University of Nebraska Medical Center, while simplifying multiple manual steps into a few mouse clicks. By using a tracker spreadsheet, a patient's entire history can be collected into a single document from the software with your own specified graphs and format within that spreadsheet. You can find an example of a tracker spreadsheet here.

Tutorials

Common issues, approaches, and techniques are covered by our tutorials, which will be added to over time!

License

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

Bug Reporting

To report a bug, please open an issue in the main repository here and follow the instructions in the user guide.

Getting Started

Clinicians and Researchers

The latest compiled binaries for the Windows platform can be found in the Releases section of the repository. To install the program on your system download the latest Windows MSI installer release to your system and double click the downloaded file to start the installation. The logs directory will be created in your C: drive and the config.yml file will update with your system parameters. To uninstall the program, simply double click the original Windows MSI installer and select 'Remove cometrics'. If you run into any issues, please make a report in the Issues section of the repository and a maintainer will address the problem and help you get started.

Developers

  • Clone the repo and install the module in developer mode
git clone https://github.com/Munroe-Meyer-Institute-VR-Laboratory/cometrics.git
python ./cometrics/setup.py develop

The codebase is built using Python 3.8 and the IDE used is PyCharm.

Contribute

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Update the user guide if visual changes or changes to external functionality were made
  6. Open a Pull Request

Contact

The active developer and maintainer of this project is Walker Arce, reach out to him via email with any inquiries (wsarcera@gmail.com).