Commit 22bfef36 authored by Yann Vote's avatar Yann Vote
Browse files

Improve documentation

No related merge requests found
Showing with 409 additions and 291 deletions
+409 -291
Yet one More Raster library Yet one More Raster library
=========================== ===========================
The ``ymraster`` package contains tools for manipulating raster images. The ``ymraster`` package contains tools for:
* manipulating raster images,
* perform classifications on these images.
For example, you can simply create a ``Raster`` instance and compute the NDVI For example, you can simply create a ``Raster`` instance and compute the NDVI
with the following two commands. with the following simple commands.
>>> from ymraster import Raster
>>> raster = Raster('data/l8_20130425.tif') >>> raster = Raster('data/l8_20130425.tif')
>>> ndvi = raster.ndvi('l8_20130425_ndvi.tif', idx_red=4, idx_nir=5) >>> ndvi = raster.ndvi('l8_20130425_ndvi.tif', idx_red=4, idx_nir=5)
...@@ -22,6 +26,7 @@ You need to have the following tools installed and properly set up: ...@@ -22,6 +26,7 @@ You need to have the following tools installed and properly set up:
raster computations, raster computations,
* `GDAL <http://gdal.org/>`_ for reading and writing rasters, * `GDAL <http://gdal.org/>`_ for reading and writing rasters,
* `NumPy <http://www.numpy.org/>`_ for matrix & numeric computations, * `NumPy <http://www.numpy.org/>`_ for matrix & numeric computations,
* `scikit-learn <http://scikit-learn.org/>`_ for classifications.
Surely, there are already binary packages for these tools for your Linux Surely, there are already binary packages for these tools for your Linux
distribution. distribution.
...@@ -37,18 +42,16 @@ environment:: ...@@ -37,18 +42,16 @@ environment::
Installation Installation
```````````` ````````````
Simple clone the repository in a folder of your choice:: Simply clone the repository in a folder of your choice::
$ cd </path/to/folder> # eg. ~/.local/opt $ cd </path/to/folder> # eg. ~/.local/opt
$ git clone https://github.com/ygversil/ymraster.git $ git clone https://github.com/ygversil/ymraster.git
Then create a .pth file in your ``site-packages`` folder with the path to the Then install this into your environment.::
folder.::
$ cd /.local/lib/python2.7/site-pakcages # create directory if it does not exists $ cd ymraster
$ echo "/home/<user>/local/opt/ymraster" > ymraster.pth $ pip install -e [--user] ./
Now you can import ``ymraster`` in Python. Now you can import ``ymraster`` in Python.
>>> import ymraster >>> import ymraster
>>>
...@@ -13,8 +13,8 @@ ...@@ -13,8 +13,8 @@
.. include:: ../README.rst .. include:: ../README.rst
The ``Raster`` class The ``ymraster`` module
==================== =======================
.. automodule:: ymraster.ymraster .. automodule:: ymraster.ymraster
:members: :members:
......
This diff is collapsed.
Supports Markdown
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