diff 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Sat Jun 19 18:35:50 2021 +0000
@@ -0,0 +1,25 @@
+
+# Copernicus Atmosphere Data Store (ADS)
+
+This tool allows you to retrieve [Copernicus Atmosphere Data Store (ADS)](https://ads.atmosphere.copernicus.eu/cdsapp#!/home).
+
+- Any user willing to use this tool needs to [create a new account](https://ads.atmosphere.copernicus.eu/user/register?destination=/).
+- Compose your request directly on ADS and copy/paste it in the input field "Request"
+- 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).
+- 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.
+
+## Set up user credentials on Galaxy
+
+To enable users to set their credentials and provide their ADS API Key for this tool,
+make sure the file `config/user_preferences_extra.yml` has the following section:
+
+```
+    cads_account:
+        description: Your Copernicus ADS API Key (Copernicus Atmosphere Data Store API Key)
+        inputs:
+            - name: cads_apikey
+              label: Copernicus ADS API Key
+              type: password
+              required: True
+```
+