change midnight in features to 00Z and add overview of features in index

ecmwf · Nov 26, 2024 · 608c1a2 · 608c1a2
1 parent 99ba111
commit 608c1a2
Show file tree

Hide file tree

Showing 6 changed files with 6 additions and 5 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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/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
-Original file line number
+Diff line change
@@ Expand Up @@
     ```
-    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.
@@ Expand Down @@