<commit_before>
Install
-------

Install via `pip` with::

    $ pip install cdsapi


Configure
---------

Get your API key from the CDS portal and write it into the configuration file::

    $ vim ~/.cdsapirc

Test
----

    $ python
    >>> import cdsapi
    >>> cds = cdsapi.Client()
    >>> cds.retrieve("insitu-glaciers-extent", {}, "target.data")
    ...<commit_msg>Initial documentation with a real test retrieve.<commit_after>
Install
-------

Install via `pip` with::

    $ pip install cdsapi


Configure
---------

Get your UID and API key from the CDS portal at the address https://cds-toolbox-test.bopen.eu/user
and write it into the configuration file, so it looks like::

    $ cat ~/.cdsapirc
    url: https://cds-toolbox-test.bopen.eu/api/v2
    key: <UID>:<API key>
    verify: 0

Remember to agree to the Terms and Conditions of every dataset that you intend to download.


Test
----

Perform a small test retrieve of ERA5 data::

    $ python
    >>> import cdsapi
    >>> cds = cdsapi.Client()
    >>> cds.retrieve('reanalysis-era5-pressure-levels', {
               "variable": "temperature",
               "pressure_level": "1000",
               "product_type": "reanalysis",
               "date": "2017-12-01/2017-12-31",
               "time": "12:00",
               "format": "grib"
           }, 'download.grib')
    >>>
{'fraction_non_alphanumeric': 0.14951887490747595, 'fraction_numerical': 0.02072538860103627, 'mean_word_length': 2.2114014251781473, 'pattern_counts': {'":': 6, '<': 5, '<?xml version=': 0, '>': 26, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1289851', 'n_tokens_mistral': 451, 'n_tokens_neox': 417, 'n_words': 129}