Openeo Python Client Versions Save

Added

• Allow passing raw JSON string, JSON file path or URL to Connection.download(), Connection.execute() and Connection.create_job()
• Add support for reverse math operators on DataCube in apply mode (#323)
• Add DataCube.print_json() to simplify exporting process graphs in Jupyter or other interactive environments (#324)
• Raise DimensionAlreadyExistsException when trying to add_dimension() a dimension with existing name (Open-EO/openeo-geopyspark-driver#205)

Changed

• DataCube.execute_batch() now also guesses the output format from the filename, and allows using format argument next to the current out_format to align with the DataCube.download() method. (#240)
• Better client-side handling of merged band name metadata in DataCube.merge_cubes()

Removed

• Remove legacy DataCube.graph and DataCube.flatten() to prevent usage patterns that cause interoperability issues (#155, #209, #324)

Added

• Add support for passing a PGNode/VectorCube as geometry to aggregate_spatial, mask_polygon, ...
• Add support for second order callbacks e.g. is_valid in count in reduce_dimension (#317)

Changed

• Rename RESTJob class name to less cryptic and more user-friendly BatchJob. Original RESTJob is still available as deprecated alias. (#280)
• Dropped default reducer ("max") from DataCube.reduce_temporal_simple()
• Various documentation improvements:
  • general styling, landing page and structure tweaks (#285)
  • batch job docs (#286)
  • getting started docs (#308)
  • part of UDF docs (#309)
  • added process-to-method mapping docs
• Drop hardcoded h5netcdf engine from XarrayIO.from_netcdf_file() and XarrayIO.to_netcdf_file() (#314)
• Changed argument name of Connection.describe_collection() from name to collection_id to be more in line with other methods/functions.

Fixed

• Fix context/condition confusion bug with count callback in DataCube.reduce_dimension() (#317)

Added

• Add context parameter to DataCube.aggregate_spatial(), DataCube.apply_dimension(), DataCube.apply_neighborhood(), DataCube.apply(), DataCube.merge_cubes(). (#291)
• Add DataCube.fit_regr_random_forest() (#293)
• Add PGNode.update_arguments(), which combined with DataCube.result_node() allows to do advanced process graph argument tweaking/updating without using ._pg hacks.
• JobResults.download_files(): also download (by default) the job result metadata as STAC JSON file (#184)
• OIDC handling in Connection: try to automatically refresh access token when expired (#298)
• Connection.create_job raises exception if response does not contain a valid job_id
• Add openeo.udf.debug.inspect for using the openEO inspect process in a UDF (#302)
• Add openeo.util.to_bbox_dict() to simplify building a openEO style bbox dictionary, e.g. from a list or shapely geometry (#304)

Removed

• Removed deprecated (and non-functional) zonal_statistics method from old ImageCollectionClient API. (#144)

Added

• Add support for comparison operators (<, >, <= and >=) in callback process building
• Added Connection.describe_process() to retrieve and show a single process
• Added DataCube.flatten_dimensions() and DataCube.unflatten_dimension (Open-EO/openeo-processes#308, Open-EO/openeo-processes#316)
• Added VectorCube.run_udf (to avoid non-standard process_with_node(UDF(...)) usage)
• Added DataCube.fit_class_random_forest() and Connection.load_ml_model() to train and load Machine Learning models (#279)
• Added DataCube.predict_random_forest() to easily use reduce_dimension with a predict_random_forest reducer using a MlModel (trained with fit_class_random_forest)
  (#279)
• Added DataCube.resample_cube_temporal (#284)
• Add target_dimension argument to DataCube.aggregate_spatial (#288)
• Add basic configuration file system to define a default back-end URL and enable auto-authentication (#264, #187)
• Add context argument to DataCube.chunk_polygon()
• Add Connection.version_info() to list version information about the client, the API and the back-end

Changed

• Include openEO API error id automatically in exception message to simplify user support and post-mortem analysis.
• Use Connection.default_timeout (when set) also on version discovery request
• Drop ImageCollection from DataCube's class hierarchy.
• This practically removes very old (pre-0.4.0) methods like date_range_filter and bbox_filter from DataCube. (#100, #278)
• Deprecate DataCube.send_job in favor of DataCube.create_job for better consistency (internally and with other libraries) (#276)
• Update (autogenerated) openeo.processes module to 1.2.0 release (2021-12-13) of openeo-processes
• Update (autogenerated) openeo.processes module to draft version of 2022-03-16 (e4df8648) of openeo-processes
• Update openeo.extra.spectral_indices to a post-0.0.6 version of Awesome Spectral Indices

Removed

• Removed deprecated 'zonal_statistics' method from the 1.x version of the API.
• Deprecate old-style DataCube.polygonal_mean_timeseries(), DataCube.polygonal_histogram_timeseries(), DataCube.polygonal_median_timeseries() and DataCube.polygonal_standarddeviation_timeseries()

Fixed

• Support rename_labels on temporal dimension (#274)
• Basic support for mixing DataCube and ProcessBuilder objects/processing (#275)

Added

• Add experimental support for chunk_polygon process (Open-EO/openeo-processes#287)
• Add support for spatial_extent, temporal_extent and bands to Connection.load_result()
• Setting the environment variable OPENEO_BASEMAP_URL allows to set a new templated URL to a XYZ basemap for the Vue Components library, OPENEO_BASEMAP_ATTRIBUTION allows to set the attribution for the basemap (#260)
• Initial support for experimental "federation:missing" flag on partial openEO Platform user job listings (Open-EO/openeo-api#419)
• Best effort detection of mistakenly using Python builtin sum or all functions in callbacks (Forum #113)
• Automatically print batch job logs when job doesn't finish successfully (using execute_batch/run_synchronous/start_and_wait).

Added

• Add options argument to DataCube.atmospheric_correction (Open-EO/openeo-python-driver#91)
• Add atmospheric_correction_options and cloud_detection_options arguments to DataCube.ard_surface_reflectance (Open-EO/openeo-python-driver#91)
• UDP storing: add support for "returns", "categories", "examples" and "links" properties (#242)
• Add openeo.extra.spectral_indices: experimental API to easily compute spectral indices (vegetation, water, urban, ...) on a DataCube, using the index definitions from Awesome Spectral Indices

Changed

• Batch job status poll loop: ignore (temporary) "service unavailable" errors (Open-EO/openeo-python-driver#96)
• Batch job status poll loop: fail when there are too many soft errors (temporary connection/availability issues)

Fixed

• Fix DataCube.ard_surface_reflectance() to use process ard_surface_reflectance instead of atmospheric_correction

Added

• Add command line tool openeo-auth token-clear to remove OIDC refresh token cache
• Add support for OIDC device authorization grant without PKCE nor client secret, (#225, openeo-api#410)
• Add DataCube.dimension_labels() (EP-4008)
• Add Connection.load_result() (EP-4008)
• Add proper support for child callbacks in fit_curve and predict_curve (#229)
• ProcessBuilder: Add support for array_element(data, n) through data[n] syntax (#228)
• ProcessBuilder: Add support for eq and neq through == and != operators (EP-4011)
• Add DataCube.validate() for process graph validation (EP-4012 related)
• Add Connection.as_curl() for generating curl command to evaluate a process graph or DataCube from the command line
• Add support in DataCube.download() to guess output format from extension of a given filename

Changed

• Improve default handling of crs (and base/height) in filter_bbox: avoid explicitly sending null unnecessarily (#233).
• Update documentation/examples/tests: EPSG CRS in filter_bbox should be integer code, not string (#233).
• Raise ProcessGraphVisitException from ProcessGraphVisitor.resolve_from_node() (instead of generic ValueError)
• DataCube.linear_scale_range is now a shortcut for DataCube.apply(lambda x:x.x.linear_scale_range( input_min, input_max, output_min, output_max)).
  Instead of creating an invalid process graph that tries to invoke linear_scale_range on a datacube directly.
• Nicer error message when back-end does not support basic auth (#247)

Removed

• Remove unused and outdated (0.4-style) File/RESTFile classes (#115)
• Deprecate usage of DataCube.graph property (#209)

Minor release to address version packaging issue.

Added

• Support nested callbacks inside array arguments, for instance in array_modify, array_create
• Support array_concat
• add ProcessGraphUnflattener and PGNodeGraphUnflattener to unflatten a flat dict representation of a process graph to a PGNode graph (EP-3609)
• Add Connection.datacube_from_flat_graph and Connection.datacube_from_json to construct a DataCube from flat process graph representation (e.g. JSON file or JSON URL) (EP-3609)
• Add documentation about UDP unflattening and sharing (EP-3609)
• Add fit_curve and predict_curve, two methods used in change detection

Changed

• Update processes.py based on 1.1.0 release op openeo-processes project
• processes.py: include all processes from "proposals" folder of openeo-processes project
• Jupyter integration: Visual rendering for process graphs shown instead of a plain JSON representation.
• Migrate from Travis CI to GitHub Actions for documentation building and unit tests (#178, EP-3645)

Removed

• Removed unit test runs for Python 3.5 (#210)

Added

• Allow, but raise warning when specifying a CRS for the geometry passed to aggregate_spatial and mask_polygon, which is non-standard/experimental feature, only supported by specific back-ends (#204)
• Add optional argument to Parameter and fix re-encoding parameters with default value. (EP-3846)
• Add support to test strict equality with ComparableVersion
• Jupyter integration: add rich HTML rendering for more backend metadata (Job, Job Estimate, Logs, Services, User-Defined Processes)
• Add support for filter_spatial
• Add support for aggregate_temporal_period
• Added class Service for secondary web-services
• Added a method service to Connection
• Add Rfc3339.parse_date and Rfc3339.parse_date_or_datetime

Changed

• Disallow redirects on POST/DELETE/... requests and require status code 200 on POST /result requests. This improves error information where POST /result would involve a redirect. (EP-3889)
• Class JobLogEntry got replaced with a more complete and re-usable LogEntry dict
• The following methods return a Service class instead of a dict: tiled_viewing_service in ImageCollection, ImageCollectionClient and DataCube, create_service in Connection

Deprecated

• The method remove_service in Connection has been deprecated in favor of delete_service in the Service class