Skip to content

Commit 6f3e34c

Browse files
committed
Add notes to README
1 parent db98c18 commit 6f3e34c

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ MATLAB® Tools to access [The Climate Data Store](https://cds.climate.coperni
99
| Function | Description |
1010
| ------ | ------ |
1111
| `climateDataStoreDownload` | Get data from Copernicus Climate Data Store |
12-
| `climateDataStoreDownloadASync` | Queue a request data from Copernicus Climate Data Store and continue working in MATLAB. |
12+
| `climateDataStoreDownloadAsync` | Queue a request data from Copernicus Climate Data Store and continue working in MATLAB. |
1313

1414
## Usage
1515

@@ -27,10 +27,11 @@ Note that downloading the files can take some time, depending on how large they
2727
| NetCDF | `.nu` | [`ncinfo`](https://www.mathworks.com/help/matlab/ref/ncinfo.html) , [`ncread`](https://www.mathworks.com/help/matlab/ref/ncread.html) |
2828
| GRIB | `.grib` | [`ncinfo`](https://www.mathworks.com/help/matlab/ref/ncinfo.html) , [`ncread`](https://www.mathworks.com/help/matlab/ref/ncread.html) |
2929
| text | `.txt` , `.csv` | [`readtable`](https://www.mathworks.com/help/matlab/ref/readtable.html)
30+
3031
## First time Install
3132

3233
* Requires MATLAB release R2019a or newer
33-
* Install the toolbox by doubleclicking on the `climatedatastore.mltbx` file.
34+
* Install the toolbox by using the Add-on explorer in MATLAB, or by downloading the `climatedatastore.mltbx` file attached to the latest release on GitHub, then doubleclicking on it.
3435
* This relies on the [CDS Python API](https://github.com/ecmwf/cdsapi) created by the European Centre for Medium-Range Weather Forecasts (ECMWF). You'll need to have python installed. Get it from the [Python Download page](https://www.python.org/downloads/). See [this MATLAB documentation](https://www.mathworks.com/help/matlab/matlab_external/install-supported-python-implementation.html) for more information.
3536
* The toolbox will automatically configure python and download and install the CSAPI package (you can manually install using `pip3 install cdsapi`)
3637
* The toolbox will prompt you the first time for CSAPI credentials. Visit [How to use the CDS API](https://cds.climate.copernicus.eu/api-how-to) for more info.

0 commit comments

Comments
 (0)