Skip to content

Commit 5e70bdc

Browse files
committed
Issue #726 update process_mapping doc page
1 parent 4857ed7 commit 5e70bdc

File tree

2 files changed

+25
-15
lines changed

2 files changed

+25
-15
lines changed

docs/process_mapping.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
from openeo.internal.documentation import _process_registry
1515

16-
# TODO: automate running of this tool. E.g. use https://nedbatchelder.com/code/cog
16+
# TODO #726 automate running of this tool. E.g. use https://nedbatchelder.com/code/cog
1717
# TODO: support operators properly (use `+` in docs instead of `__add__`)
1818

1919

docs/process_mapping.rst

+24-14
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,13 @@ method or function in the openEO Python Client Library.
4545
* - `apply <https://processes.openeo.org/#apply>`_
4646
- :py:meth:`ProcessBuilder.apply() <openeo.processes.ProcessBuilder.apply>`, :py:meth:`apply() <openeo.processes.apply>`, :py:meth:`DataCube.apply() <openeo.rest.datacube.DataCube.apply>`
4747
* - `apply_dimension <https://processes.openeo.org/#apply_dimension>`_
48-
- :py:meth:`ProcessBuilder.apply_dimension() <openeo.processes.ProcessBuilder.apply_dimension>`, :py:meth:`apply_dimension() <openeo.processes.apply_dimension>`, :py:meth:`DataCube.apply_dimension() <openeo.rest.datacube.DataCube.apply_dimension>`
48+
- :py:meth:`ProcessBuilder.apply_dimension() <openeo.processes.ProcessBuilder.apply_dimension>`, :py:meth:`apply_dimension() <openeo.processes.apply_dimension>`, :py:meth:`VectorCube.apply_dimension() <openeo.rest.vectorcube.VectorCube.apply_dimension>`, :py:meth:`DataCube.apply_dimension() <openeo.rest.datacube.DataCube.apply_dimension>`
4949
* - `apply_kernel <https://processes.openeo.org/#apply_kernel>`_
5050
- :py:meth:`ProcessBuilder.apply_kernel() <openeo.processes.ProcessBuilder.apply_kernel>`, :py:meth:`apply_kernel() <openeo.processes.apply_kernel>`, :py:meth:`DataCube.apply_kernel() <openeo.rest.datacube.DataCube.apply_kernel>`
5151
* - `apply_neighborhood <https://processes.openeo.org/#apply_neighborhood>`_
5252
- :py:meth:`ProcessBuilder.apply_neighborhood() <openeo.processes.ProcessBuilder.apply_neighborhood>`, :py:meth:`apply_neighborhood() <openeo.processes.apply_neighborhood>`, :py:meth:`DataCube.apply_neighborhood() <openeo.rest.datacube.DataCube.apply_neighborhood>`
53+
* - `apply_polygon <https://processes.openeo.org/#apply_polygon>`_
54+
- :py:meth:`ProcessBuilder.apply_polygon() <openeo.processes.ProcessBuilder.apply_polygon>`, :py:meth:`apply_polygon() <openeo.processes.apply_polygon>`, :py:meth:`DataCube.apply_polygon() <openeo.rest.datacube.DataCube.apply_polygon>`
5355
* - `arccos <https://processes.openeo.org/#arccos>`_
5456
- :py:meth:`ProcessBuilder.arccos() <openeo.processes.ProcessBuilder.arccos>`, :py:meth:`arccos() <openeo.processes.arccos>`
5557
* - `arcosh <https://processes.openeo.org/#arcosh>`_
@@ -114,8 +116,8 @@ method or function in the openEO Python Client Library.
114116
- :py:meth:`ProcessBuilder.cosh() <openeo.processes.ProcessBuilder.cosh>`, :py:meth:`cosh() <openeo.processes.cosh>`
115117
* - `count <https://processes.openeo.org/#count>`_
116118
- :py:meth:`ProcessBuilder.count() <openeo.processes.ProcessBuilder.count>`, :py:meth:`count() <openeo.processes.count>`, :py:meth:`DataCube.count_time() <openeo.rest.datacube.DataCube.count_time>`
117-
* - `create_raster_cube <https://processes.openeo.org/#create_raster_cube>`_
118-
- :py:meth:`ProcessBuilder.create_raster_cube() <openeo.processes.ProcessBuilder.create_raster_cube>`, :py:meth:`create_raster_cube() <openeo.processes.create_raster_cube>`
119+
* - `create_data_cube <https://processes.openeo.org/#create_data_cube>`_
120+
- :py:meth:`ProcessBuilder.create_data_cube() <openeo.processes.ProcessBuilder.create_data_cube>`, :py:meth:`create_data_cube() <openeo.processes.create_data_cube>`
119121
* - `cummax <https://processes.openeo.org/#cummax>`_
120122
- :py:meth:`ProcessBuilder.cummax() <openeo.processes.ProcessBuilder.cummax>`, :py:meth:`cummax() <openeo.processes.cummax>`
121123
* - `cummin <https://processes.openeo.org/#cummin>`_
@@ -124,6 +126,10 @@ method or function in the openEO Python Client Library.
124126
- :py:meth:`ProcessBuilder.cumproduct() <openeo.processes.ProcessBuilder.cumproduct>`, :py:meth:`cumproduct() <openeo.processes.cumproduct>`
125127
* - `cumsum <https://processes.openeo.org/#cumsum>`_
126128
- :py:meth:`ProcessBuilder.cumsum() <openeo.processes.ProcessBuilder.cumsum>`, :py:meth:`cumsum() <openeo.processes.cumsum>`
129+
* - `date_between <https://processes.openeo.org/#date_between>`_
130+
- :py:meth:`ProcessBuilder.date_between() <openeo.processes.ProcessBuilder.date_between>`, :py:meth:`date_between() <openeo.processes.date_between>`
131+
* - `date_difference <https://processes.openeo.org/#date_difference>`_
132+
- :py:meth:`ProcessBuilder.date_difference() <openeo.processes.ProcessBuilder.date_difference>`, :py:meth:`date_difference() <openeo.processes.date_difference>`
127133
* - `date_shift <https://processes.openeo.org/#date_shift>`_
128134
- :py:meth:`ProcessBuilder.date_shift() <openeo.processes.ProcessBuilder.date_shift>`, :py:meth:`date_shift() <openeo.processes.date_shift>`
129135
* - `dimension_labels <https://processes.openeo.org/#dimension_labels>`_
@@ -141,23 +147,25 @@ method or function in the openEO Python Client Library.
141147
* - `extrema <https://processes.openeo.org/#extrema>`_
142148
- :py:meth:`ProcessBuilder.extrema() <openeo.processes.ProcessBuilder.extrema>`, :py:meth:`extrema() <openeo.processes.extrema>`
143149
* - `filter_bands <https://processes.openeo.org/#filter_bands>`_
144-
- :py:meth:`ProcessBuilder.filter_bands() <openeo.processes.ProcessBuilder.filter_bands>`, :py:meth:`filter_bands() <openeo.processes.filter_bands>`, :py:meth:`DataCube.filter_bands() <openeo.rest.datacube.DataCube.filter_bands>`
150+
- :py:meth:`ProcessBuilder.filter_bands() <openeo.processes.ProcessBuilder.filter_bands>`, :py:meth:`filter_bands() <openeo.processes.filter_bands>`, :py:meth:`VectorCube.filter_bands() <openeo.rest.vectorcube.VectorCube.filter_bands>`, :py:meth:`DataCube.filter_bands() <openeo.rest.datacube.DataCube.filter_bands>`
145151
* - `filter_bbox <https://processes.openeo.org/#filter_bbox>`_
146-
- :py:meth:`ProcessBuilder.filter_bbox() <openeo.processes.ProcessBuilder.filter_bbox>`, :py:meth:`filter_bbox() <openeo.processes.filter_bbox>`, :py:meth:`DataCube.filter_bbox() <openeo.rest.datacube.DataCube.filter_bbox>`
152+
- :py:meth:`ProcessBuilder.filter_bbox() <openeo.processes.ProcessBuilder.filter_bbox>`, :py:meth:`filter_bbox() <openeo.processes.filter_bbox>`, :py:meth:`VectorCube.filter_bbox() <openeo.rest.vectorcube.VectorCube.filter_bbox>`, :py:meth:`DataCube.filter_bbox() <openeo.rest.datacube.DataCube.filter_bbox>`
147153
* - `filter_labels <https://processes.openeo.org/#filter_labels>`_
148-
- :py:meth:`ProcessBuilder.filter_labels() <openeo.processes.ProcessBuilder.filter_labels>`, :py:meth:`filter_labels() <openeo.processes.filter_labels>`
154+
- :py:meth:`ProcessBuilder.filter_labels() <openeo.processes.ProcessBuilder.filter_labels>`, :py:meth:`filter_labels() <openeo.processes.filter_labels>`, :py:meth:`VectorCube.filter_labels() <openeo.rest.vectorcube.VectorCube.filter_labels>`, :py:meth:`DataCube.filter_labels() <openeo.rest.datacube.DataCube.filter_labels>`
149155
* - `filter_spatial <https://processes.openeo.org/#filter_spatial>`_
150156
- :py:meth:`ProcessBuilder.filter_spatial() <openeo.processes.ProcessBuilder.filter_spatial>`, :py:meth:`filter_spatial() <openeo.processes.filter_spatial>`, :py:meth:`DataCube.filter_spatial() <openeo.rest.datacube.DataCube.filter_spatial>`
151157
* - `filter_temporal <https://processes.openeo.org/#filter_temporal>`_
152158
- :py:meth:`ProcessBuilder.filter_temporal() <openeo.processes.ProcessBuilder.filter_temporal>`, :py:meth:`filter_temporal() <openeo.processes.filter_temporal>`, :py:meth:`DataCube.filter_temporal() <openeo.rest.datacube.DataCube.filter_temporal>`
159+
* - `filter_vector <https://processes.openeo.org/#filter_vector>`_
160+
- :py:meth:`ProcessBuilder.filter_vector() <openeo.processes.ProcessBuilder.filter_vector>`, :py:meth:`filter_vector() <openeo.processes.filter_vector>`, :py:meth:`VectorCube.filter_vector() <openeo.rest.vectorcube.VectorCube.filter_vector>`
153161
* - `first <https://processes.openeo.org/#first>`_
154162
- :py:meth:`ProcessBuilder.first() <openeo.processes.ProcessBuilder.first>`, :py:meth:`first() <openeo.processes.first>`
155163
* - `fit_class_random_forest <https://processes.openeo.org/#fit_class_random_forest>`_
156-
- :py:meth:`ProcessBuilder.fit_class_random_forest() <openeo.processes.ProcessBuilder.fit_class_random_forest>`, :py:meth:`fit_class_random_forest() <openeo.processes.fit_class_random_forest>`, :py:meth:`VectorCube.fit_class_random_forest() <openeo.rest.vectorcube.VectorCube.fit_class_random_forest>`
164+
- :py:meth:`VectorCube.fit_class_random_forest() <openeo.rest.vectorcube.VectorCube.fit_class_random_forest>`
157165
* - `fit_curve <https://processes.openeo.org/#fit_curve>`_
158166
- :py:meth:`ProcessBuilder.fit_curve() <openeo.processes.ProcessBuilder.fit_curve>`, :py:meth:`fit_curve() <openeo.processes.fit_curve>`, :py:meth:`DataCube.fit_curve() <openeo.rest.datacube.DataCube.fit_curve>`
159167
* - `fit_regr_random_forest <https://processes.openeo.org/#fit_regr_random_forest>`_
160-
- :py:meth:`ProcessBuilder.fit_regr_random_forest() <openeo.processes.ProcessBuilder.fit_regr_random_forest>`, :py:meth:`fit_regr_random_forest() <openeo.processes.fit_regr_random_forest>`, :py:meth:`VectorCube.fit_regr_random_forest() <openeo.rest.vectorcube.VectorCube.fit_regr_random_forest>`
168+
- :py:meth:`VectorCube.fit_regr_random_forest() <openeo.rest.vectorcube.VectorCube.fit_regr_random_forest>`
161169
* - `flatten_dimensions <https://processes.openeo.org/#flatten_dimensions>`_
162170
- :py:meth:`ProcessBuilder.flatten_dimensions() <openeo.processes.ProcessBuilder.flatten_dimensions>`, :py:meth:`flatten_dimensions() <openeo.processes.flatten_dimensions>`, :py:meth:`DataCube.flatten_dimensions() <openeo.rest.datacube.DataCube.flatten_dimensions>`
163171
* - `floor <https://processes.openeo.org/#floor>`_
@@ -193,15 +201,17 @@ method or function in the openEO Python Client Library.
193201
* - `load_collection <https://processes.openeo.org/#load_collection>`_
194202
- :py:meth:`ProcessBuilder.load_collection() <openeo.processes.ProcessBuilder.load_collection>`, :py:meth:`load_collection() <openeo.processes.load_collection>`, :py:meth:`DataCube.load_collection() <openeo.rest.datacube.DataCube.load_collection>`, :py:meth:`Connection.load_collection() <openeo.rest.connection.Connection.load_collection>`
195203
* - `load_geojson <https://processes.openeo.org/#load_geojson>`_
196-
- :py:meth:`VectorCube.load_geojson() <openeo.rest.vectorcube.VectorCube.load_geojson>`, :py:meth:`Connection.load_geojson() <openeo.rest.connection.Connection.load_geojson>`
204+
- :py:meth:`ProcessBuilder.load_geojson() <openeo.processes.ProcessBuilder.load_geojson>`, :py:meth:`load_geojson() <openeo.processes.load_geojson>`, :py:meth:`VectorCube.load_geojson() <openeo.rest.vectorcube.VectorCube.load_geojson>`, :py:meth:`Connection.load_geojson() <openeo.rest.connection.Connection.load_geojson>`
197205
* - `load_ml_model <https://processes.openeo.org/#load_ml_model>`_
198206
- :py:meth:`ProcessBuilder.load_ml_model() <openeo.processes.ProcessBuilder.load_ml_model>`, :py:meth:`load_ml_model() <openeo.processes.load_ml_model>`, :py:meth:`MlModel.load_ml_model() <openeo.rest.mlmodel.MlModel.load_ml_model>`
199207
* - `load_result <https://processes.openeo.org/#load_result>`_
200208
- :py:meth:`ProcessBuilder.load_result() <openeo.processes.ProcessBuilder.load_result>`, :py:meth:`load_result() <openeo.processes.load_result>`, :py:meth:`Connection.load_result() <openeo.rest.connection.Connection.load_result>`
201209
* - `load_stac <https://processes.openeo.org/#load_stac>`_
202-
- :py:meth:`Connection.load_stac() <openeo.rest.connection.Connection.load_stac>`
210+
- :py:meth:`ProcessBuilder.load_stac() <openeo.processes.ProcessBuilder.load_stac>`, :py:meth:`load_stac() <openeo.processes.load_stac>`, :py:meth:`Connection.load_stac() <openeo.rest.connection.Connection.load_stac>`
203211
* - `load_uploaded_files <https://processes.openeo.org/#load_uploaded_files>`_
204212
- :py:meth:`ProcessBuilder.load_uploaded_files() <openeo.processes.ProcessBuilder.load_uploaded_files>`, :py:meth:`load_uploaded_files() <openeo.processes.load_uploaded_files>`
213+
* - `load_url <https://processes.openeo.org/#load_url>`_
214+
- :py:meth:`ProcessBuilder.load_url() <openeo.processes.ProcessBuilder.load_url>`, :py:meth:`load_url() <openeo.processes.load_url>`, :py:meth:`VectorCube.load_url() <openeo.rest.vectorcube.VectorCube.load_url>`, :py:meth:`Connection.load_url() <openeo.rest.connection.Connection.load_url>`
205215
* - `log <https://processes.openeo.org/#log>`_
206216
- :py:meth:`ProcessBuilder.log() <openeo.processes.ProcessBuilder.log>`, :py:meth:`log() <openeo.processes.log>`, :py:meth:`DataCube.logarithm() <openeo.rest.datacube.DataCube.logarithm>`, :py:meth:`DataCube.log2() <openeo.rest.datacube.DataCube.log2>`, :py:meth:`DataCube.log10() <openeo.rest.datacube.DataCube.log10>`
207217
* - `lt <https://processes.openeo.org/#lt>`_
@@ -261,7 +271,7 @@ method or function in the openEO Python Client Library.
261271
* - `reduce_dimension <https://processes.openeo.org/#reduce_dimension>`_
262272
- :py:meth:`ProcessBuilder.reduce_dimension() <openeo.processes.ProcessBuilder.reduce_dimension>`, :py:meth:`reduce_dimension() <openeo.processes.reduce_dimension>`, :py:meth:`DataCube.reduce_dimension() <openeo.rest.datacube.DataCube.reduce_dimension>`
263273
* - `reduce_spatial <https://processes.openeo.org/#reduce_spatial>`_
264-
- :py:meth:`ProcessBuilder.reduce_spatial() <openeo.processes.ProcessBuilder.reduce_spatial>`, :py:meth:`reduce_spatial() <openeo.processes.reduce_spatial>`
274+
- :py:meth:`ProcessBuilder.reduce_spatial() <openeo.processes.ProcessBuilder.reduce_spatial>`, :py:meth:`reduce_spatial() <openeo.processes.reduce_spatial>`, :py:meth:`DataCube.reduce_spatial() <openeo.rest.datacube.DataCube.reduce_spatial>`
265275
* - `rename_dimension <https://processes.openeo.org/#rename_dimension>`_
266276
- :py:meth:`ProcessBuilder.rename_dimension() <openeo.processes.ProcessBuilder.rename_dimension>`, :py:meth:`rename_dimension() <openeo.processes.rename_dimension>`, :py:meth:`DataCube.rename_dimension() <openeo.rest.datacube.DataCube.rename_dimension>`
267277
* - `rename_labels <https://processes.openeo.org/#rename_labels>`_
@@ -282,8 +292,6 @@ method or function in the openEO Python Client Library.
282292
- :py:meth:`ProcessBuilder.run_udf_externally() <openeo.processes.ProcessBuilder.run_udf_externally>`, :py:meth:`run_udf_externally() <openeo.processes.run_udf_externally>`
283293
* - `sar_backscatter <https://processes.openeo.org/#sar_backscatter>`_
284294
- :py:meth:`ProcessBuilder.sar_backscatter() <openeo.processes.ProcessBuilder.sar_backscatter>`, :py:meth:`sar_backscatter() <openeo.processes.sar_backscatter>`, :py:meth:`DataCube.sar_backscatter() <openeo.rest.datacube.DataCube.sar_backscatter>`
285-
* - `save_ml_model <https://processes.openeo.org/#save_ml_model>`_
286-
- :py:meth:`ProcessBuilder.save_ml_model() <openeo.processes.ProcessBuilder.save_ml_model>`, :py:meth:`save_ml_model() <openeo.processes.save_ml_model>`
287295
* - `save_result <https://processes.openeo.org/#save_result>`_
288296
- :py:meth:`ProcessBuilder.save_result() <openeo.processes.ProcessBuilder.save_result>`, :py:meth:`save_result() <openeo.processes.save_result>`, :py:meth:`VectorCube.save_result() <openeo.rest.vectorcube.VectorCube.save_result>`, :py:meth:`DataCube.save_result() <openeo.rest.datacube.DataCube.save_result>`
289297
* - `sd <https://processes.openeo.org/#sd>`_
@@ -322,11 +330,13 @@ method or function in the openEO Python Client Library.
322330
- :py:meth:`ProcessBuilder.variance() <openeo.processes.ProcessBuilder.variance>`, :py:meth:`variance() <openeo.processes.variance>`
323331
* - `vector_buffer <https://processes.openeo.org/#vector_buffer>`_
324332
- :py:meth:`ProcessBuilder.vector_buffer() <openeo.processes.ProcessBuilder.vector_buffer>`, :py:meth:`vector_buffer() <openeo.processes.vector_buffer>`
333+
* - `vector_reproject <https://processes.openeo.org/#vector_reproject>`_
334+
- :py:meth:`ProcessBuilder.vector_reproject() <openeo.processes.ProcessBuilder.vector_reproject>`, :py:meth:`vector_reproject() <openeo.processes.vector_reproject>`
325335
* - `vector_to_random_points <https://processes.openeo.org/#vector_to_random_points>`_
326336
- :py:meth:`ProcessBuilder.vector_to_random_points() <openeo.processes.ProcessBuilder.vector_to_random_points>`, :py:meth:`vector_to_random_points() <openeo.processes.vector_to_random_points>`
327337
* - `vector_to_regular_points <https://processes.openeo.org/#vector_to_regular_points>`_
328338
- :py:meth:`ProcessBuilder.vector_to_regular_points() <openeo.processes.ProcessBuilder.vector_to_regular_points>`, :py:meth:`vector_to_regular_points() <openeo.processes.vector_to_regular_points>`
329339
* - `xor <https://processes.openeo.org/#xor>`_
330340
- :py:meth:`ProcessBuilder.xor() <openeo.processes.ProcessBuilder.xor>`, :py:meth:`xor() <openeo.processes.xor>`
331341

332-
:subscript:`(Table autogenerated on 2023-08-07)`
342+
:subscript:`(Table autogenerated on 2025-02-12)`

0 commit comments

Comments
 (0)