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

Improve qc context definition and reporting #140

Merged
merged 4 commits into from
Aug 27, 2023
Merged

Improve qc context definition and reporting #140

merged 4 commits into from
Aug 27, 2023

Conversation

gwbres
Copy link
Collaborator

@gwbres gwbres commented Aug 27, 2023

Introduce a QcContext structure to manage Input Data (both parsed data as Rinex and file sources as PathBuf).

The current implementation makes it hard to report which file was provided by user, which is a nice teqc feature we should emulate.

The new QcContext defines the provided Data (files pool): and the idea is to build them once at the start of the application and avoid copying this structure.

The QC report creation methods have also been improved. The previous API involved two calls: QcReport::new and then QcReport::to_html(). The problem with this dual process is the need to store the context in between, which we want to avoid for efficiency.

This is now simplified to QcReport::html() to create the report, at once.

The workspace has been moved to rinex-cli/workspace and is managed better thanks to the use of std::Path instead of simple strings. It is not possible to customize the workspace location at the moment, that will come later.

Improved the QC reporting:

  • report source files and their types
  • move Header section into an HtmlReport implementation, inside header.rs.
  • have more structures implement HtmlReport to report them easily
  • Separate analysis better, in the generated report

@gwbres gwbres force-pushed the rinex-qc branch 4 times, most recently from 7c6d73a to 1a0e7ef Compare August 27, 2023 13:46
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
gwbres added 2 commits August 27, 2023 16:09
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
@gwbres gwbres changed the title Improve qc plotting context definitions Improve qc context definition and reporting Aug 27, 2023
Signed-off-by: Guillaume W. Bres <guillaume.bressaix@gmail.com>
@gwbres gwbres self-assigned this Aug 27, 2023
@gwbres gwbres added the enhancement New feature provided label Aug 27, 2023
@gwbres gwbres added this to the v1.0.0 milestone Aug 27, 2023
@gwbres gwbres requested a review from larsnaesbye August 27, 2023 14:46
@gwbres gwbres marked this pull request as ready for review August 27, 2023 14:46
@gwbres gwbres requested a review from lnicola August 27, 2023 14:47
@gwbres gwbres merged commit de8fce1 into main Aug 27, 2023
@gwbres gwbres deleted the rinex-qc branch August 27, 2023 17:15
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