README.rst 3.02 KB
Newer Older
1
2
3
4
===========
py_tools_ds
===========

5
6
A collection of geospatial data analysis tools that simplify standard operations when handling geospatial raster
and vector data as well as projections.
Daniel Scheffler's avatar
Daniel Scheffler committed
7
8


9
* Free software: GNU General Public License v3 or later (GPLv3+)
10
* Documentation: https://danschef.git-pages.gfz-potsdam.de/py_tools_ds/doc/
Daniel Scheffler's avatar
Daniel Scheffler committed
11

12

Daniel Scheffler's avatar
Daniel Scheffler committed
13
14
15
Status
------

16
17
18
19
.. image:: https://git.gfz-potsdam.de/danschef/py_tools_ds/badges/master/pipeline.svg
        :target: https://git.gfz-potsdam.de/danschef/py_tools_ds/commits/master
.. image:: https://git.gfz-potsdam.de/danschef/py_tools_ds/badges/master/coverage.svg
        :target: https://danschef.git-pages.gfz-potsdam.de/py_tools_ds/coverage/
20
21
.. image:: https://img.shields.io/pypi/v/py_tools_ds.svg
        :target: https://pypi.python.org/pypi/py_tools_ds
22
23
24
.. image:: https://anaconda.org/danschef/py_tools_ds/badges/version.svg
        :target: https://anaconda.org/danschef/py_tools_ds
        :alt: Anaconda-Cloud
25
26
27
.. image:: https://img.shields.io/conda/pn/danschef/py_tools_ds.svg
        :target: https://anaconda.org/danschef/py_tools_ds
        :alt: conda platform
Daniel Scheffler's avatar
Daniel Scheffler committed
28
29
.. image:: https://img.shields.io/pypi/dm/py_tools_ds.svg
        :target: https://pypi.python.org/pypi/py_tools_ds
30

31
See also the latest coverage_ report and the nosetests_ HTML report.
32
33
34
35
36
37
38


Features
--------

* TODO

Daniel Scheffler's avatar
Daniel Scheffler committed
39
40
41
42

Installation
------------

Daniel Scheffler's avatar
Daniel Scheffler committed
43
44
45
46
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:
Daniel Scheffler's avatar
Daniel Scheffler committed
47

48
49
*via conda + pip*

Daniel Scheffler's avatar
Daniel Scheffler committed
50
 .. code-block:: console
Daniel Scheffler's avatar
Daniel Scheffler committed
51

Daniel Scheffler's avatar
Daniel Scheffler committed
52
    # create virtual environment for py_tools_ds, this is optional
53
    conda create -y -q -c conda-forge --name py_tools_ds python=3
54
    conda activate py_tools_ds
55
    conda install -c conda-forge numpy gdal 'pyproj>=2.1.0' shapely scikit-image pandas
Daniel Scheffler's avatar
Daniel Scheffler committed
56

57
 Then install py_tools_ds using the pip installer:
Daniel Scheffler's avatar
Daniel Scheffler committed
58

Daniel Scheffler's avatar
Daniel Scheffler committed
59
 .. code-block:: console
Daniel Scheffler's avatar
Daniel Scheffler committed
60

Daniel Scheffler's avatar
Daniel Scheffler committed
61
    pip install py_tools_ds
Daniel Scheffler's avatar
Daniel Scheffler committed
62

Daniel Scheffler's avatar
Daniel Scheffler committed
63
*via conda channel (currently only for Linux-64)*
64
65
66
67
68

 .. code-block:: console

    # create virtual environment for py_tools_ds, this is optional
    conda create -y -q --name py_tools_ds python=3
69
    conda activate py_tools_ds
70
71
72
    conda install -c danschef -c conda-forge -c defaults py_tools_ds


Daniel Scheffler's avatar
Daniel Scheffler committed
73

74
Credits
Daniel Scheffler's avatar
Daniel Scheffler committed
75
-------
76

77
78
79
The py_tools_ds package was developed within the context of the GeoMultiSens project funded
by the German Federal Ministry of Education and Research (project grant code: 01 IS 14 010 A-C).

80
81
82
83
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
84
85
.. _coverage: https://danschef.git-pages.gfz-potsdam.de/py_tools_ds/coverage/
.. _nosetests: https://danschef.git-pages.gfz-potsdam.de/py_tools_ds/nosetests_reports/nosetests.html
Daniel Scheffler's avatar
Daniel Scheffler committed
86
.. _conda: https://conda.io/docs/