Mercurial > repos > climate > cads
annotate README.md @ 0:b768e517a7d0 draft default tip
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
author | climate |
---|---|
date | Sat, 19 Jun 2021 18:35:50 +0000 |
parents | |
children |
rev | line source |
---|---|
0
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
1 |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
2 # Copernicus Atmosphere Data Store (ADS) |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
3 |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
4 This tool allows you to retrieve [Copernicus Atmosphere Data Store (ADS)](https://ads.atmosphere.copernicus.eu/cdsapp#!/home). |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
5 |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
6 - Any user willing to use this tool needs to [create a new account](https://ads.atmosphere.copernicus.eu/user/register?destination=/). |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
7 - Compose your request directly on ADS and copy/paste it in the input field "Request" |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
8 - Users need to add their ADS API Key to Galaxy (see below). Documentation on where to get the ADS API key can be found [here](https://ads.atmosphere.copernicus.eu/api-how-to). |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
9 - Be aware that for being able to download dataset from ADS, users also need to agree to their term of use (Licence to use Copernicus Products) on the ADS website. |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
10 |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
11 ## Set up user credentials on Galaxy |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
12 |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
13 To enable users to set their credentials and provide their ADS API Key for this tool, |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
14 make sure the file `config/user_preferences_extra.yml` has the following section: |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
15 |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
16 ``` |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
17 cads_account: |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
18 description: Your Copernicus ADS API Key (Copernicus Atmosphere Data Store API Key) |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
19 inputs: |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
20 - name: cads_apikey |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
21 label: Copernicus ADS API Key |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
22 type: password |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
23 required: True |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
24 ``` |
b768e517a7d0
"planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/cads commit 778688ee8d14e22b00b648858ad9bd1c2f46b1e0"
climate
parents:
diff
changeset
|
25 |