Merge pull request #5 from mathworks/restructure

Restructure Toolbox

Climate Data Store Toolbox for MATLAB.prj

@@ -1,13 +1,13 @@
 <deployment-project plugin="plugin.toolbox" plugin-version="1.0">
   <configuration build-checksum="2963137483" file="C:\localProjects\climatedatastore\Climate Data Store Toolbox for MATLAB.prj" location="C:\localProjects\climatedatastore" name="Climate Data Store Toolbox for MATLAB" target="target.toolbox" target-name="Package Toolbox">
     <param.appname>Climate Data Store Toolbox for MATLAB</param.appname>
-    <param.authnamewatermark />
+    <param.authnamewatermark>Rob Purser</param.authnamewatermark>
     <param.email />
     <param.company>MathWorks</param.company>
     <param.summary>MATLAB(R) Tools to access the Climate Data Store (https://cds.climate.copernicus.eu/)</param.summary>
-    <param.description>MATLAB Tools to access the Climate Data Store (https://cds.climate.copernicus.eu/).  It is a wealth of information about the Earth's past, present and future climate. There are hundreds of data sets associated with climate change.</param.description>
-    <param.screenshot>${PROJECT_ROOT}\img\copernicus_logo.jpg</param.screenshot>
-    <param.version>2.0.0.27</param.version>
+    <param.description>MATLAB Tools to access the Climate Data Store (https://cds.climate.copernicus.eu/).  It is a wealth of information about the Earth's past, present and future climate. There are hundreds of data sets associated with climate change.  See the GettingStarted.mlx in the doc directory!</param.description>
+    <param.screenshot>${PROJECT_ROOT}\img\ToolboxPackaging.jpg</param.screenshot>
+    <param.version>2.1.0.29</param.version>
     <param.output>${PROJECT_ROOT}\Climate Data Store Toolbox for MATLAB.mltbx</param.output>
     <param.products.name />
     <param.products.id />
@@ -46,8 +46,8 @@ CONTRIBUTING.md</param.exclude.filters>
     <param.demosxml />
     <param.apps />
     <param.registered.apps />
-    <param.docs>${PROJECT_ROOT}\info.xml</param.docs>
-    <param.getting.started.guide>${PROJECT_ROOT}\doc\GettingStarted.mlx</param.getting.started.guide>
+    <param.docs>${PROJECT_ROOT}\climatedatastoreToolbox\info.xml</param.docs>
+    <param.getting.started.guide>${PROJECT_ROOT}\climatedatastoreToolbox\doc\GettingStarted.mlx</param.getting.started.guide>
     <param.matlabpath.excludes />
     <param.javaclasspath.excludes />
     <param.exported.on.package>true</param.exported.on.package>
@@ -68,7 +68,6 @@ CONTRIBUTING.md</param.exclude.filters>
     <param.additional.sw.mac.url />
     <param.additional.sw.linux.url />
     <unset>
-      <param.authnamewatermark />
       <param.email />
       <param.output />
       <param.products.name />
@@ -97,16 +96,16 @@ CONTRIBUTING.md</param.exclude.filters>
       <param.additional.sw.linux.url />
     </unset>
     <fileset.rootdir>
-      <file>${PROJECT_ROOT}</file>
+      <file>${PROJECT_ROOT}\climatedatastoreToolbox</file>
     </fileset.rootdir>
     <fileset.rootfiles>
-      <file>${PROJECT_ROOT}\climateDataStoreDownload.m</file>
-      <file>${PROJECT_ROOT}\CONTRIBUTING.MD</file>
-      <file>${PROJECT_ROOT}\demos.xml</file>
-      <file>${PROJECT_ROOT}\doc</file>
-      <file>${PROJECT_ROOT}\info.xml</file>
-      <file>${PROJECT_ROOT}\license.txt</file>
-      <file>${PROJECT_ROOT}\util</file>
+      <file>${PROJECT_ROOT}\climatedatastoreToolbox\climateDataStoreDownload.m</file>
+      <file>${PROJECT_ROOT}\climatedatastoreToolbox\climateDataStoreDownloadAsync.m</file>
+      <file>${PROJECT_ROOT}\climatedatastoreToolbox\climateDataStoreDownloadFuture.m</file>
+      <file>${PROJECT_ROOT}\climatedatastoreToolbox\demos.xml</file>
+      <file>${PROJECT_ROOT}\climatedatastoreToolbox\doc</file>
+      <file>${PROJECT_ROOT}\climatedatastoreToolbox\info.xml</file>
+      <file>${PROJECT_ROOT}\climatedatastoreToolbox\util</file>
     </fileset.rootfiles>
     <fileset.depfun.included />
     <fileset.depfun.excluded />

README.md

@@ -61,18 +61,18 @@ datasetName ="satellite-sea-ice-thickness";
 Select the data to download from the dataset (see [this webpage](https://cds.climate.copernicus.eu/cdsapp#!/dataset/satellite-sea-ice-thickness?tab=form) for options). This is a "MATLABized" version of the python structure that is generated in the API request.
 
 ```matlab:Code
-options.version = "1_0";
-options.variable = "all";
-options.satellite = "cryosat_2";
-options.cdr_type = ["cdr","icdr"]; 
-options.year = ["2011","2021"]; 
-options.month = "03";
+datasetOptions.version = "1_0";
+datasetOptions.variable = "all";
+datasetOptions.satellite = "cryosat_2";
+datasetOptions.cdr_type = ["cdr","icdr"]; 
+datasetOptions.year = ["2011","2021"]; 
+datasetOptions.month = "03";
 ```
 
 Download the data from Climate Data Store using **`climateDataStoreDownload`**. It is put in a directory called "satellite-sea-ice-thickness."
 
 ```matlab:Code
-downloadedFilePaths = climateDataStoreDownload('satellite-sea-ice-thickness',options);
+downloadedFilePaths = climateDataStoreDownload(datasetName,datasetOptions);
 ```
 
 ```text:Output
@@ -88,8 +88,8 @@ downloadedFilePaths = climateDataStoreDownload('satellite-sea-ice-thickness',opt
 Transform and load the latitude, longitude, and ice thickness.
 
 ```matlab:Code
-ice2011 = readSatelliteSeaIceThickness("satellite-sea-ice-thickness\ice_thickness_nh_ease2-250_cdr-v1p0_201103.nc");
-ice2021 = readSatelliteSeaIceThickness("satellite-sea-ice-thickness\ice_thickness_nh_ease2-250_icdr-v1p0_202103.nc");
+ice2011 = readSatelliteSeaIceThickness(downloadedFilePaths(1));
+ice2021 = readSatelliteSeaIceThickness(downloadedFilePaths(2));
 head(ice2021)
 ```
 

climateDataStoreDownload.m → climatedatastoreToolbox/climateDataStoreDownload.m

@@ -36,7 +36,7 @@
 %
 % See Also: climateDataStoreDownloadAsync
 
-% Copyright 2022 The MathWorks, Inc.
+% Copyright 2021-2022 The MathWorks, Inc.
 
     arguments
         datasetName (1,1) string {mustBeNonzeroLengthText}

demos.xml → climatedatastoreToolbox/demos.xml

@@ -4,7 +4,7 @@
    <type>toolbox</type>
    <icon>HelpIcon.DEMOS</icon>
    <website/>
-   <description>MATLAB Tools to access the Climate Data Store (https://cds.climate.copernicus.eu/).  It is a wealth of information about the Earth's past, present and future climate. There are hundreds of data sets associated with climate change.</description>
+   <description>MATLAB Tools to access the Climate Data Store (https://cds.climate.copernicus.eu/).  It is a wealth of information about the Earth's past, present and future climate. There are hundreds of data sets associated with climate change.  See the GettingStarted.mlx in the doc directory!</description>
    <demosection>
       <label>doc</label>
       <demoitem>