Skip to content

Latest commit

 

History

History
66 lines (51 loc) · 3.27 KB

README.md

File metadata and controls

66 lines (51 loc) · 3.27 KB

GeoSoftII_Frontend

Geosoftware II project WiSe 2020/21

Table of contents

1. Overview
2. Installation
3. Scope of functionalities
4. Examples of use
5. Appendix

Overview

This project is part of a new openEO back-end driver which uses the Pangeo Software Stack.

The goal is to provide a openEO compliant HTTP API which can communicate with other micorservices in the project. It can create and execute batch jobs. These jobs load data and execute two predefined processes. For more information on the other micorservices you can look at their repositories:

  1. Data storage
  2. NDVI calculation
  3. SST calculation

This subproject covers the points /F0010/ to /F0060/ of the requirements.

There also exists a Docker Repository, which is linked with this one and from which the service can be obtained as an image. And can then be used locally as a container.


Installation

The installation and execution is possible exclusively provided within the framework of the docker-compose.yml.

docker-compose up

You can now checkout every endpoint with the base url localhost/api/v1/.


Scope of functionalities

This HTTP API is structured after the openEO API specification. At the moment only the most basic endpoints are implemented.

The first main function of this microservice is to provide basic information on the processes and collections offered by the whole project under the endpoints /processes and /collections. The second one is to create, change and execute the batch jobs which can start the other microservices.

API endpoints

  • GET /collections List all available collections
  • GET /processes Lists all available processes
  • GET /jobs Lists all created batch jobs
  • POST /jobs Creates a new batch job with the posted JSON
  • GET /jobs/{job_id}/ Returns information about the specified job
  • DELETE /jobs/{job_id}/ Deletes the specified job
  • PATCH /jobs/{job_id}/ Updates the specified job with posted JSON
  • GET /jobs/{job_id}/results Get a download link for the specified job


Appendix

Technologies

Software Version
flask 1.1.2
requests 2.25.0
flask_cors 3.0.9
xarray 0.16.1
dask 2.30.0
numpy 1.19.3
scipy 1.6.0
netCDF4 1.19.3