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

Move qc features into dedicated library #160

Merged
merged 28 commits into from
Sep 7, 2023
Merged

Move qc features into dedicated library #160

merged 28 commits into from
Sep 7, 2023

Conversation

gwbres
Copy link
Collaborator

@gwbres gwbres commented Sep 7, 2023

To continue the efforts to simplify and reduce the rinex/ crate code quantity, it makes a lot of sense to move the QC capacities into a dedicated library.

  • rinex/ is the parser and file production library and should contain just that.
    It contains high level extraction method, it can also contain specific estimators, like Rinex.phase() or Rinex.dcb() that is fine.
    But actual RINEX analysis should not take place in that library
  • rinex-qc is a library that provides structures to analyze a Rinex or a pool of Rinex structures.
    In the proposed form, it is solely the previous rinex::qc module moved into that library.
  • rinex-cli uses both

We use traits to make QcReports synthesis easy.
Traits can only be implemented on structures that are defined in that very library.
rinex and rinex-qc both need to implement the reporting traits. To solve that dual dependency, I propose to have a small qc-traits library that both can import. The library in the proposed form, only contains the HtmlReport trait, which is our only way to render a Qc report at the moment

All qc analysis moved into a module.

Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
…gress

Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
@gwbres gwbres added the enhancement New feature provided label Sep 7, 2023
@gwbres gwbres added this to the v1.0.0 milestone Sep 7, 2023
@gwbres gwbres self-assigned this Sep 7, 2023
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Copy link
Collaborator

@larsnaesbye larsnaesbye left a comment

Choose a reason for hiding this comment

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

Looks good to me, and it makes it more clear with the new structure.

Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
@gwbres gwbres merged commit c91517d into main Sep 7, 2023
@gwbres gwbres deleted the qc-crate branch September 7, 2023 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature provided
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants