Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve NCSS docs and upgrade guide #545

Merged
merged 1 commit into from
Nov 21, 2024
Merged

Improve NCSS docs and upgrade guide #545

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions docs/adminguide/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,21 +32,28 @@ Details on other configuration options for NCSS are available in the [`threddsCo

## Serving Datasets With NCSS

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

~~~xml
<service name="subsetServer" serviceType="NetcdfSubset" base="/thredds/ncss/" />
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
~~~

For Feature Types `POINT` or `STATION`, use:

~~~xml
<service name="ncssPoint" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
~~~

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

~~~xml
<dataset name="datasetName" ID="datasetID" urlPath="/my/urlPath">
<serviceName>subsetServer</serviceName>
<serviceName>ncssGrid</serviceName>
</dataset>
~~~

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

## Restrictions On What Files Can Be Served

Expand Down
4 changes: 2 additions & 2 deletions docs/adminguide/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,13 +111,13 @@ Therefore, it is required that service base URLs must [exactly match the values

* NetCDF Subset Service (Grid Data)
~~~xml
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
~~~

* NetCDF Subset Service (Point Data)

~~~xml
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
<service name="ncssPoint" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
~~~

* WCS
Expand Down
18 changes: 14 additions & 4 deletions docs/adminguide/src/site/pages/thredds/TdsServices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,13 +229,23 @@ The `serviceType` and `base` values are **required** in the following examples:
~~~

#### NetCDF Subset Service


## Serving Datasets With NCSS

For Feature Type `GRID`, use:

~~~xml
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
~~~

For Feature Types `POINT` or `STATION`, use:

~~~xml
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/"/>
<service name="ncssPoint" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
~~~

#### WCS

~~~xml
<service name="wcs" serviceType="WCS" base="/thredds/wcs/"/>
~~~
Expand Down Expand Up @@ -275,7 +285,7 @@ The `serviceType` and `base` values are **required** in the following examples:
<service name="all" serviceType="Compound" base="">
<service name="HTTPServer" serviceType="HTTPServer" base="/thredds/fileServer/"/>
<service name="opendap" serviceType="OPENDAP" base="/thredds/dodsC/"/>
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/"/>
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/"/>
<service name="cdmremote" serviceType="CdmRemote" base="/thredds/cdmremote/"/>

<service name="wcs" serviceType="WCS" base="/thredds/wcs/"/>
Expand Down
2 changes: 1 addition & 1 deletion docs/adminguide/src/site/pages/thredds/ViewersRef.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ Use the service type inside of curly brackets to select which access URL to use.
<service name="http" serviceType="HTTPServer" base="/thredds/fileServer/"/>
<service name="wcs" serviceType="WCS" base="/thredds/wcs/"/>
<service name="wms" serviceType="WMS" base="/thredds/wms/"/>
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/"/>
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/"/>
<service name="cdmremote" serviceType="CdmRemote" base="/thredds/cdmremote/"/>
<service name="iso" serviceType="ISO" base="/thredds/iso/"/>
<service name="ncml" serviceType="NCML" base="/thredds/ncml/"/>
Expand Down
15 changes: 11 additions & 4 deletions docs/devguide/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,28 @@ Details on other configuration options for NCSS are available in the [`threddsCo

## Serving Datasets With NCSS

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

~~~xml
<service name="subsetServer" serviceType="NetcdfSubset" base="/thredds/ncss/" />
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
~~~

For Feature Types `POINT` or `STATION`, use:

~~~xml
<service name="ncssPoint" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
~~~

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

~~~xml
<dataset name="datasetName" ID="datasetID" urlPath="/my/urlPath">
<serviceName>subsetServer</serviceName>
<serviceName>ncssGrid</serviceName>
</dataset>
~~~

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

## Restrictions On What Files Can Be Served

Expand Down
4 changes: 2 additions & 2 deletions .../devguide/src/site/pages/tds_tutorial/tds_configuration/AddingOgcIsoServices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Adding them to an existing compound service would look something like this:
<service name="odap" serviceType="OpenDAP" base="/thredds/dodsC/" />
<service name="wcs" serviceType="WCS" base="/thredds/wcs/" />
<service name="wms" serviceType="WMS" base="/thredds/wms/" />
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/" />
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
<service name="http" serviceType="HTTPServer" base="/thredds/fileServer/" />
</service>
~~~
Expand All @@ -80,7 +80,7 @@ For instance, adding to the same compound service as above:
<service name="odap" serviceType="OpenDAP" base="/thredds/dodsC/" />
<service name="wcs" serviceType="WCS" base="/thredds/wcs/" />
<service name="wms" serviceType="WMS" base="/thredds/wms/" />
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/" />
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
<service name="http" serviceType="HTTPServer" base="/thredds/fileServer/" />
<service name="ncml" serviceType="NCML" base="/thredds/ncml/" />
<service name="uddc" serviceType="UDDC" base="/thredds/uddc/" />
Expand Down
4 changes: 2 additions & 2 deletions docs/devguide/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,13 +111,13 @@ Therefore, it is required that service base URLs must [exactly match the values

* NetCDF Subset Service (Grid Data)
~~~xml
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
~~~

* NetCDF Subset Service (Point Data)

~~~xml
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
<service name="ncssPoint" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
~~~

* WCS
Expand Down
14 changes: 11 additions & 3 deletions docs/devguide/src/site/pages/thredds/TdsServices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,9 +229,17 @@ The `serviceType` and `base` values are **required** in the following examples:
~~~

#### NetCDF Subset Service


For Feature Type `GRID`, use:

~~~xml
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
~~~

For Feature Types `POINT` or `STATION`, use:

~~~xml
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/"/>
<service name="ncssPoint" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
~~~

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

<service name="wcs" serviceType="WCS" base="/thredds/wcs/"/>
Expand Down
2 changes: 1 addition & 1 deletion docs/devguide/src/site/pages/thredds/ViewersRef.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ Use the service type inside of curly brackets to select which access URL to use.
<service name="http" serviceType="HTTPServer" base="/thredds/fileServer/"/>
<service name="wcs" serviceType="WCS" base="/thredds/wcs/"/>
<service name="wms" serviceType="WMS" base="/thredds/wms/"/>
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/"/>
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/"/>
<service name="cdmremote" serviceType="CdmRemote" base="/thredds/cdmremote/"/>
<service name="iso" serviceType="ISO" base="/thredds/iso/"/>
<service name="ncml" serviceType="NCML" base="/thredds/ncml/"/>
Expand Down
14 changes: 13 additions & 1 deletion docs/quickstart/src/site/pages/tds_tutorial/production/Upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,19 @@ Deprecated classes and methods have been removed, and the module structure and t
### Netcdf Subset Service (NCSS)

NCSS queries and responses have been improved and clarified.
Generally the previous queries are backwards compatible. See [NCSS Reference](netcdf_subset_service_ref.html) for details.
Generally the previous queries are backwards compatible.
See [NCSS Reference](netcdf_subset_service_ref.html) for details.

Catalog (config and client) base changes:
* NCSS service has been split and now has two different paths, depending on the feature type of data being served.
* For `GRID`, use:
~~~
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
~~~
and for `POINT` or `STATION`, use:
~~~xml
<service name="ncssPoint" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
~~~

New functionality:
* 2D time can now be handled for gridded datasets, with addition of `runtime` and `timeOffset` parameters.
Expand Down
15 changes: 11 additions & 4 deletions docs/quickstart/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,28 @@ Details on other configuration options for NCSS are available in the [`threddsCo

## Serving Datasets With NCSS

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

~~~xml
<service name="subsetServer" serviceType="NetcdfSubset" base="/thredds/ncss/" />
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
~~~

For Feature Types `POINT` or `STATION`, use:

~~~xml
<service name="ncssPoint" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
~~~

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

~~~xml
<dataset name="datasetName" ID="datasetID" urlPath="/my/urlPath">
<serviceName>subsetServer</serviceName>
<serviceName>ncssGrid</serviceName>
</dataset>
~~~

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

## Restrictions On What Files Can Be Served

Expand Down
4 changes: 2 additions & 2 deletions ...uickstart/src/site/pages/tds_tutorial/tds_configuration/AddingOgcIsoServices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Adding them to an existing compound service would look something like this:
<service name="odap" serviceType="OpenDAP" base="/thredds/dodsC/" />
<service name="wcs" serviceType="WCS" base="/thredds/wcs/" />
<service name="wms" serviceType="WMS" base="/thredds/wms/" />
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/" />
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
<service name="http" serviceType="HTTPServer" base="/thredds/fileServer/" />
</service>
~~~
Expand All @@ -80,7 +80,7 @@ For instance, adding to the same compound service as above:
<service name="odap" serviceType="OpenDAP" base="/thredds/dodsC/" />
<service name="wcs" serviceType="WCS" base="/thredds/wcs/" />
<service name="wms" serviceType="WMS" base="/thredds/wms/" />
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/" />
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
<service name="http" serviceType="HTTPServer" base="/thredds/fileServer/" />
<service name="ncml" serviceType="NCML" base="/thredds/ncml/" />
<service name="uddc" serviceType="UDDC" base="/thredds/uddc/" />
Expand Down
4 changes: 2 additions & 2 deletions docs/quickstart/src/site/pages/tds_tutorial/tds_configuration/ConfigCatalog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,13 +111,13 @@ Therefore, it is required that service base URLs must [exactly match the values

* NetCDF Subset Service (Grid Data)
~~~xml
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
~~~

* NetCDF Subset Service (Point Data)

~~~xml
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
<service name="ncssPoint" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
~~~

* WCS
Expand Down
14 changes: 11 additions & 3 deletions docs/quickstart/src/site/pages/thredds/TdsServices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,9 +229,17 @@ The `serviceType` and `base` values are **required** in the following examples:
~~~

#### NetCDF Subset Service


For Feature Type `GRID`, use:

~~~xml
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
~~~

For Feature Types `POINT` or `STATION`, use:

~~~xml
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/"/>
<service name="ncssPoint" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
~~~

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

<service name="wcs" serviceType="WCS" base="/thredds/wcs/"/>
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart/src/site/pages/thredds/ViewersRef.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ Use the service type inside of curly brackets to select which access URL to use.
<service name="http" serviceType="HTTPServer" base="/thredds/fileServer/"/>
<service name="wcs" serviceType="WCS" base="/thredds/wcs/"/>
<service name="wms" serviceType="WMS" base="/thredds/wms/"/>
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/"/>
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/"/>
<service name="cdmremote" serviceType="CdmRemote" base="/thredds/cdmremote/"/>
<service name="iso" serviceType="ISO" base="/thredds/iso/"/>
<service name="ncml" serviceType="NCML" base="/thredds/ncml/"/>
Expand Down
14 changes: 13 additions & 1 deletion docs/userguide/src/site/pages/tds_tutorial/production/Upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,19 @@ Deprecated classes and methods have been removed, and the module structure and t
### Netcdf Subset Service (NCSS)

NCSS queries and responses have been improved and clarified.
Generally the previous queries are backwards compatible. See [NCSS Reference](netcdf_subset_service_ref.html) for details.
Generally the previous queries are backwards compatible.
See [NCSS Reference](netcdf_subset_service_ref.html) for details.

Catalog (config and client) base changes:
* NCSS service has been split and now has two different paths, depending on the feature type of data being served.
* For `GRID`, use:
~~~
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
~~~
and for `POINT` or `STATION`, use:
~~~xml
<service name="ncssPoint" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
~~~

New functionality:
* 2D time can now be handled for gridded datasets, with addition of `runtime` and `timeOffset` parameters.
Expand Down
15 changes: 11 additions & 4 deletions docs/userguide/src/site/pages/tds_tutorial/tds_configuration/AddingNcss.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,28 @@ Details on other configuration options for NCSS are available in the [`threddsCo

## Serving Datasets With NCSS

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

~~~xml
<service name="subsetServer" serviceType="NetcdfSubset" base="/thredds/ncss/" />
<service name="ncssGrid" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
~~~

For Feature Types `POINT` or `STATION`, use:

~~~xml
<service name="ncssPoint" serviceType="NetcdfSubset" base="/thredds/ncss/point/" />
~~~

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

~~~xml
<dataset name="datasetName" ID="datasetID" urlPath="/my/urlPath">
<serviceName>subsetServer</serviceName>
<serviceName>ncssGrid</serviceName>
</dataset>
~~~

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

## Restrictions On What Files Can Be Served

Expand Down
4 changes: 2 additions & 2 deletions ...userguide/src/site/pages/tds_tutorial/tds_configuration/AddingOgcIsoServices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Adding them to an existing compound service would look something like this:
<service name="odap" serviceType="OpenDAP" base="/thredds/dodsC/" />
<service name="wcs" serviceType="WCS" base="/thredds/wcs/" />
<service name="wms" serviceType="WMS" base="/thredds/wms/" />
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/" />
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
<service name="http" serviceType="HTTPServer" base="/thredds/fileServer/" />
</service>
~~~
Expand All @@ -101,7 +101,7 @@ For instance, adding to the same compound service as above:
<service name="odap" serviceType="OpenDAP" base="/thredds/dodsC/" />
<service name="wcs" serviceType="WCS" base="/thredds/wcs/" />
<service name="wms" serviceType="WMS" base="/thredds/wms/" />
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/" />
<service name="ncss" serviceType="NetcdfSubset" base="/thredds/ncss/grid/" />
<service name="http" serviceType="HTTPServer" base="/thredds/fileServer/" />
<service name="ncml" serviceType="NCML" base="/thredds/ncml/" />
<service name="uddc" serviceType="UDDC" base="/thredds/uddc/" />
Expand Down
Loading
Loading