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

Implement New Plugin Architecture and Prepare for 0.4.0 Release #169

Merged
merged 18 commits into from
May 6, 2024

Conversation

dvm-shlee
Copy link
Member

Fixes #110 #127 #132 #135 #146 #155

Changes Proposed in This Pull Request:

  • New Plugin Architecture: Introducing the new plugin architecture with BrkRaw-snippets. The tonifti app can now integrate reconstruction middleware.
  • Unified Modules in 0.4.0: In the upcoming official release of 0.4.0, all data conversion and reconstruction processes across BrkRaw applications (including tonii, bids, gui, and backup apps) will utilize a consistent, dedicated module.
  • Documentation Enhancements: Continued improvements in documentation, enhancing clarity and usability across modules.
  • Version 0.4.0 Preparation: Tentatively updating version information to 0.4.0, targeting completion by May 15th.
  • Coding Standards and Testing: Integration of a style guide and Pytest practices in preparation for the next upgrade. Includes updates for initial testing purposes and testing readiness with a new dataset.

@BrkRaw/brkraw

- missing config initiation at project root
- several minor tonifti app related bug fix included
- version upgrade to 0.4.0 upon new feature
- Enable SnippetsFetcher to automatically search for remote content upon invocation.
- Add the first version of docstrings throughout the module to improve code documentation.
- Revise and enhance docstrings throughout the module to improve code documentation and readability.
- Add detailed descriptions for class methods and properties, focusing on parameters and behaviors.
…tence

- Integrate `PathResolver` as a parent class across the `__init__.py` and `study.py` modules to standardize and normalize all path operations using `_resolve(path)`.
- Fix a critical bug in `study.py` where study information was lost after execution. Now, study info persists correctly, enhancing data reliability for MRI scans and raw dataset sessions.
- Ensure consistent and accurate path handling and data retention across the module.
…ndition

- Correct the misplaced type annotation that caused a 'type not found' error when the TYPE_CHECKING condition was active.
- Ensure type annotations are correctly placed and accessible, preventing runtime errors in the parameters module.
- Enhanced docstrings in `PvStudy`, `PvScan`, `PvReco`, and `PvFiles` classes for better clarity and consistency.
- Improved method descriptions, parameter details, and added examples where missing.
- work in progress, unstable code
@dvm-shlee dvm-shlee merged commit 4ddcc16 into BrkRaw:main May 6, 2024
10 checks passed
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.

[Notice] Future Release Schedule and Invitation for New Maintainers
1 participant