Commit 1294461d authored by Hannes Diedrich's avatar Hannes Diedrich
Browse files

Improved README.

parent e7af1ade
......@@ -7,6 +7,9 @@ Status
[Coverage report](http://gts2.gitext.gfz-potsdam.de/gts2_client/coverage/)
## Release notes
* **2018-01-19:** Added installation information and conda installation file for all needed packages
* **2018-01-18:** Added docker file and script for building an compatible image and running a container for the client
* **2018-01-17:** Added option for mosaicing/merging tifs and RGBs on client side
* **2018-01-10:** Added output of RGB images into jpg or png, nc-output still in progress
## Description
......@@ -16,8 +19,8 @@ time of interest and wanted band combination and saves them to geotiff (.tiff)
or alternatively as .json file or as netcdf (.nc) file.
## Requirements
1. Access to GTS2 API (username and password)
1. Python 3
1. Access to GTS2 API (username, password, port)
1. Python3
1. Python packages:
* numpy
* gdal
......@@ -33,21 +36,47 @@ Clone the repository with:
</code>
## Installation
1. Make sure your system meets all the Requirements (see above)
* For GFZ users: you can achieve that by using the gfz python.
For that please run: <code>module load pygfz</code>
2. Install the package by first going into the repository folder and then run:
<code> python gts2_client/setup.py install </code>
3. Create a credentials file in your home directory **credentials_gts2_client**
that contains the following structure:
#### ... is easy (as long your python is compatible):
* Make sure your system meets all the Requirements (see above)
* Install the package by first going into the repository folder and then run:
`python gts2_client/setup.py install`
#### Install a compatible python:
The following instruction is only valid for Linux distributions but can be adapted on Windows machines.
* Download and install at least Miniconda with default settings:
```wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh
chmod 755 Miniconda3-latest-Linux-x86_64.sh
./Miniconda3-latest-Linux-x86_64.sh -b
rm -f Miniconda3-latest-Linux-x86_64.sh
```
* Clone the gts2_repo with `git clone`
* Start a new shell and install needed packages for gts2_client using **gts2_client_conda_install.yml**
`conda env update -f gts2_client_conda_install.yml`
#### Finally:
Create a credentials file in your home directory **credentials_gts2_client**
that contains the following structure:
```bash
{"user": "",
"password": ""}
"password": ""
"port": ""}
```
Please fill in your credentials (provided by GFZ Potsdam, please contact gts2@gfz-potsdam.de).
## If you want to use docker
**!! Attention: Expert mode !! root access to computer is needed.**
You only have to run **docker_gts2_client/build_run_gts2_client_docker.sh**
It creates an image that is based on a Centos:7, performs all needed installation steps and starts a container.
You end up with a shell where you can run `gts2_client`.
The building of the image can take some time (up to 30 Minutes), but once it is done,
**docker_gts2_client/build_run_gts2_client_docker.sh** skips the build and only starts the container.
## Usage
### As command line tool:
......@@ -56,7 +85,7 @@ gts2_client.py required_arguments [optional_arguments]
```
The list of arguments including their default values can be called from the command line with:
<code>gts2_client --help</code>
`gts2_client --help`
#### Arguments:
##### Required:
......@@ -110,6 +139,12 @@ The list of arguments including their default values can be called from the comm
realistic, nice_looking, vegetation,
healthy_vegetation_urban, water, snow, agriculture
(default: realistic)
* -w MERGE_TIFS, --merge_tifs MERGE_TIFS
Merge tifs and RGBs if area in two or more MGRS tiles
per time step (True or False). (default: False)
* -x MERGE_TILE, --merge_tile MERGE_TILE
Choose MGRS tile into which the merge of files is
performed (e.g. 33UUV). (default: None)
### As python package
......@@ -122,3 +157,6 @@ result = gts2_client.client(out_mode="python", **kwargs)
## Limitations:
* Bands with spatial resolution 60m (Band 1) are not stacked.
* Requests with areas larger than 0.2°x0.2° will probably not be processed
if you also request a large time range this threshold can also be smaller
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment