Commit 80c319ae authored by Daniel Scheffler's avatar Daniel Scheffler
Browse files

Updated installation procedure documentation.


Signed-off-by: Daniel Scheffler's avatarDaniel Scheffler <danschef@gfz-potsdam.de>
parent e8b8245d
.. highlight:: shell
.. _installation:
============
Installation
============
Stable release
--------------
Using Anaconda or Miniconda (recommended)
-----------------------------------------
To install py_tools_ds, run this command in your terminal:
Using conda_ (latest version recommended), py_tools_ds is installed as follows:
.. code-block:: console
$ pip install py_tools_ds
1. Create virtual environment for py_tools_ds (optional but recommended):
This is the preferred method to install py_tools_ds, as it will always install the most recent stable release.
.. code-block:: bash
If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.
$ conda create -c conda-forge --name py_tools_ds python=3
$ conda activate py_tools_ds
.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
2. Then install py_tools_ds itself:
From sources
------------
.. code-block:: bash
The sources for py_tools_ds can be downloaded from the `Github repo`_.
$ conda install -c conda-forge py-tools-ds
You can either clone the public repository:
.. code-block:: console
This is the preferred method to install py_tools_ds, as it always installs the most recent stable release and
automatically resolves all the dependencies.
$ git clone git://github.com/danschef/py_tools_ds
Or download the `tarball`_:
Using pip (not recommended)
---------------------------
.. code-block:: console
There is also a `pip`_ installer for py_tools_ds. However, please note that py_tools_ds depends on some
open source packages that may cause problems when installed with pip. Therefore, we strongly recommend
to resolve the following dependencies before the pip installer is run:
$ curl -OL https://gitext.gfz-potsdam.de/danschef/py_tools_ds/repository/archive.tar.gz?ref=master
Once you have a copy of the source, you can install it with:
* gdal
* geopandas
* numpy
* pyproj >=2.1.0
* scikit-image
* shapely
.. code-block:: console
$ python setup.py install
Then, the pip installer can be run by:
.. code-block:: bash
.. _Github repo: https://gitext.gfz-potsdam.de/danschef/py_tools_ds
.. _tarball: https://gitext.gfz-potsdam.de/danschef/py_tools_ds/repository/archive.tar.gz?ref=master
$ pip install py_tools_ds
If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.
.. note::
py_tools_ds has been tested with Python 3.6+.,
i.e., should be fully compatible to all Python versions from 3.6 onwards.
.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/
.. _conda: https://conda.io/docs
......@@ -11,6 +11,7 @@ dependencies:
- numpy
- pyproj>=2.2.0
- scikit-image
- shapely
- pip:
- six
......
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