Mercurial > repos > climate > cds_essential_variability
annotate README.md @ 2:b9d9fe0c2ce7 draft
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
author | climate |
---|---|
date | Sun, 23 Jun 2019 11:16:11 -0400 |
parents | 5c0ab9932311 |
children | 9ee8db6ffba3 |
rev | line source |
---|---|
0
5c0ab9932311
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 49926d09bb7d28f07b24050d25c40f2ae875d6f7
climate
parents:
diff
changeset
|
1 |
5c0ab9932311
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 49926d09bb7d28f07b24050d25c40f2ae875d6f7
climate
parents:
diff
changeset
|
2 # Copernicus Essential Climate Variables for assessing climate variability |
5c0ab9932311
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 49926d09bb7d28f07b24050d25c40f2ae875d6f7
climate
parents:
diff
changeset
|
3 |
5c0ab9932311
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 49926d09bb7d28f07b24050d25c40f2ae875d6f7
climate
parents:
diff
changeset
|
4 This tool allows you to retrieve Copernicus **Essential Climate Variables** for assessing climate variability from the [Copernicus Climate Data Store](https://cds.climate.copernicus.eu/#!/home). |
5c0ab9932311
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 49926d09bb7d28f07b24050d25c40f2ae875d6f7
climate
parents:
diff
changeset
|
5 |
5c0ab9932311
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 49926d09bb7d28f07b24050d25c40f2ae875d6f7
climate
parents:
diff
changeset
|
6 Copernicus ECV for assessing climate variability is available from the Copernicus portal at https://cds.climate.copernicus.eu/cdsapp#!/dataset/ecv-for-climate-change?tab=overview |
5c0ab9932311
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 49926d09bb7d28f07b24050d25c40f2ae875d6f7
climate
parents:
diff
changeset
|
7 |
5c0ab9932311
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 49926d09bb7d28f07b24050d25c40f2ae875d6f7
climate
parents:
diff
changeset
|
8 To be able to retrieve data, you would need to register and get your [CDS API key](https://cds.climate.copernicus.eu/api-how-to). |
5c0ab9932311
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 49926d09bb7d28f07b24050d25c40f2ae875d6f7
climate
parents:
diff
changeset
|
9 |
5c0ab9932311
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 49926d09bb7d28f07b24050d25c40f2ae875d6f7
climate
parents:
diff
changeset
|
10 The CDS API Key needs to be: |
5c0ab9932311
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 49926d09bb7d28f07b24050d25c40f2ae875d6f7
climate
parents:
diff
changeset
|
11 - located in a file called `.cdsapirc`in the HOME area |
2
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
12 (as defined the `HOME` environment variable). |
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
13 The file `.cdsapirc` should look like that: |
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
14 |
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
15 ``` |
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
16 url: https://cds.climate.copernicus.eu/api/v2 |
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
17 key: 111:8789787-qwerz4e47-888-not-real |
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
18 verify: 0 |
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
19 ``` |
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
20 - or passed in an enviroment variable called `GALAXY_COPERNICUS_CDSAPIRC_KEY`. |
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
21 This environment variable should contain a string that looks like that: |
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
22 ``` |
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
23 111:8789787-qwerz4e47-888-not-real |
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
24 ``` |
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
25 When passed in `GALAXY_COPERNICUS_CDSAPIRC_KEY`, make sure the key does not |
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
26 contain the string `key: ` but the key itself only (starting with a number). |
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
27 The file `.cdsapirc` will then be created and placed in the HOME area (using |
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
28 HOME environment variable). |
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
29 - or use `GALAXY_COPERNICUS_CDSAPIRC_KEY_FILE` to specify where your key file |
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
30 is stored on your system. |
b9d9fe0c2ce7
planemo upload for repository https://github.com/NordicESMhub/galaxy-tools/tree/master/tools/essential_climate_variables commit 6045302c39c9c11fb6a73966a364cc395f2f9b28
climate
parents:
0
diff
changeset
|
31 |