.. _welcome:
.. public

.. image:: ./figures/pygeostat_logo.png
   :align: center

|

Welcome
=======

Welcome to pygeostat, a Python 3.6 module for geostatistical modeling. pygeostat is aimed at preparing spatial data, scripting geostatistical workflows, modeling using tools developed at the Centre for Computational Geostatistics, and constructing visualizations to communicate spatial data.

**Features:**

* Configurations of persistent project parameters and plotting style parameters
* Data file management functions for interacting with CSV, GeoEAS (GSLIB), and VTK formats
* Utilities for managing GSLIB-style grid definitions
* Export gridded and point data files for visualization with Paraview (VTK format)
* Simplified scripting of gslib programs with parallelization and crash detection/notification
* Linear desurveying and compositing methods including automatic composite detection
* Fast, accurate variogram calculation, model fitting and modeling routines
* Vast library of :ref:`plotting functions <plotting>`

Indices and tables
++++++++++++++++++

* :ref:`genindex`
* :ref:`mastertoc`
* :ref:`search`

General Package Overview
++++++++++++++++++++++++

The pygeostat package is designed with a flat methodology that uses wrappers to tie some of modules and functions together
The following figure shows a general layout of the pygeostat package.

 .. image:: ./figures/gs_overview.jpg

Plotting Gallery
++++++++++++++++

.. raw:: html

    <style type="text/css">
    .rst-content

    .figure {
        position: relative;
        float: left;
        margin-right: 24px;
        width: 170px;
        height: 170px;
        background-position: center;
        background-size: 250px ;
        border: 2px solid black;
        background-repeat: no-repeat;
    }

    .figure img {
        position: absolute;
        display: inline;
        left: 0;
        width: 170px;
        height: 170px;
        opacity:1.0;
        margin-right: 24px;
        filter:alpha(opacity=100); /* For IE8 and earlier */
    }

    .figure:hover background-image {
        -webkit-filter: blur(3px);
        -moz-filter: blur(3px);
        -o-filter: blur(3px);
        -ms-filter: blur(3px);
        filter: blur(3px);
        opacity:1.0;
        filter:alpha(opacity=100); /* For IE8 and earlier */
    }

    .figure span {
        position: absolute;
        display: inline;
        left: 0;
        width: 170px;
        height: 170px;
        background: #000;
        color: #fff;
        visibility: hidden;
        opacity: 0;
        z-index: 100;
    }

    .figure p {
        position: absolute;
        top: 45%;
        width: 170px;
        font-size: 110%;
    }

    .figure:hover span {
        visibility: visible;
        opacity: .4;
    }

    .caption {
        position: absolue;
        width: 180px;
        top: 170px;
        text-align: center !important;
    }
    </style>

.. raw:: html

    <a href=./plotting.html#pygeostat.plotting.corrmat>
    <div style="background-image: url(./_images/corrmat1.png)"
         class='figure align-center'>
    <span class='figure-label'>
    <p>corrmat</p>
    </span>
    </div>
    </a>

.. raw:: html

    <a href=./plotting.html#pygeostat.plotting.pixelplt>
    <div style="background-image: url(./_images/pixelplt3_150.png)"
         class='figure align-center' margin=10px>
    <span class='figure-label'>
    <p>pixelplt</p>
    </span>
    </div>
    </a>

.. raw:: html

    <a href=./plotting.html#pygeostat.plotting.scatxval>
    <div style="background-image: url(./_images/scatxval1_150.png)"
         class='figure align-center'>
    <span class='figure-label'>
    <p>scatxval</p>
    </span>
    </div>
    </a>

.. raw:: html

    <a href=./plotting.html#pygeostat.plotting.pitplt>
    <div style="background-image: url(./_images/pitplot_mr.png)"
         class='figure align-center'>
    <span class='figure-label'>
    <p>pitplt</p>
    </span>
    </div>
    </a>

.. raw:: html

    <a href=./plotting.html#pygeostat.plotting.accplt>
    <div style="background-image: url(./_images/accplt1.png)"
         class='figure align-center'>
    <span class='figure-label'>
    <p>accplt</p>
    </span>
    </div>
    </a>

.. raw:: html

    <a href=./plotting.html#pygeostat.plotting.varplt>
    <div style="background-image: url(./_images/varplt4_150.png)"
         class='figure align-center'>
    <span class='figure-label'>
    <p>varplt</p>
    </span>
    </div>
    </a>

.. raw:: html

    <a href=./plotting.html#pygeostat.plotting.pixelplt>
    <div style="background-image: url(./_images/pixelplt7_150.png)"
         class='figure align-center'>
    <span class='figure-label'>
    <p>pixelplt</p>
    </span>
    </div>
    </a>

.. raw:: html

    <a href=./plotting.html#pygeostat.plotting.varpltsim>
    <div style="background-image: url(./_images/varpltsim1_150.png)"
         class='figure align-center'>
    <span class='figure-label'>
    <p>varpltsim</p>
    </span>
    </div>
    </a>

.. raw:: html

    <a href=./plotting.html#pygeostat.plotting.histpltsim>
    <div style="background-image: url(./_images/histpltsim1_150.png)"
         class='figure align-center'>
    <span class='figure-label'>
    <p>histpltsim</p>
    </span>
    </div>
    </a>

.. raw:: html

    <a href=./plotting.html#pygeostat.plotting.histplt>
    <div style="background-image: url(./_images/histplt1_150.png)"
         class='figure align-center'>
    <span class='figure-label'>
    <p>histplt</p>
    </span>
    </div>
    </a>

.. raw:: html

    <a href=./plotting.html#pygeostat.plotting.histplt>
    <div style="background-image: url(./_images/histplt3_150.png)"
         class='figure align-center'>
    <span class='figure-label'>
    <p>histplt</p>
    </span>
    </div>
    </a>

.. raw:: html

    <a href=./plotting.html#pygeostat.plotting.loadingsplt>
    <div style="background-image: url(./_images/loadingsplt1_150.png)"
         class='figure align-center'>
    <span class='figure-label'>
    <p>loadingsplt</p>
    </span>
    </div>
    </a>

.. raw:: html

    <div style="clear: both"></div>

Terms of Use
++++++++++++
pygeostat is licensed under the CCG Terms of Use, which may be found at the below link.
http://www.ccgalberta.com/software-terms-of-use/

.. include:: ../changelog.txt