Commit 3e50e463 authored by Greifeneder Felix's avatar Greifeneder Felix

completing the documentation

parent 894961ee
This diff is collapsed.
......@@ -3,15 +3,14 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to pysmm's documentation!
=================================
.. toctree::
:maxdepth: 2
:caption: Contents:
.. _welcome:
PYthon Sentinel-1 soil-Moisture Mapping (PYSMM)
========
===============================================
This package acts as an interface to Google Earth Engine for the estimation of surface soil moisture based
on Copernicus Sentinel-1 intensity data. It is meant as a supplement to the following publication: *Greifeneder, F.,
......@@ -24,56 +23,126 @@ needs to be downloaded.
Acknowledgements: This study was made possibly through funding within the Horizon 2020 project "Ecopotential: Improving
Future Ecosystem Benefits through Earth Observations"
.. image:: _static/logoEURAC.jpg
.. image:: _static/ecopo_small.png
.. _installation
Installation
------------
============
Most of the data processing is executed on-line on Google Earth Engine.
Therefore, the execution of this script requires a Google account and access to Google Earth Engine -
we are working on an updated version that will utilize a GEE Application Key rather than a personal account.</
we are working on an updated version that will utilize a GEE Application Key rather than a personal account.
**Installation of the Google Earth Engine API**
To allow the script to talk to Google Earh Engine the API has to be installed. Please follow the instructions at
this link `GEE API`
.. _GEE API: https://developers.google.com/earth-engine/python_install_manual
**Installation of the Google Drive API**
After the computation inside Google Earth Engine is finished, the results are exported to your Google Drive.
To let the script access and download the results to you local computer, the Google Drive API
has to be installed as well. Please follow the instructions here: `Google Drive API`
.. _Google Drive API: https://developers.google.com/drive/v3/web/quickstart/python
As described in the manual, for the first run, the authentication can be initiated by running the ``quickstart.py``
script. To enable the download of data please modify the following line of the script:
**SCOPES = 'https://www.googleapis.com/auth/drive.metadata.readonly' --> SCOPES = 'https://www.googleapis.com/auth/drive'**
Install PYSMM by running:
``pip install pysmm``
or
``python setup.py install``
Installation of the Google Earth Engine API
To allow the script to talk to Google Earh Engine the API has to be installed. Please follow the instructions at
this link `GEE API`
.. _API
.. _GEE API: https://developers.google.com/earth-engine/python_install_manual
API Documentation
=================
Installation of the Google Drive API
get_map()
---------
After the computation inside Google Earth Engine is finished, the results are exported to your Google Drive.
To let the script access and download the results to you local computer,
the Google Drive API has to be installed as well. Please follow the instructions here: `Google Drive API`
To produce a soil moisture map of any geographic extent use the following function::
.. _Google Drive API: https://developers.google.com/drive/v3/web/quickstart/python
from pysmm.derive_SM import get_map
get_map(*minlon*, *minlat*, *maxlon*, *maxlat*,
'path/to/outdir/',
samping=100, # specify desired output resolution
year=None, month=None, day=None, # define a date (optional)
tracknr=None, # define the Sentinel-1 track (optinal)
tempfilter=True,
mask='Globcover',
masksnow=True,
overwrite=True)
As described in the manual, for the first run, the authentication can be initiated by running the
``quickstart.py`` script. To enable the download of data please modify the following line of the script
**SCOPES = 'https://www.googleapis.com/auth/drive.metadata.readonly' --> SCOPES = 'https://www.googleapis.com/auth/drive'**
* in case *year*, *month*, and *day* are not specified, the entire time-series will be extracted
Install $project by running:
* if *tempfilter=True*, temporal speckle filtering is applied to reduce speckle noise
``python setup.py install``
* mask='...' specifies the land-cover classification that is used for masking the output. *Globcover*
provides global coverage. For Europe and North America, *Corine* and *USGS*, respectively, offer more precise
information.
* if *masksnow=True*, an automatically generated wet-snow mask is applied to the output
* *overwrite=True* allows to specify whether existing files should be overwritten or skipped.
* the output of ``get_map()`` is directly downloaded to *'path/to/outdir/'*
get_ts()
--------
To derive the soil moisture time-series of a single location use ``get_ts()``::
from pysmm.derive_SM import get_ts
sm_ts = ge_ts(*lon*, *lat*,
'/path/to/working_dir/',
footprint=50, # specify the footprint of the extracted time-series
mask_snow=True,
calc_anomalies=True,
create_plots=True)
* The output of *get_ts* is a pandas time-series
* if *masksnow=True*, an automatically generated wet-snow mask is applied to the output
* if *calc_anomalies=True*, anomalies are generated in addition to absolute soil moisture values.
For details about the anomaly computation, see: *Greifeneder F, E Khamala, D Sendabo, W Wagner, M Zebisch, H Farah,
C Notarnicola. Detection of soil moisture anomalies based on Sentinel-1. Physics and Chemistry of the Earth (submitted,
March 2018)*
* if *create_plots=True*, time-series plots are created and saved to *'path/to/working_dir'*
.. _contribute
Contribute
----------
==========
Issue Tracker: https://gitlab.inf.unibz.it/Felix.Greifeneder/pysmm/issues
|Issue Tracker: https://gitlab.inf.unibz.it/Felix.Greifeneder/$project/$project/issues
|Source Code: https://gitlab.inf.unibz.it/Felix.Greifeneder/$project
Source Code: https://gitlab.inf.unibz.it/Felix.Greifeneder/pysmm
Support
-------
.. _contact
Contact
=======
If you are having issues, please let us know.
Mail to: felix.greifeneder@eurac.edu
.. _license
License
-------
=======
The project is licensed under the GNU GENERAL PUBLIC LICENSE Version 3
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
This diff is collapsed.
Search.setIndex({docnames:["index"],envversion:52,filenames:["index.rst"],objects:{},objnames:{},objtypes:{},terms:{"export":0,"public":0,The:0,access:0,account:0,acknowledg:0,act:0,after:0,all:0,allow:0,api:0,applic:0,approach:0,auth:0,authent:0,base:0,benefit:0,can:0,code:0,com:0,comput:0,content:0,copernicu:0,data:0,describ:0,download:0,drive:0,earh:0,earth:0,ecopotenti:0,ecosystem:0,edu:0,enabl:0,engin:0,estim:0,eurac:0,execut:0,felix:0,finish:0,first:0,follow:0,from:0,fulli:0,fund:0,futur:0,gee:0,gener:0,gitlab:0,global:0,gnu:0,googl:0,googleapi:0,greifened:0,has:0,have:0,here:0,high:0,horizon:0,http:0,improv:0,index:0,inf:0,initi:0,input:0,insid:0,instruct:0,intens:0,interfac:0,intern:0,ismn:0,issu:0,kei:0,know:0,learn:0,let:0,line:0,link:0,local:0,machin:0,made:0,mail:0,manual:0,meant:0,metadata:0,model:0,modifi:0,modul:0,most:0,need:0,network:0,none:0,notarnicola:0,observ:0,onlin:0,packag:0,page:0,perform:0,person:0,pleas:0,possibl:0,process:0,project:0,quickstart:0,rather:0,readonli:0,regress:0,requir:0,resolut:0,result:0,run:0,scope:0,script:0,search:0,set:0,setup:0,situ:0,sourc:0,spatial:0,step:0,studi:0,supplement:0,surfac:0,talk:0,tempor:0,than:0,therefor:0,thi:0,through:0,tracker:0,train:0,under:0,unibz:0,updat:0,util:0,vector:0,version:0,wagner:0,well:0,within:0,work:0,www:0,you:0,your:0},titles:["Welcome to pysmm\u2019s documentation!"],titleterms:{contribut:0,document:0,indic:0,instal:0,licens:0,map:0,moistur:0,pysmm:0,python:0,sentinel:0,soil:0,support:0,tabl:0,welcom:0}})
\ No newline at end of file
Search.setIndex({docnames:["index"],envversion:52,filenames:["index.rst"],objects:{},objnames:{},objtypes:{},terms:{"case":0,"export":0,"function":0,"import":0,"public":0,"true":0,For:0,The:0,about:0,absolut:0,access:0,account:0,acknowledg:0,act:0,addit:0,after:0,all:0,allow:0,america:0,ani:0,anomali:0,api:[],appli:0,applic:0,approach:0,auth:0,authent:0,automat:0,base:0,benefit:0,calc_anomali:0,can:0,chemistri:0,classif:0,code:0,com:0,comput:0,content:0,copernicu:0,corin:0,cover:0,coverag:0,creat:0,create_plot:0,dai:0,data:0,date:0,defin:0,deriv:0,derive_sm:0,describ:0,desir:0,detail:0,detect:0,directli:0,download:0,drive:0,earh:0,earth:0,ecopotenti:0,ecosystem:0,edu:0,enabl:0,engin:0,entir:0,estim:0,eurac:0,europ:0,execut:0,exist:0,extent:0,extract:0,farah:0,felix:0,file:0,filter:0,finish:0,first:0,follow:0,footprint:0,from:0,fulli:0,fund:0,futur:0,ge_t:0,gee:0,gener:0,geograph:0,gitlab:0,global:0,globcov:0,gnu:0,googl:0,googleapi:0,greifened:0,has:0,have:0,here:0,high:0,horizon:0,http:0,improv:0,index:[],inf:0,inform:0,initi:0,input:0,insid:0,instruct:0,intens:0,interfac:0,intern:0,ismn:0,issu:0,kei:0,khamala:0,know:0,land:0,lat:0,learn:0,let:0,line:0,link:0,local:0,locat:0,lon:0,machin:0,made:0,mail:0,manual:0,march:0,mask:0,mask_snow:0,masksnow:0,maxlat:0,maxlon:0,meant:0,metadata:0,minlat:0,minlon:0,model:0,modifi:0,modul:[],month:0,more:0,most:0,need:0,network:0,nois:0,none:0,north:0,notarnicola:0,observ:0,offer:0,onlin:0,optin:0,option:0,outdir:0,output:0,overwrit:0,overwritten:0,packag:0,page:[],panda:0,path:0,perform:0,person:0,physic:0,pip:0,pleas:0,plot:0,possibl:0,precis:0,process:0,produc:0,project:0,provid:0,quickstart:0,rather:0,readonli:0,reduc:0,regress:0,requir:0,resolut:0,respect:0,result:0,run:0,samp:0,save:0,scope:0,script:0,search:[],see:0,sendabo:0,seri:0,set:0,setup:0,should:0,singl:0,situ:0,skip:0,sm_t:0,snow:0,sourc:0,spatial:0,specifi:0,speckl:0,step:0,studi:0,submit:0,supplement:0,support:0,surfac:0,talk:0,tempfilt:0,tempor:0,than:0,therefor:0,thi:0,through:0,time:0,track:0,tracker:0,tracknr:0,train:0,under:0,unibz:0,updat:0,use:0,used:0,usg:0,util:0,valu:0,vector:0,version:0,wagner:0,well:0,wet:0,whether:0,within:0,work:0,working_dir:0,www:0,year:0,you:0,your:0,zebisch:0},titles:["PYthon Sentinel-1 soil-Moisture Mapping (PYSMM)"],titleterms:{api:0,contact:0,contribut:0,document:0,get_map:0,get_t:0,indic:[],instal:0,licens:0,map:0,moistur:0,pysmm:0,python:0,sentinel:0,soil:0,support:[],tabl:[],welcom:[]}})
\ No newline at end of file
......@@ -3,15 +3,14 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to pysmm's documentation!
=================================
.. toctree::
:maxdepth: 2
:caption: Contents:
.. _welcome:
PYthon Sentinel-1 soil-Moisture Mapping (PYSMM)
========
===============================================
This package acts as an interface to Google Earth Engine for the estimation of surface soil moisture based
on Copernicus Sentinel-1 intensity data. It is meant as a supplement to the following publication: *Greifeneder, F.,
......@@ -24,56 +23,126 @@ needs to be downloaded.
Acknowledgements: This study was made possibly through funding within the Horizon 2020 project "Ecopotential: Improving
Future Ecosystem Benefits through Earth Observations"
.. image:: _static/logoEURAC.jpg
.. image:: _static/ecopo_small.png
.. _installation
Installation
------------
============
Most of the data processing is executed on-line on Google Earth Engine.
Therefore, the execution of this script requires a Google account and access to Google Earth Engine -
we are working on an updated version that will utilize a GEE Application Key rather than a personal account.</
we are working on an updated version that will utilize a GEE Application Key rather than a personal account.
**Installation of the Google Earth Engine API**
To allow the script to talk to Google Earh Engine the API has to be installed. Please follow the instructions at
this link `GEE API`
.. _GEE API: https://developers.google.com/earth-engine/python_install_manual
**Installation of the Google Drive API**
After the computation inside Google Earth Engine is finished, the results are exported to your Google Drive.
To let the script access and download the results to you local computer, the Google Drive API
has to be installed as well. Please follow the instructions here: `Google Drive API`
.. _Google Drive API: https://developers.google.com/drive/v3/web/quickstart/python
As described in the manual, for the first run, the authentication can be initiated by running the ``quickstart.py``
script. To enable the download of data please modify the following line of the script:
**SCOPES = 'https://www.googleapis.com/auth/drive.metadata.readonly' --> SCOPES = 'https://www.googleapis.com/auth/drive'**
Install PYSMM by running:
``pip install pysmm``
or
``python setup.py install``
Installation of the Google Earth Engine API
To allow the script to talk to Google Earh Engine the API has to be installed. Please follow the instructions at
this link `GEE API`
.. _API
.. _GEE API: https://developers.google.com/earth-engine/python_install_manual
API Documentation
=================
Installation of the Google Drive API
get_map()
---------
After the computation inside Google Earth Engine is finished, the results are exported to your Google Drive.
To let the script access and download the results to you local computer,
the Google Drive API has to be installed as well. Please follow the instructions here: `Google Drive API`
To produce a soil moisture map of any geographic extent use the following function::
.. _Google Drive API: https://developers.google.com/drive/v3/web/quickstart/python
from pysmm.derive_SM import get_map
get_map(*minlon*, *minlat*, *maxlon*, *maxlat*,
'path/to/outdir/',
samping=100, # specify desired output resolution
year=None, month=None, day=None, # define a date (optional)
tracknr=None, # define the Sentinel-1 track (optinal)
tempfilter=True,
mask='Globcover',
masksnow=True,
overwrite=True)
As described in the manual, for the first run, the authentication can be initiated by running the
``quickstart.py`` script. To enable the download of data please modify the following line of the script
**SCOPES = 'https://www.googleapis.com/auth/drive.metadata.readonly' --> SCOPES = 'https://www.googleapis.com/auth/drive'**
* in case *year*, *month*, and *day* are not specified, the entire time-series will be extracted
Install $project by running:
* if *tempfilter=True*, temporal speckle filtering is applied to reduce speckle noise
``python setup.py install``
* mask='...' specifies the land-cover classification that is used for masking the output. *Globcover*
provides global coverage. For Europe and North America, *Corine* and *USGS*, respectively, offer more precise
information.
* if *masksnow=True*, an automatically generated wet-snow mask is applied to the output
* *overwrite=True* allows to specify whether existing files should be overwritten or skipped.
* the output of ``get_map()`` is directly downloaded to *'path/to/outdir/'*
get_ts()
--------
To derive the soil moisture time-series of a single location use ``get_ts()``::
from pysmm.derive_SM import get_ts
sm_ts = ge_ts(*lon*, *lat*,
'/path/to/working_dir/',
footprint=50, # specify the footprint of the extracted time-series
mask_snow=True,
calc_anomalies=True,
create_plots=True)
* The output of *get_ts* is a pandas time-series
* if *masksnow=True*, an automatically generated wet-snow mask is applied to the output
* if *calc_anomalies=True*, anomalies are generated in addition to absolute soil moisture values.
For details about the anomaly computation, see: *Greifeneder F, E Khamala, D Sendabo, W Wagner, M Zebisch, H Farah,
C Notarnicola. Detection of soil moisture anomalies based on Sentinel-1. Physics and Chemistry of the Earth (submitted,
March 2018)*
* if *create_plots=True*, time-series plots are created and saved to *'path/to/working_dir'*
.. _contribute
Contribute
----------
==========
Issue Tracker: https://gitlab.inf.unibz.it/Felix.Greifeneder/pysmm/issues
|Issue Tracker: https://gitlab.inf.unibz.it/Felix.Greifeneder/$project/$project/issues
|Source Code: https://gitlab.inf.unibz.it/Felix.Greifeneder/$project
Source Code: https://gitlab.inf.unibz.it/Felix.Greifeneder/pysmm
Support
-------
.. _contact
Contact
=======
If you are having issues, please let us know.
Mail to: felix.greifeneder@eurac.edu
.. _license
License
-------
=======
The project is licensed under the GNU GENERAL PUBLIC LICENSE Version 3
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
from setuptools import setup
setup(name='pysmm',
version='0.1',
version='0.2',
description='Python Sentinel Soil-Moisture Mapping',
long_description='For detailed documentation go-to http://pysmm.readthedocs.io/en/latest/',
classifiers=[
'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
'Programming Language :: Python :: 2.7',
],
url='https://gitlab.inf.unibz.it/Felix.Greifeneder/pysmm.git',
url='https://gitlab.inf.unibz.it/Felix.Greifeneder/pysmm',
author='Felix Greifeneder',
author_email='felix.greifeneder@eurac.edu',
license='GPLv3',
packages=['gloma'],
packages=['pysmm'],
install_requires=['earthengine-api',
'google-api-python-client',
'cryptography',
......
Markdown is supported
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