Metadata-Version: 1.2
Name: modape
Version: 0.1.3
Summary: MODIS Assimilation and Processing Engine
Home-page: http://wfp-vam.github.io/modape
Author: Valentin Pesendorfer
Author-email: valentin.pesendorfer@wfp.org
License: UNKNOWN
Description-Content-Type: UNKNOWN
Description: MODAPE
        =====
        
        |CI| |version| |pyversions| |downloads| |license|
        
        .. |CI| image:: https://travis-ci.org/WFP-VAM/modape.svg?branch=master
                     :target: https://travis-ci.org/WFP-VAM/modape
        
        .. |version| image:: https://img.shields.io/pypi/v/modape.svg
                          :target: https://pypi.org/project/modape/
        
        .. |pyversions| image:: https://img.shields.io/pypi/pyversions/modape.svg
                             :target: https://pypi.org/project/modape/
        
        .. |downloads| image:: https://img.shields.io/pypi/dm/modape.svg
                            :target: https://pypi.org/project/modape/
        
        .. |license| image:: https://img.shields.io/github/license/WFP-VAM/modape.svg
                          :target: https://github.com/WFP-VAM/modape/blob/master/LICENSE
        |
        
        The **M**\ ODIS **A**\ ssimilation and **P**\ rocessing **E**\ ngine combines a state-of-the art whittaker smoother, implemented as fast C-extension through Cython and including a V-curve optimization of the smoothing parameter, with a HDF5 based processing chain optimized for MODIS data.
        
        The sub-module ``modape.whittaker`` includes the following variations of the whittaker smoother with 2nd order differences:
        
        - **ws2d**: Whittaker with fixed smoothing parameter (``s``)
        - **ws2doptv**: Whittaker with V-curve optimization of the smoothing parameter (``s``)
        - **ws2doptvp**: Whittaker with V-curve optimization of the smoothing parameter (``s``) and expectile smoothing using asymmetric weights
        
        The MODIS processing chain consists of the following executables, which can be called through commandline:
        
        - ``modis_download``: Query and download raw MODIS products (requires Earthdata credentials)
        - ``modis_collect``: Collect raw MODIS data into daily datacubes stored in an HDF5 file
        - ``modis_smooth``: Smooth, gapfill and interpolate raw MODIS data using the implemented whittaker smoother
        - ``modis_window``: Extract mosaic(s) of multiple MODIS tiles, or subset(s) of a global/tiled MODIS product and export it as GeoTIFF raster in WGS1984 coordinate system
        
        Additional executables:
        
        - ``csv_smooth``: Smooth timeseries stored within a CSV file
        - ``rts_smooth``: Smooth a series of raster files stored in a local directory
        - ``modis_info``: Retrieve metadata from created HDF5 files
        - ``modis_product_table``: MODIS Version 6.0 product table
        
        
        Installation
        ------------
        **Dependencies:**
        
        modape depends on these packages:
        
        - numpy
        - gdal
        - h5py
        - beautifulsoup4
        - requests
        - progress
        - pandas
        
        Some of these packages (eg. GDAL) can be difficult to build, especially on windows machines. In the latter case it's advisable to download an unofficial binary wheel from `Christoph Gohlke's Unofficial Windows Binaries for Python Extension Packages <https://www.lfd.uci.edu/~gohlke/pythonlibs/>`_ and install it locally with ``pip install`` before installing modape.
        
        **Installation from github:**
        
        .. code:: bash
        
            $ git clone https://github.com/WFP-VAM/modape
            $ cd modape
            $ pip install .
        
        **Installation from PyPi:**
        
        .. code:: bash
        
            $ pip install modape
        
        
        Bugs, typos & feature requests
        -----
        
        If you find a bug, see a typo, have some kind of troubles running the module or just simply want to have a feature added, please `submit an issue! <https://github.com/WFP-VAM/modape/issues/new>`_
        
        
        Usage tutorial
        -----
        
        All executables can be called with a ``-h`` flag for detailed usage.
        
        For a more detailed tutorial on how to use the executables, please visit `WFP-VAM.github.io/modape <https://wfp-vam.github.io/modape/>`_.
        
        
        CHANGES
        -----
        - v0.1.1/2/3:
                - changes to MANIFEST.in
                - fix issues with pytest and dates in HDF5 for PYTHON 2.7
                - fix bug for updating smoothed datasets
        
        - v0.1.0:
                - initial release
        
        -----
        
        References:
        
        P. H. C. Eilers, V. Pesendorfer and R. Bonifacio, "Automatic smoothing of remote sensing data," 2017 9th International Workshop on the Analysis of Multitemporal Remote Sensing Images (MultiTemp), Brugge, 2017, pp. 1-3.
        doi: 10.1109/Multi-Temp.2017.8076705
        URL: http://ieeexplore.ieee.org/stamp/stamp.jsp?tp=&arnumber=8076705&isnumber=8035194
        
        Core Whittaker function adapted from ``whit2`` function from `R` package `ptw <https://cran.r-project.org/package=ptw>`_:
        
        Bloemberg, T. G. et al. (2010) "Improved Parametric Time Warping for Proteomics", Chemometrics and Intelligent Laboratory Systems, 104 (1), 65-74
        
        Wehrens, R. et al. (2015) "Fast parametric warping of peak lists", Bioinformatics, in press.
        
        -----
        
        Author & maintainer:
        
        Valentin Pesendorfer
        
        valentin.pesendorfer@wfp.org
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Requires-Python: >=2.7.11, <4
