Changes between Version 49 and Version 50 of ESGFToolsUI


Ignore:
Timestamp:
May 5, 2014 5:46:43 PM (7 years ago)
Author:
terryk
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ESGFToolsUI

    v49 v50  
    11[[TOC]]
    22
    3 == What is ESGF Tools UI? ==
     3= What is ESGF Tools UI? =
    44
    55A tool that is integrated in [[http://www.unidata.ucar.edu/downloads/netcdf/index.jsp|ToolsUI NetCDF Java]] for including a desktop client for [[https://github.com/ESGF/esgf.github.io/wiki|ESGF services]], with features like search of data along multiple nodes, download manager and metadata aggregation for allowing a full exploration through dataset services.
     
    1010[[Image(tabs.png, 65%)]]
    1111
    12 == Getting started ==
    13 
    14 === Pre-requisites===
     12= Getting started =
     13
     14== Pre-requisites==
    1515    JDK from Sun / Oracle (1.5 - newer) or OpenJDK 6
    1616
     
    1818
    1919
    20 === Installation ===
     20== Installation ==
    21211. Download the zip in [raw-attachment:ESGFToolsUI-v0.4.1.zip]
    22222. Unzip it
     
    3030    }}}
    3131
    32 == Search of ESGF Climate Data ==
     32= Search of ESGF Climate Data =
    3333A search in ESGF returns the records that matching the search constraints after querying to  an index node. The ESGF search service is always served by a index node and this node is able to do local and distributed searches. In this tool, the distributed capabilities of the ESGF are used so any selected index node will be used to query all nodes in the ESGF system.
    3434
     
    3838[[Image(pestana-search.png)]]
    3939
    40 === Selecting a index node ===
     40== Selecting a index node ==
    4141[[Image(index_node_comboBox.png, align=left, margin=10)]] The searches are executed in a index node of the federation. Each node have different processing times for the response. For this reason, the user is allowed to select the index node where prefers send the search petition.[[BR]]
    4242The index node may be configured in the top left drop-down list. After selected a new index node the search panel is updated.
     
    5050
    5151
    52 === Selecting search parameters ===
     52== Selecting search parameters ==
    5353The search parameters can be configured on the panel in two ways:
    5454* By values selection in tree of parameters `double click`
     
    5757[[Image(parametros_comboBox.png)]]
    5858
    59 === Selecting search parameters: Tree of parameters ===
     59== Selecting search parameters: Tree of parameters ==
    6060
    6161The tree of parameters shows the parameters with bounded values which are defined by the federation. In the first level is the name of the parameter and the number of its bounded values. In the second level are the parameter values, each one with the count of records that satisfy the previous configured constraints (restrictions that are listed in the "configured parameters" section) + the new constraint (parameter-value).
     
    8282After adding new parameters the search panel is updated (“Add parameters” button). Now in the tree, all parameters that already have values configured only shows this values. This happens because the allowed values ​​for a parameter are always those that do not result in an empty set if they are selected. To configure a parameter previously configurated you can uncheck the previously configured values and then click on "Add parameters" or you can remove them in "Configured parameters" section.
    8383
    84 === Selecting search parameters: drop-down list of parameters ===
     84== Selecting search parameters: drop-down list of parameters ==
    8585The parameter selection in drop-down list (top right) allows values configuration of some parameters. In this list are contained the parameters without bounded values and that for this reason can't be configured in the tree of parameters. Also contains the parameters with bounded values.
    8686After selecting a list parameter, below of the list will be displayed a specific configuration panel for the selected parameter.
     
    9191
    9292
    93 === Selecting search parameters: configured parameters ===
     93== Selecting search parameters: configured parameters ==
    9494All configured parameters are displayed in a specific panel in bottom left. In this panel are listed the configured parameters with its values assigned.
    9595
     
    100100This panel also allow to select a parameter and delete its configuration doing click on "Remove" and delete all parameters configuration doing click on "Remove all"
    101101
    102 === Using free text search ===
     102== Using free text search ==
    103103The free-text search o  full text search allows to do a search rich in syntax, by arbitrary words, logic operations and wild-cards. In this case, the records searched will be records that contains metadata that are related with what is specified in the free text query.
    104104
     
    127127}}}
    128128
    129 === Save a search ===
     129== Save a search ==
    130130A configured search can be saved for later for to be able do a harvesting of metadata and services of datasets that satisfy the search constraints. The save section is in right bottom of search panel. You can overwrite the selected search with "Save search" button or save it with a new name clicking on "Save Search As..." button.[[BR]]
    131131[[Image(save_options.png, margin=10)]][[Image(ventana_nombre_busqueda.png)]]
    132132[[NoteBox(note, The name of search must be unique. Duplicated names aren't allowed)]]
    133133
    134 === Select a saved search ===
     134== Select a saved search ==
    135135You can select a previously saved search from the right top drop-down list. After select a search, the search panel is updated.[[BR]]
    136136
    137137[[Image(save_search-comboBox-2.png, 23%)]]
    138138
    139 === Reset search panel ===
     139== Reset search panel ==
    140140To restart the search panel must be selected in the drop-down list the option: `<<New search>>`
    141141
    142 == Metadata Harvesting of ESGF Datasets of a search ==
     142= Metadata Harvesting of ESGF Datasets of a search =
    143143The metadata harvesting will allow, after completed, download the datasets from multiple data nodes, and will allow exploring climate datasets without having to download the dataset itself . So we can know its nature in detail before selecting them to download or we can know the services offered from ESGF to access and/or explore the dataset. Some of these services can be explored from ToolsUI NetCDF Java as will be explained after.
    144144
     
    147147[[Image(harvesting_panel_2.png)]]
    148148
    149 === What is a ESGF Dataset? ===
     149== What is a ESGF Dataset? ==
    150150Dataset is a climate data in a specific version stored by ESGF. One dataset may have several records i.e. the records are the physical replica of a dataset in a data node.
    151151
     
    154154[[NoteBox(tip, Datasets\, files and aggregations have replicas in data nodes. And the ESGF services (THREDDS\, LAS\, HTTP\, GridFTP and OPeNDAP) are always served at replicas level. That is the reason why the harvesting must be done before the download.)]]
    155155
    156 === Search Harvesting Panel ===
     156== Search Harvesting Panel ==
    157157The harvesting panel may be selected clicking on  the sub-tab "Search Harvesting". In this panel are deployed a list of searches and their harvesting states. Also, provides several options for flow control, complete exploration of harvested datasets and the posibility to do a manual selection of files to put them in download queue.
    158158
     
    174174||`Download ...`||is visible when harvesting of search is completed. Allows to put  to download all files that satisfy the constraints of the search or to put to download a set of files manually selected of  the search||
    175175
    176 === Exploring search harvesting ===
     176== Exploring search harvesting ==
    177177To exploring the search harvesting of a search you must click on `Explore Search` option that is always visible in harvesting panel. And then a window pops up with the exploring options.
    178178
     
    185185[[Image(explore_search_2.png)]]
    186186
    187 === Exploring search harvesting : Harvesting view ===
     187=== Harvesting view ===
    188188`Harvesting View` option allows to explore a dataset in a tree view. Here you can explore the metadata for datasets that include files, replicas of datasets, replicas of files and finally, ESGF services offered for explore them (by URL endpoint).
    189189
     
    193193[[Image(tree_view_2.png)]]
    194194
    195 === Exploring search harvesting : Open metadata ===
     195=== Open metadata ===
    196196`Open metadata` option allows to explore an abstract of metadata of a dataset in a table view.
    197197
    198198[[Image(metadata_table_view.png)]]
    199199
    200 === Exploring search harvesting : Download Dataset - File selection window === #idExploringDownloadFile
     200=== Download Dataset - File selection window === #idExploringDownloadFile
    201201`Download Dataset...` allows to manually select the files that will be put to download. In the top of window can see the id of dataset, the number of files selected, the total number of files of the dataset, the size in bytes of the sum of selected files and the total size of the whole dataset.
    202202
     
    215215[[Image(change_path_of_downloads.png)]]
    216216
    217 === Export to Metalink ===
     217== Export to Metalink ==
    218218To export  the search to Metalink you must click on "Export to Metalink". This option is is visible when harvesting of search is completed. And then a window pops up with the save options.
    219219
     
    229229[[NoteBox(warn, Note that if you want use a external client to download ESGF files you must configure the client for using the `ESGF certificates`.)]]
    230230
    231 === Download a Search  ===
     231== Download a Search  ==
    232232To put  the files that belongs to a search in downloads queue you must click on `Download ...`. This option is visible when harvesting of search is completed. And then a window pops up with the download options.
    233233
     
    244244For manually selection you may click on "Select file to Download", that displays a file selection window as explained in [[#idExploringDownloadFile|Exploring search harvesting : DownloadDataset - File selection window]]
    245245
    246 == Download of ESGF Datasets ==
     246= Download of ESGF Datasets =
    247247To download ESGF Datasets you must done previously a harvesting of a search. The downloads panel is in "Download" tab.
    248248
     
    278278[[NoteBox(tip,If you is logged in ESGF and there are files with "Unauthorized state" is because the groups they are associated with the user account in the federation do not have permissions for that data.\\\\ To join a group with the needed permissions for a unauthorized file\, view [wiki:ESGFToolsUI_Manual#Joinagroupwiththeneededpermissionsforaunauthorizedfile Join a group with the needed permissions for an unauthorized file])]]
    279279
    280 === Dataset download options ===
     280== Dataset download options ==
    281281The dataset options are in a context menu that is displayed right-clicking in a dataset element. Depending on the state of download are displayed different options:
    282282||`Download all`||Put all files added to download queue to download||
     
    290290[[Image(Catalog_Chooser_THREDDS.png)]]
    291291
    292 === File download options ===
     292== File download options ==
    293293The file options are in a context menu that is displayed right-clicking in a file element. Depending on the state of download are displayed different options:
    294294
     
    303303[[Image(menuDatasetFileInDownloads.png)]]
    304304
    305 == ESGF Login : Obtaining credentials with ESGF Account ==
     305= ESGF Login : Obtaining credentials with ESGF Account =
    306306To login you must select the "Login" tab. Login allows retrieve the credentials needed to download the most of data in the federation.
    307307
     
    315315[[Image(login_logged.png)]]
    316316
    317 === Join a group with the needed permissions for a unauthorized file ===
     317== Join a group with the needed permissions for a unauthorized file ==
    318318[[NoteBox(tip, '''Check''' that you are logged in.  If you are logged and the `Unauthorized` state remains then you must do the follow steps)]]
    319319