Skip to content

Latest commit

 

History

History
113 lines (61 loc) · 5.76 KB

README.rst

File metadata and controls

113 lines (61 loc) · 5.76 KB

Web Land Trajectory Service - Spec

Software License Software Life Cycle Release Join us at Discord

About

Land Use and Cover information is essential to support governments in decision making on the impact of human activities on the environment, for planning the use of natural resources, conservation of biodiversity, and monitoring climate change.

Currently, several projects systematically provide information on the dynamics of land use and cover. Well known projects include PRODES, DETER and TerraClass. These projects are developed by INPE and they produce information on land use and coverage used by the Brazilian Government to make public policy decisions. Besides these projects there are other initiatives from universities and space agencies devoted to the creation of national and global maps.

Although these projects adhere to open data policies and provide a rich collection of data, there still a gap in the integrated use of these collections: it requires from researchers, students and public officials a great effort to collect, organize and integrate all the datasets, prior to their use. In general, each collection adopts its own land use and cover classification system, with class names and meanings very different across the collections. Besides that, the collections have diffrent spatial and temporalresolutions, relies on different data representation (raster or vector) and served by diffrent systems or formats (files, database or web services).

In this context, the Web Land Trajectory Service (WLTS) is a service that aims to facilitate the access to these various "land use and cover" data collections through a tailored API. The result is tool that allows researchers and specialists to spend their time in the analytical process, once the API provides the integration of these datasets and brings the concept of Land Use and Cover Trajectories as a high level abstraction. The WLTS approach is to use a data model that defines a minimum set of temporal and spatial information to represent different sources and types of data. WLTS can be used in a range of application, such as in validation of land cover data sets, in the selection of trainning samples to support Machine Learning algorithms used in the generation of new classification maps.

Free and Open Source implementations based on this service can be found in the wlts (server) and wlts.py (Python client). See also the service LCCS-WS (Land Cover Classification System Web Service) (LCCS-WS) which is used to represent the classes associated with the resources retrieved in the queries.

Repository Organization

Overview of Service Operations

  • The /list_collections operation when queried with a GET method returns the list of collections available in the service.
  • The /describe_collection operation when queried with a GET method returns the metadata of a given data collection.
  • The /trajectory operation when queried with a GET method returns the land use and cover trajectory from the collections given a location in space. The property result contains the feature identifier information, class, time, and the collection associated to the data item. If requested, the collection geometry can also be returned

Building the Documentation

Requirements

The build system for the REST API documentation relies on the Node.js run-time environment:

  • Node.js (Version 8+).
  • ReDoc: generates HTML reference documentation from an OpenAPI specification file.

Build

If you have Node.js installed, please, execute the following command to install the ReDoc dependency:

$ npm install

After that, generate the documentation:

$ npm run build

The above command will create a folder named dist with the bundled file index.html. You may open it in your web browser or may serve it with an HTTP Server.

For Python developers, you can serve the HTML with:

python3.7 -m http.server 8080 --directory dist

License

Copyright (C) 2019-2021 INPE.

Web Land Trajectory Service is free software; you can redistribute it and/or modify it under the terms of the MIT License; see LICENSE file for more details.