Skip to content

Commit 67ef459

Browse files
lesserwhirlslesserwhirls
authored
Merge pull request #545 from lesserwhirls/ncss_docs
Improve NCSS docs and upgrade guide
2 parents e7d12ac + f79495f commit 67ef459

21 files changed

Lines changed: 135 additions & 49 deletions

File tree

‎docs/adminguide/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,21 +32,28 @@ Details on other configuration options for NCSS are available in the [`threddsCo
3232

3333
## Serving Datasets With NCSS
3434

35-
In your configuration catalogs, you must define the service like this:
35+
In your configuration catalogs, you must define the service based on the type of data being served.
36+
For Feature Type `GRID`, use:
3637

3738
~~~xml
38-
<service name="subsetServer" serviceType="NetcdfSubset" base="/thredds/ncss/" />
39+
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
40+
~~~
41+
42+
For Feature Types `POINT` or `STATION`, use:
43+
44+
~~~xml
45+
<service name="ncssPoint" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
3946
~~~
4047

4148
Then as usual, add the service to any datasets that you want served, e.g.:
4249

4350
~~~xml
4451
<dataset name="datasetName" ID="datasetID" urlPath="/my/urlPath">
45-
<serviceName>subsetServer</serviceName>
52+
<serviceName>ncssGrid</serviceName>
4653
</dataset>
4754
~~~
4855

49-
Note that the name of the service (`subsetServer` in this example) is arbitrary, but the `serviceType` and base must be _exactly_ as shown.
56+
Note that the name of the service (`ncssGrid` in this example) is arbitrary, but the `serviceType` and base must be _exactly_ as shown.
5057

5158
## Restrictions On What Files Can Be Served
5259

‎docs/adminguide/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,13 +111,13 @@ Therefore, it is required that service base URLs must [exactly match the values
111111

112112
* NetCDF Subset Service (Grid Data)
113113
~~~xml
114-
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
114+
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
115115
~~~
116116

117117
* NetCDF Subset Service (Point Data)
118118

119119
~~~xml
120-
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
120+
<service name="ncssPoint" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
121121
~~~
122122

123123
* WCS

‎docs/adminguide/src/site/pages/thredds/TdsServices.md‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -229,13 +229,23 @@ The `serviceType` and `base` values are **required** in the following examples:
229229
~~~
230230

231231
#### NetCDF Subset Service
232-
232+
233+
## Serving Datasets With NCSS
234+
235+
For Feature Type `GRID`, use:
236+
237+
~~~xml
238+
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
239+
~~~
240+
241+
For Feature Types `POINT` or `STATION`, use:
242+
233243
~~~xml
234-
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/"/>
244+
<service name="ncssPoint" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
235245
~~~
236246

237247
#### WCS
238-
248+
239249
~~~xml
240250
<service name="wcs" serviceType="WCS" base="/thredds/wcs/"/>
241251
~~~
@@ -275,7 +285,7 @@ The `serviceType` and `base` values are **required** in the following examples:
275285
<service name="all" serviceType="Compound" base="">
276286
<service name="HTTPServer" serviceType="HTTPServer" base="/thredds/fileServer/"/>
277287
<service name="opendap" serviceType="OPENDAP" base="/thredds/dodsC/"/>
278-
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/"/>
288+
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/"/>
279289
<service name="cdmremote" serviceType="CdmRemote" base="/thredds/cdmremote/"/>
280290

281291
<service name="wcs" serviceType="WCS" base="/thredds/wcs/"/>

‎docs/adminguide/src/site/pages/thredds/ViewersRef.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Use the service type inside of curly brackets to select which access URL to use.
119119
<service name="http" serviceType="HTTPServer" base="/thredds/fileServer/"/>
120120
<service name="wcs" serviceType="WCS" base="/thredds/wcs/"/>
121121
<service name="wms" serviceType="WMS" base="/thredds/wms/"/>
122-
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/"/>
122+
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/"/>
123123
<service name="cdmremote" serviceType="CdmRemote" base="/thredds/cdmremote/"/>
124124
<service name="iso" serviceType="ISO" base="/thredds/iso/"/>
125125
<service name="ncml" serviceType="NCML" base="/thredds/ncml/"/>

‎docs/devguide/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,21 +31,28 @@ Details on other configuration options for NCSS are available in the [`threddsCo
3131

3232
## Serving Datasets With NCSS
3333

34-
In your configuration catalogs, you must define the service like this:
34+
In your configuration catalogs, you must define the service based on the type of data being served.
35+
For Feature Type `GRID`, use:
3536

3637
~~~xml
37-
<service name="subsetServer" serviceType="NetcdfSubset" base="/thredds/ncss/" />
38+
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
39+
~~~
40+
41+
For Feature Types `POINT` or `STATION`, use:
42+
43+
~~~xml
44+
<service name="ncssPoint" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
3845
~~~
3946

4047
Then as usual, add the service to any datasets that you want served, e.g.:
4148

4249
~~~xml
4350
<dataset name="datasetName" ID="datasetID" urlPath="/my/urlPath">
44-
<serviceName>subsetServer</serviceName>
51+
<serviceName>ncssGrid</serviceName>
4552
</dataset>
4653
~~~
4754

48-
Note that the name of the service (`subsetServer` in this example) is arbitrary, but the `serviceType` and base must be _exactly_ as shown.
55+
Note that the name of the service (`ncssGrid` in this example) is arbitrary, but the `ncssGrid` and base must be _exactly_ as shown.
4956

5057
## Restrictions On What Files Can Be Served
5158

‎docs/devguide/src/site/pages/tds_tutorial/tds_configuration/AddingOgcIsoServices.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Adding them to an existing compound service would look something like this:
6565
<service name="odap" serviceType="OpenDAP" base="/thredds/dodsC/" />
6666
<service name="wcs" serviceType="WCS" base="/thredds/wcs/" />
6767
<service name="wms" serviceType="WMS" base="/thredds/wms/" />
68-
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/" />
68+
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
6969
<service name="http" serviceType="HTTPServer" base="/thredds/fileServer/" />
7070
</service>
7171
~~~
@@ -80,7 +80,7 @@ For instance, adding to the same compound service as above:
8080
<service name="odap" serviceType="OpenDAP" base="/thredds/dodsC/" />
8181
<service name="wcs" serviceType="WCS" base="/thredds/wcs/" />
8282
<service name="wms" serviceType="WMS" base="/thredds/wms/" />
83-
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/" />
83+
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
8484
<service name="http" serviceType="HTTPServer" base="/thredds/fileServer/" />
8585
<service name="ncml" serviceType="NCML" base="/thredds/ncml/" />
8686
<service name="uddc" serviceType="UDDC" base="/thredds/uddc/" />

‎docs/devguide/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,13 +111,13 @@ Therefore, it is required that service base URLs must [exactly match the values
111111

112112
* NetCDF Subset Service (Grid Data)
113113
~~~xml
114-
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
114+
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
115115
~~~
116116

117117
* NetCDF Subset Service (Point Data)
118118

119119
~~~xml
120-
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
120+
<service name="ncssPoint" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
121121
~~~
122122

123123
* WCS

‎docs/devguide/src/site/pages/thredds/TdsServices.md‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -229,9 +229,17 @@ The `serviceType` and `base` values are **required** in the following examples:
229229
~~~
230230

231231
#### NetCDF Subset Service
232-
232+
233+
For Feature Type `GRID`, use:
234+
235+
~~~xml
236+
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
237+
~~~
238+
239+
For Feature Types `POINT` or `STATION`, use:
240+
233241
~~~xml
234-
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/"/>
242+
<service name="ncssPoint" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
235243
~~~
236244

237245
#### WCS
@@ -275,7 +283,7 @@ The `serviceType` and `base` values are **required** in the following examples:
275283
<service name="all" serviceType="Compound" base="">
276284
<service name="HTTPServer" serviceType="HTTPServer" base="/thredds/fileServer/"/>
277285
<service name="opendap" serviceType="OPENDAP" base="/thredds/dodsC/"/>
278-
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/"/>
286+
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/"/>
279287
<service name="cdmremote" serviceType="CdmRemote" base="/thredds/cdmremote/"/>
280288

281289
<service name="wcs" serviceType="WCS" base="/thredds/wcs/"/>

‎docs/devguide/src/site/pages/thredds/ViewersRef.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Use the service type inside of curly brackets to select which access URL to use.
119119
<service name="http" serviceType="HTTPServer" base="/thredds/fileServer/"/>
120120
<service name="wcs" serviceType="WCS" base="/thredds/wcs/"/>
121121
<service name="wms" serviceType="WMS" base="/thredds/wms/"/>
122-
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/"/>
122+
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/"/>
123123
<service name="cdmremote" serviceType="CdmRemote" base="/thredds/cdmremote/"/>
124124
<service name="iso" serviceType="ISO" base="/thredds/iso/"/>
125125
<service name="ncml" serviceType="NCML" base="/thredds/ncml/"/>

‎docs/quickstart/src/site/pages/tds_tutorial/production/Upgrade.md‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,19 @@ Deprecated classes and methods have been removed, and the module structure and t
3838
### Netcdf Subset Service (NCSS)
3939

4040
NCSS queries and responses have been improved and clarified.
41-
Generally the previous queries are backwards compatible. See [NCSS Reference](netcdf_subset_service_ref.html) for details.
41+
Generally the previous queries are backwards compatible.
42+
See [NCSS Reference](netcdf_subset_service_ref.html) for details.
43+
44+
Catalog (config and client) base changes:
45+
* NCSS service has been split and now has two different paths, depending on the feature type of data being served.
46+
* For `GRID`, use:
47+
~~~
48+
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
49+
~~~
50+
and for `POINT` or `STATION`, use:
51+
~~~xml
52+
<service name="ncssPoint" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
53+
~~~
4254

4355
New functionality:
4456
* 2D time can now be handled for gridded datasets, with addition of `runtime` and `timeOffset` parameters.

0 commit comments

Comments
 (0)