Upcoming Major Update 0.4.0: Scheduled for Mid May 2024

[dvm-shlee]

I am now targeting to complete the overhaul by the end of May 2024. Here’s a recap of what we’re working on and the current status:

• Code Clean-up: Enhance readability and efficiency of core modules.
• Reorganization: Streamline the structure of core modules.
• Refactoring Command-Line Scripts: Ongoing improvements to enhance usability.
• Documentation and Tutorials
• Enhanced Continuous Integration (CI): Integrate pytest, and automating release, packaging, and publishing processes.
• Plugin Module for BIDS Organization: Work in Progress.
• Image Reconstruction Helper: Implement a new Plugin architecture.
• Journal Publication: Aim to publish this project to open software / data science journal

Thank you all for your patience and continued support. Your involvement is invaluable as we move forward and improve our project together.

[dvm-shlee]

All,

Apologies for the delay in updates; it has been a busy period, but progress has been made toward the 0.4.0 release.

• 1. and 2. The core module for handling brkraw data has been cleaned up and reorganized into the API module. The original 'lib' module remains unchanged to maintain functionality. In future versions, the 'lib' module will be deprecated. The updated module currently lacks command-line scripts, but I anticipate the 'tonii' functionality to be completed by late April, followed by the new modular BIDS converter by mid-May, which will coincide with the 0.4.0 release.
• 3. This section might take some time, but I am currently using my own Jupyter notebook to test the new codes. I plan to include these updates on the release date.
• 4. Work in Progress.
• 5. Work in Progress (tentatively ready by mid-May with the release).
• 6. @timwahoo is currently assisting me, and the core module is ready. I am working on some boilerplate code to integrate image reconstruction functionalities, including the BIDS converter. Stay tuned.
• 7. After the release of version 0.4.0, I plan to comprehensively revise the existing manuscript draft.

[araikes]

I'm interested in seeing this in the wild. Anything I can do to help?

[dvm-shlee]

@araikes Thank you for your supportive message!

I’ve been dedicating most of my time to an ongoing group project, so I haven’t had the chance to make updates on this yet. I plan to start working on BrkRaw again from November 6, once the ISMRM abstract deadline has passed.

I’ve rewritten most of the code from scratch to simplify future maintenance and compatibility, and to provide extensibility by allowing custom reconstruction workflows to be integrated as plugins.

After releasing version 0.4.0, I’ll be sure to compile a list of areas where help would be appreciated. Thanks again for reaching out!