#373 - removed maxi from all examples

SlideRuleEarth · Feb 1, 2024 · bd6ff74 · bd6ff74
1 parent 172f375
commit bd6ff74
Show file tree

Hide file tree

Showing 8 changed files with 10 additions and 19 deletions.
diff --git a/clients/python/README.md b/clients/python/README.md
@@ -34,8 +34,7 @@ parms = {
     "srt": icesat2.SRT_LAND,
     "cnf": icesat2.CNF_SURFACE_HIGH,
     "len": 40.0,
-    "res": 20.0,
-    "maxi": 1
+    "res": 20.0
 }
 
 # make request

diff --git a/clients/python/sliderule/icesat2.py b/clients/python/sliderule/icesat2.py
@@ -364,7 +364,7 @@ def atl06p(parm, callbacks={}, resources=None, keep_id=False, as_numpy_array=Fal
     --------
         >>> from sliderule import icesat2
         >>> icesat2.init("slideruleearth.io", True)
-        >>> parms = { "cnf": 4, "ats": 20.0, "cnt": 10, "len": 40.0, "res": 20.0, "maxi": 1 }
+        >>> parms = { "cnf": 4, "ats": 20.0, "cnt": 10, "len": 40.0, "res": 20.0 }
         >>> resources = ["ATL03_20181019065445_03150111_003_01.h5"]
         >>> atl03_asset = "atlas-local"
         >>> rsps = icesat2.atl06p(parms, asset=atl03_asset, resources=resources)

diff --git a/docs/rtd/source/getting_started/Getting-Started.rst b/docs/rtd/source/getting_started/Getting-Started.rst
@@ -45,8 +45,7 @@ The `SlideRule` service provides a number of services which allow a user to proc
         "srt": icesat2.SRT_LAND,
         "cnf": icesat2.CNF_SURFACE_HIGH,
         "len": 40.0,
-        "res": 20.0,
-        "maxi": 1
+        "res": 20.0
     }
 
     # make request (5)

diff --git a/docs/rtd/source/tutorials/user/ancillary_fields.md b/docs/rtd/source/tutorials/user/ancillary_fields.md
@@ -42,8 +42,7 @@ __Step 2__: Create parameters for a typical `atl06p` processing request.
     "srt": icesat2.SRT_LAND,
     "cnf": icesat2.CNF_SURFACE_HIGH,
     "len": 40.0,
-    "res": 20.0,
-    "maxi": 1
+    "res": 20.0
 }
 ```
 The **grandmesa.geojson** file used in this example can be downloaded by navigating to our [downloads](/rtd/tutorials/downloads.html) page; alternatively, you can create your own GeoJSON file at [geojson.io](https://geojson.io).
@@ -100,8 +99,7 @@ __Step 2__: Create parameters for a typical `atl06p` processing request.
     "srt": icesat2.SRT_LAND,
     "cnf": icesat2.CNF_SURFACE_HIGH,
     "len": 40.0,
-    "res": 20.0,
-    "maxi": 1
+    "res": 20.0
 }
 ```
 The **grandmesa.geojson** file used in this example can be downloaded by navigating to our [downloads](/rtd/tutorials/downloads.html) page; alternatively, you can create your own GeoJSON file at [geojson.io](https://geojson.io).

diff --git a/docs/rtd/source/tutorials/user/arcticdem_request.md b/docs/rtd/source/tutorials/user/arcticdem_request.md
@@ -36,8 +36,7 @@ __Step 2__: Create parameters for a typical `atl06p` processing request.
     "srt": icesat2.SRT_LAND,
     "cnf": icesat2.CNF_SURFACE_HIGH,
     "len": 40.0,
-    "res": 20.0,
-    "maxi": 6
+    "res": 20.0
 }
 ```
 The **dicksonfjord.geojson** file used in this example can be downloaded by navigating to our [downloads](/rtd/tutorials/downloads.html) page; alternatively, you can create your own GeoJSON file at [geojson.io](https://geojson.io).  Be sure that your region of interest is in the arctic, otherwise there will be no data in the ArcticDEM for it.

diff --git a/docs/rtd/source/tutorials/user/first_request.md b/docs/rtd/source/tutorials/user/first_request.md
@@ -64,8 +64,7 @@ __Step 4__: Create a dictionary of processing parameters specifying how the elev
     "srt": icesat2.SRT_LAND,
     "cnf": icesat2.CNF_SURFACE_HIGH,
     "len": 40.0,
-    "res": 20.0,
-    "maxi": 1
+    "res": 20.0
 }
 ```
 For a full description of the different processing parameters that are accepted by SlideRule, see [parameters](../../user_guide/ICESat-2.html#parameters).  The parameters of interest here are _len_ which specifies the total along-track length of the segment used to calculate an elevation, and _res_ which specifies the along-track posting interval of the calculation.

diff --git a/docs/rtd/source/tutorials/user/geoparquet_output.md b/docs/rtd/source/tutorials/user/geoparquet_output.md
@@ -38,8 +38,7 @@ __Step 2__: Create parameters for a typical `atl06p` processing request (it coul
     "srt": icesat2.SRT_LAND,
     "cnf": icesat2.CNF_SURFACE_HIGH,
     "len": 40.0,
-    "res": 20.0,
-    "maxi": 6
+    "res": 20.0
 }
 ```
 The **grandmesa.geojson** file used in this example can be downloaded by navigating to our [downloads](/rtd/tutorials/downloads.html) page; alternatively, you can create your own GeoJSON file at [geojson.io](https://geojson.io).

diff --git a/docs/rtd/source/user_guide/ICESat-2.rst b/docs/rtd/source/user_guide/ICESat-2.rst
@@ -82,8 +82,7 @@ To run the YAPC algorithm, specify the YAPC settings as a sub-dictionary. Here i
         "ats": 10.0,
         "cnt": 5,
         "len": 20.0,
-        "res": 20.0,
-        "maxi": 1
+        "res": 20.0
     }
 
 2.3 Photon-extent parameters
@@ -464,8 +463,7 @@ atl06
             "ats": 20.0,
             "cnt": 10,
             "len": 40.0,
-            "res": 20.0,
-            "maxi": 1
+            "res": 20.0
         }
 
         # Build ATL06 Request