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

feat: mock scatter plot functionality #279

Merged
merged 6 commits into from
Aug 19, 2024
Merged

Conversation

gunnarstaff
Copy link
Contributor

@gunnarstaff gunnarstaff commented Aug 4, 2024

Description

The added functionality allows you to create a time series where the timestamps is scaled with the "x-parameter", such that the scatter plot is superimposed on the time series chart. Both the "x-vector" and the "y-vector" are calculated, allowing you to plot the "x-vector" allowing you to read the x-value in addition to the y-value

Motivation and Context

Today it is not possible to plot scatter type of plots. This is a very important tool in many situations where the change over time is not the most important factor, but instead change as a function of another parameter. Typical examples are equipment performance as a function of load, choke performance as a function of opening,+++

How Has This Been Tested?

Tested for a production choke CV curve case where the output is superimposed on the timeseries plot
Tested on Windows 11 using python 3.10.7

Screenshots (if appropriate):

mock_scatter

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • Refactor (non-breaking change which improves implementation)
  • Performance (non-breaking change which improves performance. Please add associated performance test and results)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Non-functional change (xml comments/documentation/etc)

Contributor Checklist:

  • My code follows the code style of this project.
  • I have added an example of my new feature and included it in the documentation.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • My Pull Request name follows the naming convention fix: <description>, feat: <description>, etc.

Reviewer Checklist for Charts compliant functions:

  • The docstrings of the new function follow the contributing guidelines.
  • The new function is professionally documented
  • The new function and associated scripts are covered by one or more unit tests and code coverage did not decrease.
  • The new function is accompanied by an example and it is included in the Gallery of Charts.
  • The new function is reviewed in Chromatic. Access the storybook build results url and comment, approve or deny.
  • All function inputs, arguments, and outputs have a supported data type and have human readable names.
  • No code language is included in the description of the function or parameters (e.g use "polynomial order" instead of "poly_order")

@gunnarstaff gunnarstaff requested review from a team and redzaroslii August 4, 2024 08:41
Copy link

codecov bot commented Aug 4, 2024

Codecov Report

Attention: Patch coverage is 96.66667% with 1 line in your changes missing coverage. Please review.

Project coverage is 91.28%. Comparing base (9f4450c) to head (665d14d).
Report is 1 commits behind head on main.

Files Patch % Lines
indsl/resample/mock_scatter_plot.py 96.29% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #279      +/-   ##
==========================================
+ Coverage   91.25%   91.28%   +0.03%     
==========================================
  Files         106      107       +1     
  Lines        3863     3891      +28     
  Branches      839      845       +6     
==========================================
+ Hits         3525     3552      +27     
  Misses        208      208              
- Partials      130      131       +1     
Files Coverage Δ
indsl/resample/__init__.py 100.00% <100.00%> (ø)
indsl/resample/mock_scatter_plot.py 96.29% <96.29%> (ø)

Copy link

github-actions bot commented Aug 4, 2024

Unit Test Results

    15 files  ± 0      15 suites  ±0   26m 1s ⏱️ -7s
 1 117 tests + 3   1 117 ✅ + 3  0 💤 ±0  0 ❌ ±0 
11 022 runs  +27  11 013 ✅ +27  9 💤 ±0  0 ❌ ±0 

Results for commit 665d14d. ± Comparison against base commit 9f4450c.

♻️ This comment has been updated with latest results.

@23andreas 23andreas removed the request for review from redzaroslii August 19, 2024 11:30
@23andreas 23andreas merged commit 038f6cd into main Aug 19, 2024
25 checks passed
@23andreas 23andreas deleted the gstaff/mock_scatter_plot branch August 19, 2024 11:37
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.

3 participants