search

FREVA-CLINT / freva

The Free Evaluation System Framework (FreVa)
Other
10 stars 3 forks source link

Esgf docu #138

Closed eelucio closed 11 months ago

eelucio commented 1 year ago

branch where the documentation of freva.esgf or freva-esgf has been added.

Examples about the flag 

--query QUERY         Display results from <list> queried fields (default: None)

have not been added as I have no idea what it does.

eelucio commented 1 year ago

@antarcticrainforest . I just updated the separation of methods for esgf. I also corrected typos all around the code and documentation.

eelucio commented 11 months ago

Just a thought: have you thought about shell completion?

I probably am wrong but these queries are not done against a solr with known facets, this is only the api to the esgf api: cmip6, cmip5, cordex still preserver their syntax, for example:

freva esgf project=cmip6 product=scenariomip model=cnrm-cm6-1 institute=cnrm-cerfacs experiment=ssp585 time_frequency=3hr variable=uas ensemble=r1i1p1f2 distrib=false latest=true

will not produce results, but 

freva esgf mip_era=CMIP6 activity_id=ScenarioMIP source_id=CNRM-CM6-1 institution_id=CNRM-CERFACS experiment_id=ssp585 frequency=3hr variable=uas variant_label=r1i1p1f2

will.

The fact that we are (in principle) looking at all the nodes in the ESGF (if not stated otherwise) I do not know what will do if we let autocomplete for the facet values, as well.

But I can try it in a next MR.

antarcticrainforest commented 11 months ago

LGTM once tests are fine!