diff --git a/docs/Service/Features/boundingbox.md b/docs/Service/Features/boundingbox.md index 2703aa25..dfb70a46 100644 --- a/docs/Service/Features/boundingbox.md +++ b/docs/Service/Features/boundingbox.md @@ -29,7 +29,7 @@ request = { ds = earthkit.data.from_source("polytope", "ecmwf-mars", request, stream=False, address='polytope.ecmwf.int') ``` -This request will return a bounding box from yesterday's midnight forecast for the three requested parameters for the points within a bounding box with top left coordinate at latitude -1 and longitude -1, and bottom right point at latitude 1 and longitude 1. +This request will return a bounding box from yesterday's 00Z forecast for the three requested parameters for the points within a bounding box with top left coordinate at latitude -1 and longitude -1, and bottom right point at latitude 1 and longitude 1. `"polytope"` refers to the underlying service being used to return the data. `"ecmwf-mars"` is the dataset we are looking to retrieve from. Setting `stream=False` returns all the requested data to us once it is available. `address` points to the endpoint for the polytope server. diff --git a/docs/Service/Features/polygon.md b/docs/Service/Features/polygon.md index 8013e557..96423e0b 100644 --- a/docs/Service/Features/polygon.md +++ b/docs/Service/Features/polygon.md @@ -29,7 +29,7 @@ request = { ds = earthkit.data.from_source("polytope", "ecmwf-mars", request, stream=False, address='polytope.ecmwf.int') ``` -This request will return all points contained in `shape` from yesterday's midnight forecast for `step` `0`, ensemble `number` `1` and the three provided parameters. +This request will return all points contained in `shape` from yesterday's 00Z forecast for `step` `0`, ensemble `number` `1` and the three provided parameters. `"polytope"` refers to the underlying service being used to return the data. `"ecmwf-mars"` is the dataset we are looking to retrieve from. Setting `stream=False` returns all the requested data to us once it is available. `address` points to the endpoint for the polytope server. diff --git a/docs/Service/Features/timeseries.md b/docs/Service/Features/timeseries.md index 5139c204..609242b8 100644 --- a/docs/Service/Features/timeseries.md +++ b/docs/Service/Features/timeseries.md @@ -32,7 +32,7 @@ request = { ds = earthkit.data.from_source("polytope", "ecmwf-mars", request, stream=False, address='polytope.ecmwf.int') ``` -The following will return a timeseries starting yesterday at midnight with steps from `0` to `360` including all steps available in between, for the parameters `164/167/169` at the point given. This data will be returned for each ensemble number requested. +The following will return a timeseries starting yesterday at 00Z with steps from `0` to `360` including all steps available in between, for the parameters `164/167/169` at the point given. This data will be returned for each ensemble number requested. `"polytope"` refers to the underlying service being used to return the data. `"ecmwf-mars"` is the dataset we are looking to retrieve from. Setting `stream=False` returns all the requested data to us once it is available. `address` points to the endpoint for the polytope server. diff --git a/docs/Service/Features/trajectory.md b/docs/Service/Features/trajectory.md index d40bd565..7662f419 100644 --- a/docs/Service/Features/trajectory.md +++ b/docs/Service/Features/trajectory.md @@ -31,7 +31,7 @@ ds = earthkit.data.from_source("polytope", "ecmwf-mars", request, stream=False, ``` -The `trajectory` `feature` contains another field called `inflation`. This is the inflation of the shape swept around the trajectory where points within this inflation are returned to the user. In this example above, as an `inflate` value is not given, the default is `round`, meaning that the `inflation` acts as a radius around a circle. This request will thus return a trajectory from yesterday's midnight forecast for the three requested parameters for the points contained in a circle of radius `0.1` along the given path. +The `trajectory` `feature` contains another field called `inflation`. This is the inflation of the shape swept around the trajectory where points within this inflation are returned to the user. In this example above, as an `inflate` value is not given, the default is `round`, meaning that the `inflation` acts as a radius around a circle. This request will thus return a trajectory from yesterday's 00Z forecast for the three requested parameters for the points contained in a circle of radius `0.1` along the given path. `"polytope"` refers to the underlying service being used to return the data. `"ecmwf-mars"` is the dataset we are looking to retrieve from. Setting `stream=False` returns all the requested data to us once it is available. `address` points to the endpoint for the polytope server. diff --git a/docs/Service/Features/vertical_profile.md b/docs/Service/Features/vertical_profile.md index 54d7a0c6..a96b96ed 100644 --- a/docs/Service/Features/vertical_profile.md +++ b/docs/Service/Features/vertical_profile.md @@ -33,7 +33,7 @@ request = { ds = earthkit.data.from_source("polytope", "ecmwf-mars", request, stream=False, address='polytope.ecmwf.int') ``` -The following will return a vertical profile from yesterday's midnight forecast with levels from `0` to `1000` including all levels available in between, for the parameters `164/167/169` at the point given. This data will be returned for each ensemble number requested. +The following will return a vertical profile from yesterday's 00Z forecast with levels from `0` to `1000` including all levels available in between, for the parameters `164/167/169` at the point given. This data will be returned for each ensemble number requested. `"polytope"` refers to the underlying service being used to return the data. `"ecmwf-mars"` is the dataset we are looking to retrieve from. Setting `stream=False` returns all the requested data to us once it is available. `address` points to the endpoint for the polytope server. diff --git a/docs/Service/Overview.md b/docs/Service/Overview.md index 0bf9c8ca..6509be2b 100644 --- a/docs/Service/Overview.md +++ b/docs/Service/Overview.md @@ -37,6 +37,6 @@ For more in-depth information about the various features see the following pages -A set of example notebooks can also be found in the Examples page along with some examples of integration with other earthkit libraries. +A set of example notebooks can also be found in the Examples page along with some examples of integration with other earthkit libraries. A Data Portfolio containing information on what data we provide is also available. diff --git a/mkdocs.yml b/mkdocs.yml index 5cb5936c..6c656e63 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -18,6 +18,7 @@ nav: - Installation: Service/Installation.md - Quick Start: Service/Quick_Start.md - Features: + - Overview: Services/Features/feature.md - Time Series: Service/Features/timeseries.md - Vertical Profile: Service/Features/vertical_profile.md - Polygon: Service/Features/polygon.md