Merge pull request #48 from developmentseed/v0.5

Version 0.5 release

Author: Scisco

Diff for: .coveragerc

@@ -0,0 +1,2 @@
+[report]
+omit = *third_party*

Diff for: .gitignore

@@ -12,6 +12,12 @@ MANIFEST
 .coverage
 *flymake.py
 .settings
+.vagrant
+.pypirc
 metadata.csv
 txt.txt
+eva.py
+test.sh
+_build
+htmlcov
 

Diff for: .travis.yml

@@ -0,0 +1,34 @@
+language: python
+
+branches:
+  only:
+    - /^v0\.5.*$/
+
+python:
+  - '2.7'
+
+# Setup anaconda
+before_install:
+  - sudo add-apt-repository -y ppa:ubuntugis/ppa
+  - sudo apt-get update -qq
+  - sudo apt-get install libgdal1h gdal-bin libgdal-dev libcurl4-gnutls-dev
+  - wget http://repo.continuum.io/miniconda/Miniconda-latest-Linux-x86_64.sh -O miniconda.sh
+  - chmod +x miniconda.sh
+  - ./miniconda.sh -b
+  - export PATH=/home/travis/miniconda/bin:$PATH
+  - conda update --yes conda
+  # The next couple lines fix a crash with multiprocessing on Travis and are not specific to using Miniconda
+  - sudo rm -rf /dev/shm
+  - sudo ln -s /run/shm /dev/shm
+
+# Install packages
+install:
+  - conda install --yes python=$TRAVIS_PYTHON_VERSION numpy scipy matplotlib gdal scikit-image requests six nose dateutil
+  - pip install --install-option="--no-cython-compile" cython
+  - pip install -r requirements/travis.txt
+
+script:
+  - nosetests
+
+after_success:
+  - coveralls

Diff for: AUTHORS.txt

@@ -0,0 +1,11 @@
+Authors
+=======
+
+Scisco https://github.com/scisco
+Marc Farra https://github.com/kamicut
+Drew Bollinger https://github.com/drewbo
+Alex Kappel https://twitter.com/alex_kappel
+Eric Miller https://github.com/millerEric
+Yuriy Czoli https://github.com/YKCzoli
+
+See also https://github.com/developmentseed/landsat-util/graphs/contributors.

Diff for: Formula/landsat-util.rb

@@ -1,6 +1,10 @@
-include README.md
-include .gitignore
+include AUTHORS.txt
 include LICENSE
-recursive-include landsat/assests *.prj *.sbn *.sbx
-recursive-include landsat/assests *.shp *.xml *.shx *.html *.txt *.dbf
-recursive-include doc *.html
+include README.md
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat
+recursive-include landsat/tests/samples *.tar.bz2

Diff for: MANIFEST.in

@@ -0,0 +1,75 @@
+.PHONY: clean-pyc clean-build docs clean
+
+help:
+	@echo "clean - remove all build, test, coverage and Python artifacts"
+	@echo "clean-build - remove build artifacts"
+	@echo "clean-pyc - remove Python file artifacts"
+	@echo "clean-test - remove test and coverage artifacts"
+	@echo "lint - check style with flake8"
+	@echo "test - run tests quickly with the default Python"
+	@echo "test-all - run tests on every Python version with tox"
+	@echo "coverage - check code coverage quickly with the default Python"
+	@echo "docs - generate Sphinx HTML documentation, including API docs"
+	@echo "release - package and upload a release"
+	@echo "dist - package"
+	@echo "install - install the package to the active Python's site-packages"
+
+clean: clean-build clean-pyc clean-test
+
+clean-build:
+	rm -fr build/
+	rm -fr dist/
+	rm -fr .eggs/
+	find . -name '*.egg-info' -exec rm -fr {} +
+	find . -name '*.egg' -exec rm -f {} +
+
+clean-pyc:
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+clean-test:
+	rm -fr .tox/
+	rm -f .coverage
+	rm -fr htmlcov/
+
+test:
+	nosetests
+
+test-all:
+	tox
+
+coverage:
+	coverage run --source landsat setup.py test
+	coverage report -m
+	coverage html
+	open htmlcov/index.html
+
+docs:
+	rm -f docs/landsat.rst
+	rm -f docs/modules.rst
+	sphinx-apidoc -o docs/ landsat
+	$(MAKE) -C docs clean
+	$(MAKE) -C docs html
+	open docs/_build/html/index.html
+
+test-release: clean
+	python setup.py sdist upload -r pypitest
+	python setup.py bdist_wheel upload -r pypitest
+
+vagrant:
+	vagrant up
+	vagrant destroy
+
+release: clean
+	python setup.py sdist upload
+	python setup.py bdist_wheel upload
+
+dist: clean
+	python setup.py sdist
+	python setup.py bdist_wheel
+	ls -l dist
+
+install: clean
+	python setup.py install

Diff for: Makefile

@@ -1,11 +1,14 @@
 Landsat-util
 ===============
 
+.. image:: https://travis-ci.org/developmentseed/landsat-util.svg?branch=v0.5
+    :target: https://travis-ci.org/developmentseed/landsat-util
+
 Landsat-util is a command line utility that makes it easy to search, download, and process Landsat imagery.
 
 This tool uses Development Seed's `API for Landsat Metadata <https://github.com/developmentseed/landsat-api>`_.
 
-This API is accessible here: http://api.developmentseed.com:8000/landsat
+This API is accessible here: https://api.developmentseed.org/landsat
 
 You can also run your own API and connect it to this tool.
 
@@ -14,48 +17,38 @@ Installation
 
 **On Mac**
 
-Use brew to install landsat-util:
-
 .. code-block:: console
 
-  $: brew install https://raw.githubusercontent.com/developmentseed/landsat-util/master/Formula/landsat-util.rb
+  $: pip install landsat-util
 
-For the dev version try:
-
-.. code-block:: console
+**On Ubuntu 14.04**
 
-  $: brew install https://raw.githubusercontent.com/developmentseed/landsat-util/master/Formula/landsat-util.rb --HEAD
-
-**On Ubuntu**
-
-Use pip to install landsat-util:
+Use pip to install landsat-util. If you are not using virtualenv, you might have to run ``pip`` as ``sudo``.
 
 .. code-block:: console
 
-    $: sudo apt-add-repository ppa:ubuntugis/ubuntugis-unstable
     $: sudo apt-get update
-    $: sudo apt-get install git python-pip build-essential libssl-dev libffi-dev python-dev python-gdal libgdal1-dev gdal-bin imagemagick geotiff-bin -y
-    $: sudo pip install -U git+git://github.com/developmentseed/landsat-util.git
+    $: sudo apt-get install python-pip python-numpy python-scipy libgdal-dev libatlas-base-dev gfortran
+    $: pip install landsat-util
 
 **On Other systems**
 
-Make sure you have these dependencies:
+.. code-block:: console
+
+    $: python setup.py install
 
-- GDAL
-- ImageMagick
-- Orfeo-40
 
-Then Run:
+**To Upgrade**
 
 .. code-block:: console
 
-    $: pip install -U git+git://github.com/developmentseed/landsat-util.git
+    $: pip install -U landsat-util
 
-Alternatively, you can also download the package and run:
+If you have installed previous version of landsat using brew, first run:
 
 .. code-block:: console
 
-    $: python setup.py install
+    $: brew uninstall landsat-util
 
 Overview: What can landsat-util do?
 ============
@@ -65,7 +58,7 @@ Landsat-util has three main functions:
 - **Download** landsat images.
 - **Image processing** and pan sharpening on landsat images.
 
-These three functions can be performed separately or all at once.
+These three functions have to be performed separately.
 
 **Help**: Type ``landsat -h`` for detailed usage parameters.
 
@@ -77,8 +70,7 @@ Search returns information about all landsat tiles that match your criteria.  Th
 Search for landsat tiles in a given geographical region, using any of the following:
 
 - **Paths and rows**: If you know the paths and rows you want to search for.
-- **Country name**: If you know what country you want imagery for.
-- **Custom shapefile**: Use a tool such as http://geojson.io/ to generate custom shapefiles bounding your geographical region of interest.  Landsat-util will download tiles within this shapefile.
+- **Latidue and Longitude**: If you need the latitude and longitude of the point you want to search for.
 
 Additionally filter your search using the following parameters:
 
@@ -89,69 +81,81 @@ Additionally filter your search using the following parameters:
 
 Search by path and row:
 
-``$: landsat search --cloud 4 --start "january 1 2014" --end "january 10 2014" pr 009 045``
+``$: landsat search --cloud 4 --start "january 1 2014" --end "january 10 2014" -p 009,045``
 
-Search by country (The full list of countries is http://goo.gl/8H9wuq):
+Search by latitude and longitude:
 
-``$: landsat search --cloud 4 --start "january 1 2014" --end "August 25 2014" country 'Isle of Man'``
+``$: landsat search --lat 38.9004204 --lon -77.0237117``
 
-Search by custom shapefile:
-
-``$: landsat search --cloud 6 --start "july 01 2014" --end "august 1 2014" shapefile path/to/shapefile.shp``
 
 Step 2: Download
 ============
 
 You can download tiles using their unique sceneID, which you get from landsat search.
 
+Landsat-util will download a zip file that includes all the bands. You have the option of specifying the bands you want to down. In this case, landsat-util only downloads those bands if they are available online.
+
 **Examples of download**:
 
 Download images by their custom sceneID, which you get from landsat search:
 
 ``$: landsat download LC80090452014008LGN00``
 
-Search and download tiles all at once with the --download flag:
+Download only band 4, 3 and 2 for a particular sceneID:
+
+``$: landsat download LC80090452014008LGN00 --bands 432``
 
-``$: landsat search --download --cloud 4 --start "january 01 2014" --end "january 10 2014" pr 009 045``
+Download multiple sceneIDs:
+
+``$: landsat download LC80090452014008LGN00 LC80090452015008LGN00 LC80090452013008LGN00``
 
 Step 3: Image processing
 ============
 
-You can process your downloaded tiles with our custom image processing algorithms.  In addition, you can choose to pansharpen your images.
+You can process your downloaded tiles with our custom image processing algorithms.  In addition, you can choose to pansharpen your images and specify which bands to process.
 
 **Examples of image processing**:
 
-Process images that are already downloaded. Remember, the program only accepts zip files:
+Process images that are already downloaded. Remember, the program accepts both zip files and unzipped folders:
 
 ``$: landsat process path/to/LC80090452014008LGN00.tar.bz``
 
-Process *and* pansharpen a downloaded image:
+If unzipped:
 
-``$: landsat process --pansharpen path/to/LC80090452014008LGN00.tar.bz``
+``$: landsat process path/to/LC80090452014008LGN00``
 
-Search, download, and process images all at once using the --imageprocess flag:
+Specify bands 3, 5 and 1:
 
-``$: landsat search --imageprocess --cloud 6 --start "january 01 2014" --end "january 10 2014" shapefile path/to/shapefile.shp``
+``$: landsat process path/to/LC80090452014008LGN00  --bands 351``
+
+Process *and* pansharpen a downloaded image:
+
+``$: landsat process path/to/LC80090452014008LGN00.tar.bz --pansharpen``
 
 
 Important Notes
 ===============
 
 - All downloaded and processed images are stored at your home directory in landsat forlder: ``~/landsat``
 
-- If you are not sure what images you are looking for, make sure to use ``--onlysearch`` flag to view the results first. The image thumbnail web address that is included in the results can be used to make sure that clouds are not obscuring the subject of interest. Run the search again if you need to narrow down your result and then start downloading images. Each image is usually more than 700mb and it might takes a very long time if there are too many images to download
+- The image thumbnail web address that is included in the results can be used to make sure that clouds are not obscuring the subject of interest. Run the search again if you need to narrow down your result and then start downloading images. Each image is usually more than 700mb and it might takes a very long time if there are too many images to download
 
-- Image processing is a very heavy and resource consuming task. Each process takes about 20-30 mins. We recommend that you run the processes in smaller badges. Pansharpening, while increasing image resolution 2x, substantially increases processing time.
+- Image processing is a very heavy and resource consuming task. Each process takes about 5-10 mins. We recommend that you run the processes in smaller badges. Pansharpening, while increasing image resolution 2x, substantially increases processing time.
 
-- Country based search queries can return a large number of images; for countries that return large search results we recommend selecting best imagery based on thumbnails and then using the download tool to install specific imagery based on Landsat scene ID.
+- Landsat-util requires at least 2GB of Memory (RAM).
 
-To Do List
+Recently Added
 ++++++++++
 
 - Add longitude latitude search
-- Add Sphinx Documentation
 - Improve console output
 - Add more color options such as false color, true color, etc.
+
+
+To Do List
+++++++++++
+
+- Add Sphinx Documentation
 - Add capacity for NDVI output
 - Add alternative projections (currently only option is default web-mercator; EPSG: 3857)
 - Connect search to Google Address API