.. Based on _pkgtemplate.rst from Astropy, Licensed under a 3-clause BSD style
.. license - see ASTROPY_SPHINXEXT_LICENSES.rst

.. Licensed under a 3-clause BSD style license - see LICENSE.rst

.. _pysit_util:

*************************************
Miscelaneous Utilities (`pysit.util`)
*************************************

.. note::

    This section of the documentation is under construction.  The source,
    however, is documented and you can access that via the Reference/API
    sections.


Introduction
============

A pile of utility routines


`util` Submodules
=================

.. THIS SECTION SHOULD BE EITHER

More details


Image Processing
----------------

Reference/API
^^^^^^^^^^^^^

.. automodapi:: pysit.util.image_processing
	:no-inheritance-diagram:

Implicit Surfaces
-----------------

Reference/API
^^^^^^^^^^^^^

.. automodapi:: pysit.util.implicit_surfaces
	:no-inheritance-diagram:

IO
--
Reference/API
^^^^^^^^^^^^^

.. automodapi:: pysit.util.io
	:no-inheritance-diagram:


Parallel
--------

Reference/API
^^^^^^^^^^^^^

.. automodapi:: pysit.util.parallel
	:no-inheritance-diagram:


Matrix Helpers
--------------

Reference/API
^^^^^^^^^^^^^

.. automodapi:: pysit.util.matrix_helpers
	:no-inheritance-diagram:


Networking
----------

Reference/API
^^^^^^^^^^^^^

.. automodapi:: pysit.util.net
	:no-inheritance-diagram:

Utilities
---------

Reference/API
^^^^^^^^^^^^^

.. automodapi:: pysit.util.util
	:no-inheritance-diagram:

Iteration History
-----------------

Configuring History
^^^^^^^^^^^^^^^^^^^

Retrieving History
^^^^^^^^^^^^^^^^^^

Adding History Item
^^^^^^^^^^^^^^^^^^^

Line Search
-----------

Outer and Inner Loops
---------------------


Extending `optimization`
========================

Define the required interface:

* _select_step
* inner_loop
* _compute_alpha0

Reference/API
=============

.. automodapi:: pysit.optimization
	:no-inheritance-diagram: