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.

Sign up for GitHub

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

Jump to bottom

Allow usage of relative paths for diagnostic scripts #2328

Open
rbeucher opened this issue Feb 9, 2024 · 1 comment · May be fixed by #2329
Open

Allow usage of relative paths for diagnostic scripts #2328

rbeucher opened this issue Feb 9, 2024 · 1 comment · May be fixed by #2329

Comments

@rbeucher
Copy link
Contributor

rbeucher commented Feb 9, 2024 •
edited
Loading

Hi everyone,

Currently, in the diagnostic section of a recipe, the script must be either:

  • A valid path to an existing diagnostic shipped with ESMValtool (diagnostic root)
  • An absolute path to a diagnostic (not portable)

Looking at the code here, there is a third option (not sure that one is very useful though):

https://github.com/ESMValGroup/ESMValCore/blob/6f879cfbff20568ca6b9e2ea4667793a44bef2e5/esmvalcore/_task.py#L350C1-L358C70

It appears that things like ~/my_esmvaltool_diagnostics/my_diagnostic.py will expand to a valid location.

Absolute paths are not portable...
We are currently developing some material to teach people how to develop their diagnostics.
We would like to be able to ship a recipe.yml and a diagnostic.py together, with the recipe referencing the diagnostic using a relative path.

I propose to check for a local diagnostic script before appending the esmvaltool diagnostic root to the path.
PR coming.
This was referenced Feb 9, 2024
Open
Closed
@bouweandela
Copy link
Member

bouweandela commented Feb 12, 2024 •
edited
Loading

Note that there are actually several paths needed for a successful run:

  1. location of esmvaltool/diag_scripts
  2. location of esmvaltool/config-references.yml
  3. location of esmvaltool/references
  4. location of esmvaltool/recipes (if a relative path to a recipe is provided)
  5. location of esmvaltool/interface_scripts (only for NCL diagnostics)

Maybe the best solution would be to add a new configuration option diagnostic_package_dir or something similar to the configuration file/command line and make that point to the installed esmvaltool package by default with a fallback to the current working directory.

See #826 for some previous, slightly outdated, discussion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Allows relative paths for diagnostic scripts. ESMValGroup/ESMValCore
2 participants
@rbeucher @bouweandela