Skip to content

Commit

Permalink
Merge pull request #277 from ecmwf/develop
Browse files Browse the repository at this point in the history
update docs
  • Loading branch information
mathleur authored Nov 27, 2024
2 parents ee79047 + 81b2780 commit 42092f4
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/Service/Features/boundingbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/Service/Features/polygon.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/Service/Features/timeseries.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/Service/Features/trajectory.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/Service/Features/vertical_profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/Service/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,6 @@ For more in-depth information about the various features see the following pages

<!-- A design document on the general principles of how requests can be generated can also be found <a href="../Design_Doc">here</a>. -->

A set of example notebooks can also be found in the <a href="../Examples/index">Examples</a> page along with some examples of integration with other earthkit libraries.
A set of example notebooks can also be found in the <a href="../Examples/examples">Examples</a> page along with some examples of integration with other earthkit libraries.

A <a href="../Data_Portfolio">Data Portfolio</a> containing information on what data we provide is also available.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 42092f4

Please sign in to comment.