Commit 2a0cdcdc authored by Daniel Scheffler's avatar Daniel Scheffler Committed by Daniel Scheffler
Browse files

Updated README.rst.

parent dd0354f3
Pipeline #1075 passed with stages
in 55 seconds
......@@ -41,22 +41,26 @@ Features
Installation
------------
* Use the pip-Installer:
pip install git+https://gitext.gfz-potsdam.de/danschef/py_tools_ds.git # for HTTPS authentification
py_tools_ds depends on some open source packages which are usually installed without problems by the automatic install
routine. However, for some projects, we strongly recommend resolving the dependency before the automatic installer
is run. This approach avoids problems with conflicting versions of the same software.
Using conda_, the recommended approach is:
pip install git+git@gitext.gfz-potsdam.de:danschef/py_tools_ds.git # for SSH-Key authentification
.. code-block:: console
# create virtual environment for py_tools_ds, this is optional
conda create -y -q --name py_tools_ds python=3
source activate py_tools_ds
conda install -y -q -c conda-forge numpy gdal scikit-image pyproj rasterio shapely
* Or clone the repository via GIT and update the PATH environment variable:
* To install py_tools_ds, use the pip installer:
cd /your/installation/folder
git clone https://danschef@gitext.gfz-potsdam.de/danschef/py_tools_ds.git
PATH=$PATH:~/path/to/your/installation/folder/py_tools_ds
.. code-block:: console
pip install py_tools_ds
Before running py_tools_ds, make sure your GDAL_DATA environment variable is set!
Credits
-------
......@@ -66,4 +70,4 @@ This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypack
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
.. _coverage: http://danschef.gitext.gfz-potsdam.de/py_tools_ds/coverage/
.. _conda: https://conda.io/docs/
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