.. include:: references.rst .. _appendix: ************ Glossary ************ .. glossary:: :sorted: ADES | |ades| | See :ref:`processes` section for details. Alternative operation modes are described in :ref:`Configuration Settings`. AOI | Area of Interest. | Corresponds to a region, often provided by :term:`OGC` :term:`WKT` definition, employed for :term:`OpenSearch` queries in the context of :term:`EOImage` inputs. API | Application Programming Interface | Most typically, referring to the use of HTTP(S) requests following an :term:`OpenAPI` specification. | | In the context of this project, it is also used in some occasion to refer to the RESTful interface of :term:`OGC API - Processes`, in contrast to the :term:`OWS` :term:`WPS` interface. Application Package General term that refers to *"what and how to execute"* the :term:`Process`. Application Packages provide the core details about the execution methodology of the underlying operation that defines the :term:`Process`, and are therefore always contained within a :ref:`Process Description `. This is more specifically represented by a :term:`CWL` specification in the case of `Weaver` implementation, but could technically be defined by another similar approach. See the :ref:`Application Package` section for all relevant details. AWS | Amazon Web Services | In the context of `Weaver`, most often referring specifically to the use of :term:`S3` buckets. Bill Billing Result from :ref:`quotation_billing` following :ref:`quote_estimation` when enabled on the `Weaver` instance. .. seealso:: - :ref:`quotation` - :ref:`conf_quotation` Builtin Process An immutable :term:`Process` that comes pre-packaged with `Weaver`, without need to be deployed. This is usually an "utility" or "converter" :term:`Process` that is often reused across :term:`Workflow` definitions. .. seealso:: Refer to the :ref:`proc_builtin` section for more details about available processes. CLI | Command Line Interface | Script that offers interactions through shell commands or Python scripts to execute any described operations. Details of the provided `Weaver` commands are described in :ref:`cli` chapter. Collection A geospatial resource that may be available as one or more sub-resource distributions that conform to one or more |ogc-api-standards|_. Additionally, |stac-collections|_ can be included in this group. Please refer to the :term:`OGC` official |ogc-collection|_ for more details and complementary terminology. CURIE Compact URI A shortened representation of a :term:`URI` that uses a prefix and a reference separated by a colon, such as ``prefix:reference``. In the context of :term:`OGC API`, this is often used to represent a link relation (``rel``) value in HTTP headers or other locations (e.g.: ``[ogc-rel:results]``). CRS Coordinate Reference System Geospatial data encoding of the representation parameters, describing the structure to locate entities, in terms of axis order (latitude, longitude, altitude, etc.), dimension (2D, 3D, etc.), in respect to a specific celestial object, a position of origin, scale and orientation (i.e: |datum-def|_). .. seealso:: - Reference :term:`W3C`/:term:`OGC` documentation about |crs|_. - Reference definition of |crs-def|_. CWL Common Workflow Language Representation of the internal :term:`Application Package` of the :term:`Process` to provide execution methodology of the referenced :term:`Docker` image or other supported definitions. A |cwl|_ file can be represented both in :term:`JSON` or :term:`YAML` format, but is often represented in :term:`JSON` in the context of `Weaver` for its easier inclusion within HTTP request contents. .. seealso:: - Official |cwl|_ documentation. - :ref:`application-package` section for further details. Data Source Known locations of remote servers where an :term:`ADES` or :term:`EMS` (either `Weaver` or other implementation) can accept :term:`Process` deployment, or any other server supporting :term:`OGC API - Processes` with pre-deployed :term:`Process`, where executions can be dispatched according to the source of the data. .. seealso:: Refer to :ref:`conf_data_sources` and :ref:`data-source` sections for more details. Docker Containerized and isolated environment platform that allows all required dependencies of an application or software to be packaged in a single image in order to correctly execute the virtualized application. EDAM Ontology that regroups multiple definitions, amongst which `Weaver` looks up some of its known and supported :term:`MIME-types` (|edam-link|_) when resolving file formats. It is used as extension to :term:`IANA` media types by providing additional formats that are more specifics to some data domains. EMS Execution Management Service | |ems| | See :ref:`processes` section for details. Alternative operation modes are described in :ref:`Configuration Settings`. EOImage | Earth Observation Image | Input that interprets additional parameters in order to infer specific images applicable with filters following search results within a remote catalog. .. seealso:: :ref:`opensearch_data_source` section. ESGF Earth System Grid Federation An open source effort providing a robust, distributed data and computation platform, enabling world wide access to large-scale scientific data. .. seealso:: |esgf|_ official website. ESGF-CWT |esgf-cwt-git|_ .. seealso:: :ref:`proc_esgf_cwt` for more details about the :term:`Process` type. Feature An abstraction of real-world phenomena into a digital entity representation, which includes information detailing its *extent* (i.e.: how it is placed and located in time and space). .. seealso:: - :term:`OGC` |feature-ogc-def|_ definition. - :term:`W3C` |feature-w3c-def|_ definition. - :term:`W3C` |feature-w3c-desc|_ examples and extended description. GeoJSON | Geospatial :term:`JSON` | A specific :term:`JSON` format representation for encoding a variety of geographic data structures, such as ``Point``, ``LineString``, ``Polygon``, ``MultiPoint``, ``MultiLineString``, and ``MultiPolygon``, ``Feature``, and ``FeatureCollection``. .. seealso:: Refer to the official |geojson|_ specification for more details. .. note:: Multiple extended or derived variants exist. Notably, the |ogc-api-features|_ and |stac-spec|_ define additional ``properties`` or additional ``type`` values for particular use cases, but remain generally interoperable and compatible. HREF | Hyperlink Reference | Often shortened to simply `reference`. Represents either a locally or remotely accessible item, such as a file or a :term:`Process` depending on context, that uses explicit ``://`` representation to define its location. See also :ref:`File Reference Types` for typical examples. HYBRID | Combination of :term:`ADES` and :term:`EMS` operation modes. | See :ref:`processes` section for details. Alternative operation modes are described in :ref:`Configuration Settings`. I/O Inputs and/or Outputs of :term:`CWL`, :term:`OAP`, :term:`WPS` or :term:`OAS` representation depending on context. IANA Ontology that regroups multiple definitions, amongst which `Weaver` looks up most of its known and supported :term:`MIME-types` (|iana-link|_) when resolving file formats. HTML | HyperText Markup Language | Alternative representation of some endpoints provided by the application. Requires appropriate ``Accept`` header or ``f``/``format`` query to return this format. .. seealso:: See :ref:`OpenAPI Specification` for details. JSON | JavaScript Object Notation | Default data representation of all objects contained in the application or for their creation when using the :term:`API`, except for the :term:`OWS` :term:`WPS` endpoint. Job Definition of a :term:`Process` execution state with applicable operation metadata. KVP | Key-Value Pairs | String representation of a set of key-value pairs, usually but not limited to, ``=`` character separating keys from their values, ``,`` for multi-value (array) definitions, and another separator such as ``&`` or ``;`` to distinguish between distinct pairs. Specific separators, and any applicable escaping methods, depend on context, such as in URL query, HTTP header, :term:`CLI` parameter, within :ref:`proc_exec_kvp` request parameters, etc. Media-Type Media-Types MIME-types | Multipurpose Internet Mail Extensions | Format representation of the referenced element, often represented by :term:`IANA` or :term:`EDAM` ontologies. More recent `Media-Type` naming is employed for the general use of ``Content-Type`` data representation in multiple situations and contexts. .. seealso:: - |iana-link|_ - |edam-link|_ OAS OpenAPI OpenAPI Specification (`OAS`) defines a standard, programming language-agnostic interface description for HTTP APIs. It is used in `Weaver` and :term:`OGC API - Processes` to represent API definitions for requests and responses, as well as :term:`I/O` definitions for :term:`Process` description. .. seealso:: |OpenAPI-spec|_ OGC Open Geospatial Consortium International standards organization for geospatial data and processing best practices that establishes most of the :term:`API` definition implied under `Weaver`. .. seealso:: |ogc|_ OGC API Regroups all the :term:`API` standards defined by :term:`OGC`, including :term:`OGC API - Processes`. These are often distinguished from the older :term:`OWS` standards such as :term:`WPS`. OAP OGC API - Processes The new :term:`API` that defines :term:`JSON` REST-binding representation of the older :term:`WPS` representation of :term:`Process` descriptions. This is the **main** interface that `Weaver` employs. .. seealso:: :ref:`proc_ogc_api` ONNX The |ONNX-long|_ standard is an open format employed for sharing machine learning model representations with an agnostic approach across frameworks, tools, runtimes, and compilers. .. seealso:: :ref:`quotation_estimator_model` openEO | Open Earth Observation | Cloud backend :term:`API` initiative for unified Earth Observation, as described by :ref:`openEO`. OpenSearch Protocol of lookup and retrieval of remotely stored files. Please refer to :ref:`OpenSearch Data Source` for details. OWS | :term:`OGC` Web Services | Family of services including :term:`WPS`, defined prior to the family of :term:`OGC` :term:`API` standards. Process Entity that describes the required inputs, produced outputs, and any applicable metadata for the execution of the defined script, calculation, or operation. Profile Content representation of an entity (such as a :term:`Process` or :term:`Job`) under a certain schema or established standard. In most cases, |content_negotiation_profile|_ will default to an :term:`OGC API - Processes` representation in `Weaver`, but other alternatives can be provided in certain cases, such as for corresponding :term:`WPS` or :term:`openEO` response contents. PROV Provenance Metadata using the :term:`W3C` |PROV|_ standard that is applied to a submitted :term:`Job` execution to allow retrieving its origin, the related :term:`Application Package`, its :term:`I/O` sources and results, as well as additional details about the server host and runtime user as applicable to replicate the experiment. .. seealso:: :ref:`proc_op_job_prov` Provider Entity that offers an ensemble of :term:`Process` under it. It is typically a reference to a remote service, where any :term:`Process` it provides is fetched dynamically on demand. Quote Quotation Result from :ref:`quote_estimation` when enabled on the `Weaver` instance. .. seealso:: - :ref:`quotation` - :ref:`conf_quotation` Quote Estimator Quotation Estimator A model that can provide cost estimations regarding the execution of a :term:`Process` to form a term:`Quote`. .. seealso:: - :ref:`quotation_estimator_model` - :ref:`conf_quotation` Request Options Configuration settings that can be defined for `Weaver` in order to automatically insert additional HTTP request parameters, authentication or other any relevant rules when target URLs are matched. See also :ref:`conf_request_options`. S3 Simple Storage Service (:term:`AWS` S3), bucket file storage. STAC | SpatioTemporal Asset Catalog | Language used to describe geospatial information, using extended definitions of :term:`GeoJSON`, and which can usually be searched using a |stac-api-spec|_ compliant with |ogc-api-features|_. .. seealso:: Please refer to the |stac-spec|_ for more details. TOI | Time of Interest | Corresponds to a date/time interval employed for :term:`OpenSearch` queries in the context of :term:`EOImage` inputs. UoM | Unit of Measure | Represents a measurement defined as literal value associated with a specific unit that could take advantage of known conversion methods with other compatible units to obtain the equivalent value. These values are transferred to the :term:`Process` as specified, and it is up to the underlying :term:`Application Package` definition to interpret it as deemed fit. URI | Uniform Resource Identifier | Superset of :term:`URL` and :term:`URN` that uses a specific string format to identify a resource, with their of their respective notations. URL | Uniform Resource Locator | Subset of :term:`URI` that follows the ``://`` notation, as per :rfc:`1738`. Specifies where an identified resource is available and the protocol mechanism employed for retrieving it. This is employed in `Weaver` for ``http(s)://``, ``s3://`` and ``file://`` locations by :term:`I/O`, or in general to refer to :term:`API` locations. URN | Uniform Resource Name | Subset of :term:`URI` that follows the ``urn::`` notation, as per :rfc:`8141`. It is used to register a unique reference to a named entity such as a :term:`UoM` or other common definitions. .. seealso:: - `IANA URN Namespaces `_ Vault Secured storage employed to upload files that should be temporarily stored on the `Weaver` server for later retrieval using an access token. .. seealso:: - :ref:`vault_upload` - :ref:`file_vault_inputs` W3C World Wide Web Consortium Main international standards organization for the World Wide Web. Since |ogc-api-standards|_ are based on HTTP and web communications, this consortium establishes the common foundation definitions used by the :term:`API` specifications. .. seealso:: |w3c|_ WKT Well-Known Text geometry representation. Workflow A specific variant of :term:`Process` where the execution consists of nested :term:`Process` executions with input/output chaining between operations. .. seealso:: Refer to :ref:`proc_workflow`, :ref:`proc_workflow_ops` and :ref:`app_pkg_workflow` sections for more details. WPS | Web Processing Service. | From a formal standpoint, this is the previous :term:`OGC` standard iteration that was employed prior to :term:`OGC API - Processes` to represent a server that host one or more :term:`Process` for execution. When compared against :term:`CWL` context or generally across `Weaver` documentation and code, this term refers to attributes that are specific to typical :term:`Process` description, in contrast to specialized attributes introduced by other concepts, such as for example :term:`CWL`-specific implementation details. WPS-REST Alias employed to refer to :term:`OGC API - Processes` endpoints for corresponding :term:`WPS` definitions. WPS-T Alias employed to refer to older revisions of :term:`OGC API - Processes` standard. The name referred to :term:`WPS` *Transactional* operations introduced by the RESTful API. XML | Extensible Markup Language | Alternative representation of some data object provided by the application. Requires appropriate ``Accept`` header or ``f``/``format`` query to return this format. For the :term:`OWS` :term:`WPS` endpoint, this is the default representation instead of :term:`JSON`. .. seealso:: See :ref:`OpenAPI Specification` for details. YAML | YAML Ain't Markup Language | YAML is a human-friendly data serialization language for all programming languages. It is employed in `Weaver` as an alternative and equivalent representation of :term:`JSON` format, mostly in cases where configuration files are defined to allow the insertion of additional documentation details. ************ Useful Links ************ - |cwl-home|_ - |cwl-spec|_ - |cwl-guide|_ - |cwl-cmdtool|_ - |cwl-workflow|_ - |esgf-cwt-git|_ - |edam-link|_ - |iana-link|_ - |oas|_ - |ogc|_ (:term:`OGC`) - |ogc-api-proc|_ - |weaver-issues|_