Change wording in docs

docs/Service/Features/boundingbox.md

@@ -73,7 +73,7 @@ This request will return a bounding box with forecast date of `20240930T000000`
 
 ## Required Fields
 
-For a bounding box within the `feature` dictionary two fields are required
+For a bounding box two fields are required within the `feature` dictionary
 
 * `type`
 * `points`

docs/Service/Features/polygon.md

@@ -73,7 +73,7 @@ This request will return all points contained in `shape` for with forecast date
 
 ## Required Fields
 
-For a polygon within the `feature` dictionary two fields are required
+For a polygon two fields are required within the `feature` dictionary
 
 * `type`
 * `shape`

docs/Service/Features/timeseries.md

@@ -62,7 +62,7 @@ request = {
     "feature" : {
         "type" : "timeseries",
         "points": [[-9.10, 38.78]],
-        "axes": "step",
+        "axis": "step",
         "range" : {
             "start" : 0,
             "end" : 360,
@@ -83,21 +83,21 @@ For a timeseries within the `feature` dictionary three fields are required
 
 * `type`
 * `points`
-* `axes`
+* `axis`
 
 For a timeseries `type` must be `timeseries`.
 
 `points` must be a nested list with a points containing a latitude and a longitude.
 
-`axes` refers to the axes on which to generate the timeseries. In this case the timeseries is generated across `step` based on the inputted `range`. However if the data requested was a climate dataset the `axes` may be `datetime` denoting that the timeseries is generated across that axis.
+`axis` refers to the axis on which to generate the timeseries. In this case the timeseries is generated across `step` based on the inputted `range`. However if the data requested was a climate dataset the `axis` may be `datetime` denoting that the timeseries is generated across that axis.
 
 
 ## Optional Fields
 
-`range` is an optional field within `feature`. It refers to the extent of the `axes` on which the timeseries will be generated. In the above case where:
+`range` is an optional field within `feature`. It refers to the extent of the `axis` on which the timeseries will be generated. In the above case where:
 
 ```python
-    "axes": "step",
+    "axis": "step",
     "range" : {
         "start" : 0,
         "end" : 360,
@@ -107,7 +107,7 @@ For a timeseries `type` must be `timeseries`.
 A timeseries across `step` will start at step `0` and end at step `360` with all steps found in between being included. `range` can also contain `interval`.
 
 ```python
-    "axes": "step",
+    "axis": "step",
     "range" : {
         "start" : 0,
         "end" : 360,
@@ -116,7 +116,7 @@ A timeseries across `step` will start at step `0` and end at step `360` with all
 ```
 In this case every second step will be returned if it exists.
 
-As `range` is an optional field it can be left out, however there is not a default value. Instead the user has to include the timeseries `axes` in the main body of the request like below:
+As `range` is an optional field it can be left out, however there is not a default value. Instead the user has to include the timeseries `axis` in the main body of the request like below:
 
 ```python
 request = {
@@ -134,7 +134,7 @@ request = {
     "feature" : {
         "type" : "timeseries",
         "points": [[-9.10, 38.78]],
-        "axes": "step",
+        "axis": "step",
     },
     "format": "covjson",
 }

docs/Service/Features/trajectory.md

@@ -82,7 +82,7 @@ The `trajectory` `feature` also contains another field called `padding` with a d
 
 ## Required Fields
 
-For a trajectory within the `feature` dictionary two fields are required
+For a trajectory two fields are required within the `feature` dictionary 
 
 * `type`
 * `points`

docs/Service/Features/vertical_profile.md

@@ -64,7 +64,7 @@ request = {
     "feature" : {
         "type" : "verticalprofile",
         "points": [[-9.10, 38.78]],
-        "axes": "levelist",
+        "axis": "levelist",
         "range" : {
             "start" : 0,
             "end" : 1000,
@@ -81,34 +81,34 @@ The following will return a vertical profile on `2024-10-06 00:00:00` with level
 
 ## Required Fields
 
-For a vertical profile within the `feature` dictionary three fields are required
+For a vertical profile three fields are required within the `feature` dictionary 
 
 * `type`
 * `points`
 
 For a vertical profile `type` must be `verticalprofile`.
 
-`points` has to be a nested list with two points corresponding to a latitude and a longitude.
+`points` must be a nested list with two points corresponding to a latitude and a longitude.
 
 
 ## Optional Fields
 
-`axes` refers to the axes on which to generate the vertical profile. In this case the vertical profile is generated across `levelist` based on the inputted `range`. In the vertical profile this field is optional as the default is assumed to be `levelist` if not given.
+`axis` refers to the axis on which to generate the vertical profile. In this case the vertical profile is generated across `levelist` based on the inputted `range`. In the vertical profile this field is optional as the default is assumed to be `levelist` if not given.
 
-`range` is an optional field within `feature`. It refers to the extent of the `axes` on which the vertical profile will be generated. In the above case where:
+`range` is an optional field within `feature`. It refers to the extent of the `axis` on which the vertical profile will be generated. In the above case where:
 
 ```python
-    "axes": "levelist",
+    "axis": "levelist",
     "range" : {
         "start" : 0,
         "end" : 1000,
     }
 ```
 
-A vertical profile accross `levelist` will start at level `0` and end at level `1000` with all levels found in between being included. `range` can also contain `interval`.
+A vertical profile across `levelist` will start at level `0` and end at level `1000` with all levels found in between being included. `range` can also contain `interval`.
 
 ```python
-    "axes": "levelist",
+    "axis": "levelist",
     "range" : {
         "start" : 0,
         "end" : 1000,
@@ -117,7 +117,7 @@ A vertical profile accross `levelist` will start at level `0` and end at level `
 ```
 In this case every second level will be returned if it exists.
 
-As `range` is an optional field it can be left out, however there is not a default value. Instead the user has to include the vertical profile `axes` in the main body of the request like below:
+As `range` is an optional field it can be left out, however there is not a default value. Instead the user has to include the vertical profile `axis` in the main body of the request like below:
 
 ```python
 request = {
@@ -135,7 +135,7 @@ request = {
     "feature" : {
         "type" : "timeseries",
         "points": [[-9.10, 38.78]],
-        "axes": "levelist",
+        "axis": "levelist",
     },
     "format": "covjson",
 }

docs/Service/Installation.md

@@ -30,7 +30,7 @@ python3 -m ipykernel install --user --name=$envname
 To access ECMWF data you need an ECMWF account. This can be created <a href=https://www.ecmwf.int/>https://www.ecmwf.int/</a>. Once created, you can find your key at <a href=https://api.ecmwf.int/v1/key/>https://api.ecmwf.int/v1/key/</a>.
 
 **DISCLAIMER**
-> Polytope is currently available for users at the national meteorological services of ECMWF’s Member and Co-operating States.
+> *Polytope is currently available for users at the national meteorological services of ECMWF’s Member and Co-operating States.*
 
 Copy your API key into your home directory, in a file called `~/.polytopeapirc`. Ths file should have the following format:
 

docs/index.md

@@ -40,7 +40,7 @@ Note that Polytope reads only the user-requested data, instead of whole fields.
 Polytope feature extraction consists of the algorithm itself, and the service that uses the algorithm to extract features from ECMWF datacubes. Details on the service can be found in the Polytope service <a href="./Service/Overview">overview</a>, while details on the feature extraction algorithm can be found on the <a href="./Algorithm/Overview/Overview">Polytope algorithm overview</a>.
 
 To learn more about how to use Polytope, refer to the <a href="./Service/Quick_Start">Quickstart page</a>. In particular, see the Quickstart page for a step-by-step example of how to use the Polytope software.
-For a more in-depth explanation of how Polytope achieves its feature exctraction, refer to the <a href="./Algorithm/Developer_Guide/Overview">Developer Guide</a>.
+For a more in-depth explanation of how Polytope achieves its feature extraction, refer to the <a href="./Algorithm/Developer_Guide/Overview">Developer Guide</a>.
 
 !!! Warning
     This project is BETA and will be experimental for the foreseeable future. Interfaces and functionality are likely to change. DO NOT use this software in any project/software that is operational.
@@ -63,7 +63,7 @@ For a more in-depth explanation of how Polytope achieves its feature exctraction
 # License
 
 *Polytope* is available under the open source [Apache License](http://www.apache.org/licenses/LICENSE-2.0).
- In applying this licence, ECMWF does not waive the privileges and immunities granted to it by virtue of its status as an intergovernmental organisation nor does it submit to any jurisdiction.
+ In applying this license, ECMWF does not waive the privileges and immunities granted to it by virtue of its status as an intergovernmental organisation nor does it submit to any jurisdiction.