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

Order recipe output in index.html #1899

Merged
merged 4 commits into from
Jan 19, 2023
Merged

Order recipe output in index.html #1899

merged 4 commits into from
Jan 19, 2023

Conversation

bouweandela
Copy link
Member

@bouweandela bouweandela commented Jan 19, 2023

Description

This pull request updates how the index.html file is written during a run:

  • the order of diagnostics from the recipe is preserved
  • the output files of diagnostic scripts are sorted alphabetically

As requested in ESMValGroup/ESMValTool#3015 (reply in thread)


Before you get started

Checklist

It is the responsibility of the author to make sure the pull request is ready to review. The icons indicate whether the item will be subject to the 🛠 Technical or 🧪 Scientific review.


To help with the number pull requests:

@codecov
Copy link

codecov bot commented Jan 19, 2023

Codecov Report

Merging #1899 (6c6086e) into main (69a284d) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #1899   +/-   ##
=======================================
  Coverage   92.03%   92.03%           
=======================================
  Files         234      234           
  Lines       12034    12042    +8     
=======================================
+ Hits        11075    11083    +8     
  Misses        959      959           
Impacted Files Coverage Δ
esmvalcore/_task.py 71.62% <ø> (ø)
esmvalcore/_provenance.py 97.59% <100.00%> (+0.12%) ⬆️
esmvalcore/_recipe/recipe.py 96.19% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@bouweandela bouweandela marked this pull request as ready for review January 19, 2023 09:56
@bouweandela bouweandela requested a review from schlunma January 19, 2023 09:56
@bouweandela bouweandela added this to the v2.8.0 milestone Jan 19, 2023
@bouweandela bouweandela requested a review from mo-abodas January 19, 2023 09:58
@bouweandela bouweandela added the enhancement New feature or request label Jan 19, 2023
Copy link
Contributor

@valeriupredoi valeriupredoi 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, man! 🍺 Test case can be generalized a bit more with filenames that vary a bit more and are resemblant with provenance file names, but heyho - no biggie 😁

Copy link

@mo-abodas mo-abodas 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. I've tested my recipe with these changes and the plots are nicely ordered now. Thanks!

@schlunma
Copy link
Contributor

Nice one! @total_ordering seems very useful! Thanks @bouweandela 👍

@schlunma schlunma merged commit 1e4c408 into main Jan 19, 2023
@schlunma schlunma deleted the order-recipe-output branch January 19, 2023 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants