README.rst 2.6 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/build.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
See also the latest coverage_ report and the nosetests_ HTML report.
37
38
39
40
41
42
43


Features
--------

* TODO

Daniel Scheffler's avatar
Daniel Scheffler committed
44
45
46
47

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

Daniel Scheffler's avatar
Daniel Scheffler committed
48
49
50
51
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
52

Daniel Scheffler's avatar
Daniel Scheffler committed
53
 .. code-block:: console
Daniel Scheffler's avatar
Daniel Scheffler committed
54

Daniel Scheffler's avatar
Daniel Scheffler committed
55
56
57
    # 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
58
    conda install -y -q -c conda-forge numpy gdal scikit-image pyproj rasterio shapely pandas
Daniel Scheffler's avatar
Daniel Scheffler committed
59

Daniel Scheffler's avatar
Daniel Scheffler committed
60
* To install py_tools_ds, use the pip installer:
Daniel Scheffler's avatar
Daniel Scheffler committed
61

Daniel Scheffler's avatar
Daniel Scheffler committed
62
 .. code-block:: console
Daniel Scheffler's avatar
Daniel Scheffler committed
63

Daniel Scheffler's avatar
Daniel Scheffler committed
64
    pip install py_tools_ds
Daniel Scheffler's avatar
Daniel Scheffler committed
65
66


67
Credits
Daniel Scheffler's avatar
Daniel Scheffler committed
68
-------
69
70
71
72
73

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
74
.. _coverage: http://danschef.gitext.gfz-potsdam.de/py_tools_ds/coverage/
Daniel Scheffler's avatar
Daniel Scheffler committed
75
.. _nosetests: http://danschef.gitext.gfz-potsdam.de/py_tools_ds/nosetests_reports/nosetests.html
Daniel Scheffler's avatar
Daniel Scheffler committed
76
.. _conda: https://conda.io/docs/