Updated README.md

README.md

 
+# AROSICS: 
+### An Automated and Robust Open-Source Image Co-Registration Software for Multi-Sensor Satellite Data
+
+
+* Free software: Apache Software License 2.0
+* Documentation: https://arosics.readthedocs.io.
+
+
+
 # Description
 
 Perform subpixel coregistration of two satellite image datasets using Fourier Shift Theorem proposed by Foroosh et al. 2002: Foroosh, H., Zerubia, J. B., & Berthod, M. (2002). Extension of phase correlation to subpixel registration. IEEE Transactions on Image Processing, 11(3), 188-199. doi:10.1109/83.988953); Python implementation by Daniel Scheffler (daniel.scheffler [at] gfz-potsdam [dot] de).
@@ -11,27 +20,35 @@ The input images can have any GDAL compatible image format (http://www.gdal.org/
 
  
 
-# Install
+Installation
+------------
+
+AROSICS depends on the package "py_tools_ds". First install py_tools_ds following the setup instructions there:
 
-For now, there is no automatic install script. Just clone the repository, install the dependencies and add the root directory of CoReg_Sat to your PATH environment variable.
+    https://gitext.gfz-potsdam.de/danschef/py_tools_ds
     
-CoReg_Sat has been tested with Python 3.5 and Python 2.7. It should be fully compatible to all Python versions above 2.7.
+Since py_tools_ds is not a public repository right now, contact Daniel Scheffler if you can not access it.
 
-The following non-standard Python libraries are required:
 
-    - gdal, osr, ogr
-    - geopandas
-    - pykrige
-    - argparse
-    - shapely
-    - pyfftw is optional but will speed up calculation
-    - folium and geojson for some visualization functions
+* Then the pip-Installer:
 
-In addition clone the repository "py_tools_ds" and add its root directory to your PATH environment variable:
     
-    https://gitext.gfz-potsdam.de/danschef/py_tools_ds
+    pip install git+https://gitext.gfz-potsdam.de/danschef/arosics.git   # for HTTPS authentification   
+    pip install git+git@gitext.gfz-potsdam.de:danschef/arosics.git   # for SSH-Key authentification
+
+
+* Or clone the repository via GIT and update the PATH environment variable:
+
+    
+    cd /your/installation/folder
+    git clone https://gitext.gfz-potsdam.de/danschef/arosics.git
+    PATH=$PATH:~/path/to/your/installation/folder/arosics
+
+
+
+AROSICS has been tested with Python 3.x and Python 2.7. It should be fully compatible to all Python versions above 2.7.
+    
 
-Since py_tools_ds is not a public repository right now, contact Daniel Scheffler if you can not access it.
 
  
 
@@ -1472,3 +1489,11 @@ CRL.quality_grid.to_PointShapefile(path_out='/path/to/your/output_shapefile.shp'
 ### Shell console interface
 
 By far, there is no shell console interface for this module.
+
+
+
+# Credits
+
+This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the 
+[audreyr/cookiecutter-pypackage](https://github.com/audreyr/cookiecutter-pypackage) project template.
+

setup.py

@@ -38,7 +38,7 @@ setup(
     zip_safe=False,
     keywords='arosics',
     classifiers=[
-        'Development Status :: 2 - Pre-Alpha',
+        'Development Status :: 4 - Beta',
         'Intended Audience :: Developers',
         'License :: OSI Approved :: Apache Software License',
         'Natural Language :: English',
@@ -49,6 +49,7 @@ setup(
         'Programming Language :: Python :: 3.3',
         'Programming Language :: Python :: 3.4',
         'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
     ],
     test_suite='tests',
     tests_require=test_requirements,