Skip to content
This repository has been archived by the owner on Oct 1, 2020. It is now read-only.

Progress Report v0.1.2

Florian Lahn edited this page Mar 19, 2018 · 1 revision
  1. What is the status / are the current capabilities of the backend driver?

    • Supporting Use Case 1
    • Developed against API version 0.0.1 for backend versions < v0.1.x and develop branch
    • Api v0.0.2 support in respective feature branch (status in development)
    • supported endpoints:
      • API information
        • [GET] /capabilities
      • EO Data Discovery
        • [GET] /data
        • [GET] /data/opensearch
        • [GET] /data/{product_id}
      • Process Discovery
        • [GET] /processes
        • [GET] /processes/opensearch
        • [GET] /processes/{process_id}
      • UDF
        • [GET] /udf
        • [GET] /udf/{lang}/{udf_type}
      • User Content
        • [GET] /users/{user_id}/files
        • [GET] /users/{user_id}/files/{path}
        • [PUT] /users/{user_id}/files/{path}
        • [DELETE] /users/{user_id}/files/{path}
        • [GET] /users/{user_id}/jobs
        • [GET] /users/{user_id}/credits
      • Authentication
        • [GET] /auth/login
      • Job Management
        • [POST] /jobs
          • Batch
          • Lazy
          • Sync
        • [GET] /jobs/{job_id}
        • [DELETE] /jobs/{job_id}
        • [GET] /jobs/{job_id}/subscribe
        • [GET] /jobs/{job_id}/cancel
      • Data Download
        • [GET] /download/{format}/{job_id}
  2. A general short description of the driver / system overview

    This backend is primarily used as a testing/reference backend. As for version v0.1.1 we support the API v0.0.1 and processes for use case 1 are implemented, as well as a small Sentinel 2 imagery collection (see /processes/sentinel2_subset for reference). The data and the services are hosted on one machine and also the calculation is not distributed. At the current state this backend is purely for testing and for reference.

    You can run it as a local server on you own localhost machine or you deploy the server via Docker on a remote machine.

    The data is managed on the filesystem/in-memory. We use the raster package for loading, referencing and processing. Also GDAL and rgdal is used to extract metadata from images and prepare the output files after executing jobs.

  3. Programming language and libraries/packages/dependencies used

    • R (developed with version >= 3.3)
    • see DESCRIPTION for reference
  4. Special requirements / system configurations for using the driver

  5. Public URI to reach the openEO driver

    • none yet, you can run it on your localhost
  6. Installation instructions

    Install the package by using install_github from the devtools package. The package contains a set of example data in inst/extdata, so it might take some more time to install as usual. The data can be found in the packages install directory under /extdata.

library(devtools)
install_github(repo="Open-EO/openeo-r-backend",ref="master")

Alternatively you can use the docker-compose.yml to create the server, if you have a Docker instance at hand. Download the repository from github (currently docker-compose is only available on the develop-branch), open a linux shell or a windows powershell, change into the directory in which you downloaded the repository and type: docker-compose up -d. That's it! Building the docker image, however, will take some time, since there are a lot of R packages that need to be downloaded for the server.

  1. Working REST sample queries to the backend
  2. ...
Clone this wiki locally