.. LSDTopoTools documentation master file, created by
   sphinx-quickstart on Tue Oct  1 14:15:45 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.



.. image:: ./_images/Logo/UoE_Geosciences_K.jpg
   :scale: 40
   :alt: School of GeoSciences

====================================================================
Documentation for the LSDTopoToolBox
====================================================================

This documentation is for the Topographic Toolbox developed by the `Land Surface Dynamics (LSD) Group
<http://www.geos.ed.ac.uk/research/globalchange/group3/>`_
at the 
University of Edinburgh's 
`School of GeoSciences
<http://www.ed.ac.uk/schools-departments/geosciences/>`_.


Note this is a user guide and *not* documentation of the API. 
The detailed documentation of the software including objects, member functions and variables may be found at the 
`Source code documentation site
<http://www.geos.ed.ac.uk/~s0675405/LSD_Docs/index.html>`_.


Authors
=========

This software has been developed by:

 * `Simon M. Mudd
   <http://www.geos.ed.ac.uk/homes/smudd/>`_;
   School of GeoSciences, University of Edinburgh
 * `Martin D. Hurst
   <http://www.bgs.ac.uk/staff/profiles/41289.html>`_;
   British Geological Survey
 * `David T. Milodowski
   <http://www.geos.ed.ac.uk/homes/s1143956/>`_;
   School of GeoSciences, University of Edinburgh
 * `Stuart W.D. Grieve
   <http://www.geos.ed.ac.uk/homes/s0675405/>`_;
   School of GeoSciences, University of Edinburgh
 * `Fiona J. Clubb
   <http://www.geos.ed.ac.uk/homes/s0923330/>`_;
   School of GeoSciences, University of Edinburgh
 * `Declan A. Valters
   <http://personalpages.manchester.ac.uk/staff/declan.valters/>`_; 
   School of Earth, Atmospheric and Environmental Sciences, University of Manchester
   





Contents
=========

.. toctree::
   :maxdepth: 3
   :numbered:

   General Information <what>
   Instructions specific to University of Edinburgh <edin_instructions>
   Instructions for external users: Libraries and Dependencies <external_instructions>
   Version control with git <git_instructions>
   Data preparation <float>
   Data preparation 2: using GDAL <gdal_notes>
   Extracting typical metrics <typical_metrics>
   Chi analysis: part 1: getting channel profiles <chi_profiles>
   Chi analysis: part 2: extracting the m/n ratio and performing the chi transformation <chi_analysis_part2>
   Scripting and Supercomputing for Topographic Analysis <automation>
   Selecting a window size for surface fitting <window_size>
   Extraction of Hillslope Lengths and Basin Metrics <basin_metrics>
   Generating E* R* data <ER_Star>
   Extraction of channel networks <channel_heads>
   Junction Extraction <get_junctions>
   Swath profiles <swath_profiles>
   Computing length scales using the spectral method <spectral_analysis>
   Landscape Evolution Model <model>
   Catchment/Basin Evolution Model <catchmentmodel>
   Basinwide cosmogenics <basinwide_cosmogenics>

Search
==================

* :ref:`search`