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

Provide descriptions of Climate Engine variables #383

Closed
Jdgilby opened this issue May 15, 2024 · 7 comments
Closed

Provide descriptions of Climate Engine variables #383

Jdgilby opened this issue May 15, 2024 · 7 comments
Assignees
Labels
enhancement New feature or request

Comments

@Jdgilby
Copy link
Collaborator

Jdgilby commented May 15, 2024

As they are now most variables to select are not intuitive. you would still have to go to climate engine to understand what to pull down.
image
For example: No idea what SHR, TRE, etc. stand for

@Jdgilby Jdgilby added the enhancement New feature or request label May 15, 2024
@KellyMWhitehead
Copy link
Collaborator

Unfortunately, the API does not provide me with the descriptions for the variables. This might be something we can as the Climate Engine folks about.

In the mean time, the descriptions can be found here: https://docs.climateengine.org/docs/build/html/variables.html. Might be worth adding a link to these descriptions on the form?

@philipbaileynar
Copy link
Contributor

Kelly, can you put a small square button beside the word "Variables" with an info icon (I think we are using question mark). This links to the URL you posted.

@KellyMWhitehead
Copy link
Collaborator

Button added for 0.3.20. We can revisit this if we gain access to the variable descriptions.

@EricRJensen
Copy link

EricRJensen commented May 15, 2024

We have our Climate Engine team meeting tomorrow and we'll discuss this. I think we can probably either a) add an endpoint for metadata/dataset_variables_names or or b) append a list of names to the existing dictionary returned by metadata/dataset_variables under the key 'variables_names'. I'll followup here after out meeting.

We store this information in dictionaries internally, so should be doable without too much trouble.
image

@EricRJensen
Copy link

We think we will add a list of variable names to the JSON returned from /metadata/dataset_variables, so there will still be the 'variables' key with a value of a list of variable names needed to run requests and then will also have a key of something like 'variables_names' with a value of a list of human readable variable names. I'm going to be on leave traveling from May 20-June 7, so @osheak will be in touch once we have a solution.

@EricRJensen
Copy link

Variable descriptions are now added in the metadata/dataset_variables endpoint
image

@KellyMWhitehead
Copy link
Collaborator

Thanks @EricRJensen, this integrated nicely.

The download form looks much better!

Image

Ready for version 0.3.24

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

No branches or pull requests

4 participants