Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Report artifact enhancements, README, Python 3.10.6 support #357

Merged
merged 17 commits into from
Oct 29, 2024

Conversation

tab-cmd
Copy link
Contributor

@tab-cmd tab-cmd commented Oct 25, 2024

Overview

After meeting with the neurophysiology and clinical team, several changes were needed to support the new BciPy report. This fixes some errors found, sets new defaults, adds a demo, and cleans up some of the documentation. Upgrades MNE.

Ticket

(https://www.pivotaltracker.com/story/show/188110245)

Contributions

  • demo_calibration_report.py: A demo to show how to run the action and allow the report to be generated offline in case of failures in the field
  • bcipy/helpers/stimuli.py: fix baseline designation
  • bcipy/helpers/convert.py: change the default to mV (most common).
  • bcipy/gui/file_dialog.py: allow for prompt in loading of directories
  • bcipy/signal/evaluate/artifact.py: WIP, change defaults, add more logging
  • bcipy/task/actions.py: Update the BciPyCalibrationReport to prompt for the protocol directory if not provided. Pass the correct labels to visualize_erp. Add some logging.
  • setup.py: to include python 3.10.6. Note this breaks editable installs and some console scripting. However, much of the library would still work as a package. This is expected, even if undesired see 1 and 2. A ticket was created to refactor our builds to support future versions of python here. When upgrading to 3.11, we may have to lose support for 3.8. However, other dependencies can then be upgraded (mne, etc.).

Test

  • make test-all
  • Verified reports generated with @danielpklee

Documentation

  • Are documentation updates required? In-line, README, or documentation? Yes! Updates READMES and typing where applicable.

Changelog

  • Is the CHANGELOG.md updated with your detailed changes? N/a

@tab-cmd tab-cmd changed the title Report artifact enchancements Report artifact enhancements, README, Python 3.10.6 support Oct 25, 2024
@tab-cmd tab-cmd marked this pull request as ready for review October 25, 2024 22:03
@tab-cmd tab-cmd requested a review from lawhead October 25, 2024 22:03
@@ -15,7 +15,7 @@ class FileDialog(QWidget):

def __init__(self):
super().__init__()
self.title = 'PyQt6 file dialogs - pythonspot.com'
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch. Looks like that was left over from a copy-paste.

PEAK_THRESHOLD = 75e-7
PEAK_MIN_DURATION = 0.005
PEAK_THRESHOLD = 15e-6
PEAK_MIN_DURATION = 0.001
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be useful to have a comment or documentation somewhere about how these values were determined.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will add a comment; before we release 2.0, I am proposing a few enhancements to this module that should help with configuration and use. https://www.pivotaltracker.com/story/show/188483451

@tab-cmd tab-cmd merged commit 437e720 into 2.0.0rc4 Oct 29, 2024
9 checks passed
@tab-cmd tab-cmd deleted the report_artifact_enchancements branch October 29, 2024 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants