.. SOG documentation master file
..
.. :Author: Doug Latornell <djl@douglatornell.ca>
.. :License: Apache License, Version 2.0
..
..
.. Copyright 2010-2014 Doug Latornell and The University of British Columbia
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
..
..    http://www.apache.org/licenses/LICENSE-2.0
..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.


Welcome to the SOG documentation!
=================================

SOG is a
vertical,
one-dimensional,
coupled physics-biogeochemical model for deep estuaries.
It is a local model of the lower trophic-level ecology and carbon/oxygen/nitrogen cycles that is based on a simplified,
but accurate,
physical model.
SOG is being used to investigate the processes that determine primary productivity and carbon fluxes.

SOG is developed by `Dr. Susan Allen's`_ `Mesoscale Ocean Dynamics group`_ in the Department of Earth, Ocean and Atmospheric Sciences at the Univeristy of British Columbia.

.. _Dr. Susan Allen's: http://www.eos.ubc.ca/about/faculty/S.Allen.html
.. _Mesoscale Ocean Dynamics group: http://www.eos.ubc.ca/~sallen/

SOG is licensed under the Apache License, Version 2.0.
http://www.apache.org/licenses/LICENSE-2.0
Please see the LICENSE and NOTICE files in the code repositories for details of the license,
and how to cite the SOG project.

Contents:

.. toctree::
   :maxdepth: 2

   quickstart
   workflows
   SOGcommand
   SOG-YAML
   buildbot
   trac
   SOGcommand-API