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

Add esmvaltool compare command to compare the results of two recipe runs #2383

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

alistairsellar
Copy link
Contributor

@alistairsellar alistairsellar commented Mar 28, 2024

Description

Add an esmvaltool compare command to compare the results of two recipes runs, exposing the functionality of esmvaltool/utils/testing/regression/compare.py on the command line.

Closes #2381

Link to documentation: TBA


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.

@alistairsellar alistairsellar changed the title Add esmvaltool compare command to run esmvaltool/utils/testing/regression/compare.py Add esmvaltool compare command to compare the results of two recipe runs Apr 15, 2024
@alistairsellar alistairsellar added the enhancement New feature or request label Apr 15, 2024
@alistairsellar
Copy link
Contributor Author

Hi @bouweandela, here is a draft of how the new esmvaltool compare command could work. Early comments welcome.

It runs successfully for me, in an esmvaltool environment. However, GitHub tests fail, I think because esmvaltool is not available for esmvalcore testing (E ModuleNotFoundError: No module named 'esmvaltool'). This would make sense, because you want to be able to test esmvalcore standalone without a dependency on esmvaltool.

If I've understood that correctly, would you have any concerns about me moving compare.py from the esmvaltool repository to esmvalcore?

Also, I'd welcome your opinion on what tests should be added for a new command, and where/whether documentation should be updated. On the second question, as far as I can tell, some commands are documented in the "getting started" section. This compare command could be described at the end of https://docs.esmvaltool.org/projects/ESMValCore/en/latest/quickstart/output.html?

@bouweandela
Copy link
Member

It runs successfully for me, in an esmvaltool environment. However, GitHub tests fail, I think because esmvaltool is not available for esmvalcore testing (E ModuleNotFoundError: No module named 'esmvaltool'). This would make sense, because you want to be able to test esmvalcore standalone without a dependency on esmvaltool.

The easiest solution would be to just add it here instead of in this repository: https://github.com/ESMValGroup/ESMValTool/blob/b8a7b364d141c404a49cae33e7aeabb5fbf7cc36/setup.py#L255

Or are you keen on including this in ESMValCore?

@alistairsellar
Copy link
Contributor Author

The easiest solution would be to just add it here instead of in this repository: https://github.com/ESMValGroup/ESMValTool/blob/b8a7b364d141c404a49cae33e7aeabb5fbf7cc36/setup.py#L255

Ahah! Thanks @bouweandela - I'll do that.

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.

Add esmvaltool compare command to run esmvaltool/utils/testing/regression/compare.py
2 participants