Skip to content

Commit

Permalink
Update README documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kalxas committed Nov 23, 2023
1 parent afc1e2f commit 4162748
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 29 deletions.
79 changes: 50 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@
<img src="images/logo.png" alt="Logo" width="80" height="80">
</a>

<h3 align="center">template-service</h3>
<h3 align="center">EOEPCA Data Access</h3>

<p align="center">
Template for developing an EOEPCA Service
This repository includes the EOEPCA Data Access building block
<br />
<a href="https://github.com/EOEPCA/rm-data-access"><strong>Explore the docs »</strong></a>
<br />
Expand All @@ -44,12 +44,11 @@

## Table of Contents

- [About the Project](#about-the-project)
- [Description](#description)
- [Built With](#built-with)
- [Interfaces](#interfaces)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Testing](#testing)
- [Deployment](#deployment)
- [Documentation](#documentation)
- [Usage](#usage)
- [Roadmap](#roadmap)
Expand All @@ -60,57 +59,79 @@

<!-- ABOUT THE PROJECT -->

## About The Project
## Description

[![Product Name Screen Shot][product-screenshot]](https://example.com)
The EOEPCA Data Access building block is built upon the upstream View Server project.

Here's a blank template to get started:
**To avoid retyping too much info. Do a search and replace with your text editor for the following:**
`rm-data-access`, `twitter_handle`, `email`
View Server is a Docker based software and all of its components are distributed and executed in context of Docker images, containers and Helm charts. Basic knowledge of Docker and either Docker Swarm or Helm and Kubernetes is a prerequisite.

### Built With

- [PRISM View Server](https://gitlab.eox.at/esa/prism/vs/)

<!-- GETTING STARTED -->
The provided external services are services for searching, viewing, and downloading of Earth Observation (EO) data. Service endpoints optimized for performance as well as for flexibility are provided alongside each other.

## Getting Started
The View Server default Chart vs consists of the following service components (with their respective Docker image in parenthesis):

To get a local copy up and running follow these simple steps.
* Web Client (client)
* Cache (cache)
* Renderer (core)
* Registrar (core)
* Seeder (seeder)
* Preprocessor (preprocessor)
* Ingestor (ingestor)
* Harvester (harvester)
* Scheduler (scheduler)
* Database (postgis)
* Queue Manager (redis)

### Prerequisites
View Server is Open Source, released under an MIT license.

[![Product Name Screen Shot][product-screenshot]](https://gitlab.eox.at/vs/vs)

### Built With

### Installation
- [Python](https://www.python.org/)
- [Django](https://www.djangoproject.com/)
- [GDAL](https://gdal.org/)
- [PostGIS](https://postgis.net/)
- [EOXServer](https://github.com/EOxServer/eoxserver)
- [EOX View Server](https://gitlab.eox.at/vs/vs)

### Interfaces

1. Setting up minikube:
The Data Access provides the following interfaces:
* OGC WMS 1.1/1.3 (EO-WMS)
* OGC WCS 2.0.0 (EO Application Profile)
* OGC WMTS 1.0
* DSEO
* OpenSearch with OGC EO, Geo and Time extensions


```bash
<!-- GETTING STARTED -->

```
## Getting Started

2. Deploying on minikube (or any other kubernetes cluster)
To get a View Server copy up and running follow these simple steps.

```bash
https://vs.pages.eox.at/vs/operator/k8s.html#operating-k8s

```
### Deployment

### Testing
Data Access deployment is described [here](https://deployment-guide.docs.eoepca.org/current/eoepca/data-access/) in the [EOEPCA Deployment Guide](https://deployment-guide.docs.eoepca.org/current/eoepca/data-access/).

## Documentation

The View Server documentation can be found at https://vs.pages.eox.at/vs/.

## Documentation
EOEPCA related documents:
* [Data Access Interface Control Document](https://eoepca.github.io/rm-data-access//ICD/)
* [Data Access Software Design Document](https://eoepca.github.io/rm-data-access/SDD/)

The component documentation can be found at https://eoepca.github.io/rm-data-access/.


<!-- USAGE EXAMPLES -->

## Usage


You can find some usage examples in the View Server Client documentation: https://vs.pages.eox.at/vs/user/webclient.html

<!-- ROADMAP -->

Expand Down
Binary file modified images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4162748

Please sign in to comment.