Commit ea2ed9ff authored by Hannes Diedrich's avatar Hannes Diedrich
Browse files

Improved Readme.

parent d2654cc6
...@@ -37,20 +37,26 @@ Clone the repository with: ...@@ -37,20 +37,26 @@ Clone the repository with:
</code> </code>
## Installation ## Installation
#### ... is easy (as long your python is compatible): ### ... is easy (as long your python is compatible):
* Make sure your system meets all the Requirements (see above) * Make sure your system meets all the requirements (see above)
* Install the package by running: * Install the package by running:
`python gts2_client/setup.py install` `python gts2_client/setup.py install`
### Install a compatible python:
#### Install a compatible python:
The following instruction is only valid for Linux distributions but can be adapted on Windows machines. The following instruction is only valid for Linux distributions but can be adapted on Windows machines.
Everything is based on bash shell.
#### EITHER: Use install script and follow instructions:
Run: `bash install_py_gts2_client.sh`
##### EITHER: Use install script and follow instructions:
`./install_py_gts2_client.sh`
After providing the installation path the script will install miniconda
and all necessary packages as well as the gts2_client.
Everything is installed into a conda environment called *gts2_client*.
At the script will provide instructions how to start the environment
and which PATHs to add to your .bashrc.
##### OR: Per hand (expert modus): #### OR: Per hand (expert modus):
* Download and install at least Miniconda with default settings: * Download and install at least Miniconda with default settings:
``` ```
wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh
...@@ -62,7 +68,7 @@ rm -f Miniconda3-latest-Linux-x86_64.sh ...@@ -62,7 +68,7 @@ rm -f Miniconda3-latest-Linux-x86_64.sh
`conda env update -f gts2_client_conda_install.yml` `conda env update -f gts2_client_conda_install.yml`
#### Finally: ### Finally:
Create a credentials file in your home directory **credentials_gts2_client** Create a credentials file in your home directory **credentials_gts2_client**
that contains the following structure: that contains the following structure:
...@@ -74,7 +80,7 @@ that contains the following structure: ...@@ -74,7 +80,7 @@ that contains the following structure:
Please fill in your credentials (provided by GFZ Potsdam, please contact gts2@gfz-potsdam.de). Please fill in your credentials (provided by GFZ Potsdam, please contact gts2@gfz-potsdam.de).
## If you want to use docker ### If you want to use docker
**!! Attention: Expert mode !! root access to computer is needed.** **!! Attention: Expert mode !! root access to computer is needed.**
You only have to run **docker_gts2_client/build_run_gts2_client_docker.sh** 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. It creates an image that is based on a Centos:7, performs all needed installation steps and starts a container.
......
Markdown is supported
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