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

RMS time projector #129

Merged
merged 10 commits into from
May 18, 2021

Conversation

gaurav-ganti
Copy link
Collaborator

@gaurav-ganti gaurav-ganti commented May 13, 2021

Pull request

Please confirm that this pull request has done the following:

  • Tests added
  • Documentation added (where applicable)
  • Example added (either to an existing notebook or as a new notebook, where applicable)
  • Description in CHANGELOG.rst added

Adding to CHANGELOG.rst

Please add a single line in the changelog notes similar to one of the following:

- (`#XX <https://github.com/GranthamImperial/silicone/pull/XX>`_) Added feature which does something
- (`#XX <https://github.com/GranthamImperial/silicone/pull/XX>`_) Fixed bug identified in (`#YY <https://github.com/GranthamImperial/silicone/issues/YY>`_)

Copy link
Collaborator

@Rlamboll Rlamboll left a comment

Choose a reason for hiding this comment

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

Looking good so far on the coding side. Things that need doing still:

  1. Update the changelog to mention this added feature
  2. Several lines in the notebook are out-of-date or hard to read. The intro still says there is only one tool, for instance. The legends on the plots could be more useful to explain which of the lines is the infilled one (particularly since it overlaps one of the pre-existing lines) - maybe make the infilled line dashed so we can see both?

@gaurav-ganti
Copy link
Collaborator Author

@Rlamboll

  1. Added
  2. Updated the notebook - descriptions fixed, linestyle in plot adjusted to see the underlying pathway, deprecation warnings thrown by pyam addressed by shifting from the line_plot() to plot()method.

Copy link
Collaborator

@Rlamboll Rlamboll left a comment

Choose a reason for hiding this comment

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

Great, just two minor points and you can merge

@@ -5,6 +5,7 @@ Work in progress
Added
~~~~~
- (`#126 <https://github.com/GranthamImperial/silicone/pull/126>`_) Added the first time projector (Extend latest time quantile) that extends a pathway to cover later times, assuming it remains at the same quantile.
- (`#129 <https://github.com/GranthamImperial/silicone/pull/129>`_) Added an additional time projector (Extend RMS closest) that extends a pathway to cover later times by selecting future data from the closest pathway.
Copy link
Collaborator

Choose a reason for hiding this comment

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

This should go above 126, since it came later. This way people only need to read the top items to get back on track. Description is good though.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks, corrected.

@@ -7,3 +7,4 @@
"""

from .extend_latest_time_quantile import ExtendLatestTimeQuantile # noqa: F401
from .extend_rms_closest import ExtendRMSClosest
Copy link
Collaborator

Choose a reason for hiding this comment

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

Our linter doesn't seem to mind, but adding the # noqa: F401 command means that using a proper linter won't complain that we're not going to get error messages about the fact that these imports aren't used here.

@gaurav-ganti gaurav-ganti merged commit 51f2352 into GranthamImperial:master May 18, 2021
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.

None yet

2 participants