User Documentation

This is the documentation describing how to use the Python functions within the sgsPy package. More...

Topics
	calculate
	documentation of additional calculation functions for sgsPy.
	sample
	Documentation for the sampling functions.
	stratify
	Documentation for the stratification functions.
	utils
	Explanations of both the SpatialRaster and SpatialVector classes.

Detailed Description

This is the documentation describing how to use the Python functions within the sgsPy package.

For information on the underlying C++ implementations, see the developer docs.

The first step in any processing using the sgsPy package will be to initialize in insance of either sgspy.SpatialRaster or sgspy.SpatialVector. These are the primary data inputs to all sgs functions, and information on their use can be found in the 'utils' section.

The processing functions are split into three different categories: calculate, stratify, and sample.
The calculate section contains various helpful functions to assist in sampling but are not necessarily a specific stratification or sampling function. Right now, it only has 'pca' or principal component analysis.
The stratify section has various stratification functions including stratification according to user defined breaks 'breaks', stratification according to polygons 'poly', stratification along quantiles 'quantiles', and a method for mapping multiple existing stratificaiton outputs 'map'.
The sample sections has various sampling functions including simple random sampling 'srs', stratified random sampling 'strat', systematic sampling 'systematic', and conditional latin hypercube sampling 'clhs'.