Skip to content

Commit

Permalink
Merge pull request #267 from ecmwf/docs/data_potfolio
Browse files Browse the repository at this point in the history
Add data portfolio to index, and update with new info
  • Loading branch information
mathleur authored Nov 18, 2024
2 parents feac241 + e5be652 commit bbd480d
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 6 deletions.
4 changes: 3 additions & 1 deletion docs/Service/Data_Portfolio.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,10 @@ If `levtype` is `pl` or `ml` a `levelist` must be provided:
* `crwe`
* `ttpha`

For `sfc` most `param`s should be available.
For `sfc` most `params` will be available but not all.

Only data that is contained in the operational FDB can be requested via Polytope feature extraction, the FDB usually only contains the last two days of forecasts.

We sometimes limit the size of requests for area features such as bounding box and polygon to maintain quality of service.

Access to operational data is limited by our release schedule.
8 changes: 5 additions & 3 deletions docs/Service/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ Extracting features directly offers two main advantages:

<div style="text-align:center">
<p style="float: middle; margin: 0 5px 0 0px;">
<img src="../../images/polytope_feature.png" alt="Example Cut Out" width="750"/>
<img src="../../images/polytope_feature.png" alt="Example Features" width="750"/>
</p>
</div>

## Polytope Feature Extraction vs Web MARS

Feature Extraction differs from Web-MARS by allowing users to request specific features rather than only global fields. However, Polytope does also allow users to request global fields by simply omitting the `feature` keyword from the request.
Feature extraction differs from Web-MARS by allowing users to request specific features rather than only global fields. However, Polytope does also allow users to request global fields by simply omitting the `feature` keyword from the request.

Both Polytope and Web-MARS are integrated into the earthkit ecosystem allowing users to request and retrieve data using either service. Earthkit tools for mapping, plotting, regridding, and transforming are available for working with both whole fields and specific features.

Expand All @@ -37,4 +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/index">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.
4 changes: 2 additions & 2 deletions docs/Service/Quick_Start.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ To convert your covjson into an xarray the following can be done:
ds.to_xarray()
```

The following visualisation does not use the latest version of earthkit-plots. To replicate it you need to install the https://github.com/ecmwf/earthkit-plots/tree/feature/ams-meteograms branch
The following visualisation can be created using the latest version of earthkit-plots.

```python
from earthkit.plots.interactive import Chart
Expand All @@ -65,7 +65,7 @@ chart.show(renderer="png") # Replace with chart.show() in an interactive sessio

<div style="text-align:center">
<p style="float: middle; margin: 0 5px 0 0px;">
<img src="../images/timeseries_qs.png" alt="Example Cut Out" width="750"/>
<img src="../../images/timeseries_qs.png" alt="Example Meteogram" width="750"/>
</p>
</div>

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ nav:
- Bounding Box: Service/Features/boundingbox.md
- Trajectory: Service/Features/trajectory.md
- Examples: Service/Examples/examples.md
- Data Portfolio: Service/Data_Portfolio.md
# - Design Doc: Service/Design_doc.md
- Algorithm:
- Overview: Algorithm/Overview/Overview.md
Expand Down

0 comments on commit bbd480d

Please sign in to comment.