.. raw:: pdf

	PageBreak

.. _surfacedggs-package: 

====================	
Surface DGGS Package
====================

The `surface_dggs` package consists of all of the scripts and django web application components necessary to build and query Surface DGGS Instances

The `Subpackages` contain the python modules and scripts that perform the core backend DGGS related tasks.

The `Submodules` contain the django web application resources to expose the Surface DGGS Resources to the user.

------------------------
Surface DGGS Subpackages
------------------------

The following `Subpackages` are defined by this package. 

- :ref:`surfaceDggs-scripts`

.. toctree::
   :maxdepth: 4

   src.surface_dggs.scripts

-----------------------
Surface DGGS Submodules
-----------------------

The following `submodules` are defined by this package. 

- :ref:`surfaceDggs-apps`
- :ref:`surfaceDggs-consumers`
- :ref:`surfaceDggs-forms`
- :ref:`surfaceDggs-routing`
- :ref:`surfaceDggs-tests`
- :ref:`surfaceDggs-urls`
- :ref:`surfaceDggs-views`



.. _surfaceDggs-apps: 

surface\_dggs.apps module
=========================

.. automodule:: src.surface_dggs.apps
   :members:
   :undoc-members:
   :show-inheritance:


.. _surfaceDggs-consumers: 

surface\_dggs.consumers module
==============================

.. automodule:: src.surface_dggs.consumers
   :members:
   :undoc-members:
   :show-inheritance:   
   
   

.. _surfaceDggs-forms: 

surface\_dggs.forms module
==========================

.. automodule:: src.surface_dggs.forms
   :members:
   :undoc-members:
   :show-inheritance:


.. _surfaceDggs-routing: 

surface\_dggs.routing module
============================

.. automodule:: src.surface_dggs.routing
   :members:
   :undoc-members:
   :show-inheritance:


.. _surfaceDggs-tests: 

surface\_dggs.tests module
==========================

.. automodule:: src.surface_dggs.tests
   :members:
   :undoc-members:
   :show-inheritance:


.. _surfaceDggs-urls: 

surface\_dggs.urls module
=========================

.. automodule:: src.surface_dggs.urls
   :members:
   :undoc-members:
   :show-inheritance:


.. _surfaceDggs-views: 

surface\_dggs.views module
==========================

.. automodule:: src.surface_dggs.views
   :members:
   :undoc-members:
   :show-inheritance:

   
surface\_dggs.views tasks
-------------------------

.. autofunction:: src.surface_dggs.views.get_registered_cells_task

.. autofunction:: src.surface_dggs.views.get_mapped_data_task

.. autofunction:: src.surface_dggs.views.find_cells_task

.. autofunction:: src.surface_dggs.views.map_data_task