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

Daniel Scheffler's avatar
Daniel Scheffler committed
5 6 7
A collection of Python tools by Daniel Scheffler.


Daniel Scheffler's avatar
Daniel Scheffler committed
8
* Free software: GNU General Public License v3
Daniel Scheffler's avatar
Daniel Scheffler committed
9 10
* Documentation: http://danschef.gitext.gfz-potsdam.de/py_tools_ds/doc/

11

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

.. .. image:: https://img.shields.io/travis/danschef/py_tools_ds.svg
16
        :target: https://travis-ci.org/danschef/py_tools_ds
17

Daniel Scheffler's avatar
Daniel Scheffler committed
18
.. .. image:: https://readthedocs.org/projects/py-tools-ds/badge/?version=latest
19
        :target: https://py-tools-ds.readthedocs.io/en/latest/?badge=latest
20 21
        :alt: Documentation Status

Daniel Scheffler's avatar
Daniel Scheffler committed
22
.. .. image:: https://pyup.io/repos/github/danschef/py_tools_ds/shield.svg
23
     :target: https://pyup.io/repos/github/danschef/py_tools_ds/
24 25
     :alt: Updates

Daniel Scheffler's avatar
Daniel Scheffler committed
26
.. image:: https://gitext.gfz-potsdam.de/danschef/py_tools_ds/badges/master/pipeline.svg
27
        :target: https://gitext.gfz-potsdam.de/danschef/py_tools_ds/commits/master
Daniel Scheffler's avatar
Daniel Scheffler committed
28
.. image:: https://gitext.gfz-potsdam.de/danschef/py_tools_ds/badges/master/coverage.svg
29 30 31
        :target: http://danschef.gitext.gfz-potsdam.de/py_tools_ds/coverage/
.. image:: https://img.shields.io/pypi/v/py_tools_ds.svg
        :target: https://pypi.python.org/pypi/py_tools_ds
32 33 34
.. image:: https://anaconda.org/danschef/py_tools_ds/badges/version.svg
        :target: https://anaconda.org/danschef/py_tools_ds
        :alt: Anaconda-Cloud
35 36 37
.. 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
38 39
.. image:: https://img.shields.io/pypi/dm/py_tools_ds.svg
        :target: https://pypi.python.org/pypi/py_tools_ds
40

41
See also the latest coverage_ report and the nosetests_ HTML report.
42 43 44 45 46 47 48


Features
--------

* TODO

Daniel Scheffler's avatar
Daniel Scheffler committed
49 50 51 52

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

Daniel Scheffler's avatar
Daniel Scheffler committed
53 54 55 56
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
57

58 59
*via conda + pip*

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

Daniel Scheffler's avatar
Daniel Scheffler committed
62 63 64
    # 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
65
    conda install -c conda-forge numpy gdal pyproj shapely scikit-image pandas
Daniel Scheffler's avatar
Daniel Scheffler committed
66

67
 Then install py_tools_ds using the pip installer:
Daniel Scheffler's avatar
Daniel Scheffler committed
68

Daniel Scheffler's avatar
Daniel Scheffler committed
69
 .. code-block:: console
Daniel Scheffler's avatar
Daniel Scheffler committed
70

Daniel Scheffler's avatar
Daniel Scheffler committed
71
    pip install py_tools_ds
Daniel Scheffler's avatar
Daniel Scheffler committed
72

Daniel Scheffler's avatar
Daniel Scheffler committed
73
*via conda channel (currently only for Linux-64)*
74 75 76 77 78 79 80 81 82

 .. 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 -c danschef -c conda-forge -c defaults py_tools_ds


Daniel Scheffler's avatar
Daniel Scheffler committed
83

84
Credits
Daniel Scheffler's avatar
Daniel Scheffler committed
85
-------
86

87 88 89
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).

90 91 92 93
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
Daniel Scheffler's avatar
Daniel Scheffler committed
94
.. _coverage: http://danschef.gitext.gfz-potsdam.de/py_tools_ds/coverage/
Daniel Scheffler's avatar
Daniel Scheffler committed
95
.. _nosetests: http://danschef.gitext.gfz-potsdam.de/py_tools_ds/nosetests_reports/nosetests.html
Daniel Scheffler's avatar
Daniel Scheffler committed
96
.. _conda: https://conda.io/docs/