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

[refactor] brkraw api and update for future version #167

Merged
merged 15 commits into from
Apr 30, 2024

Conversation

dvm-shlee
Copy link
Member

Major Update: Redesign of Modular Architecture

This pull request implements significant architectural changes, enhancing the modularity and functionality of our codebase. Below are the key changes proposed:

API Architecture

  • api.pvobj: Enhanced to parse raw data, now supports zip-compressed files through the zipfile module. Introduces PvFiles for loading individual files.
  • api.analyzer: Serves as middleware to analyze datasets, ensuring compliance with current standard parsing and conversion procedures.
  • api.helper: A utility module designed to fetch parameters specific to functions, such as orientation and protocol. Integrates internal parameter file processing into the data and analyzer modules.
  • api.data: Acts as the backbone for file interfacing, converting raw data into Python-compatible datasets. Provides access to affine transformations, processed parameters, and converted images in numpy arrays.

Application Module

  • Focuses on user interfaces like command line tools, Python interfaces, and GUIs. This update includes the tonifti app without CLI. It marks a step towards a fully featured brk-tonifti app with CLI, supporting customized conversion solutions.

Plugin and Control Updates

  • api.plugin and api.ctl: Scheduled for updates in the next pull request.

Library Module Transition

  • The lib module is phasing out but remains integral in this update, serving as a major interface until the new CLI is introduced.

Documentation and Contribution

  • Updated contributing documents to reflect the new modular approach and the isolation of repositories that require frequent updates or active user contributions, enhancing the pull request review process and CI efficiency.

Related Issues

This pull request addresses several issues that have been identified in our application:

While this update makes significant progress towards resolving these issues, complete resolution is expected in subsequent pull requests as part of ongoing improvements to our application’s architecture. This update represents a critical step towards enhancing adaptability and user experience.

@BrkRaw/Bruker

@dvm-shlee dvm-shlee merged commit f5f1534 into BrkRaw:main Apr 30, 2024
22 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.

1 participant