API
===

Welcome to our API! We try to keep our documents as updated as possible, but if there's any discrepancies or questions feel free to contact us!  

Landscape
------------

MGSurvE's heart and soul. These modules contain all the definitions and operations necessary to generate our landscape objects.

.. autosummary::
   :toctree: generated
   :nosignatures:

   MGSurvE.landscape
   MGSurvE.matrices
   MGSurvE.kernels


Optimization 
------------

All the operations necessary to optimize traps' positions in our landscapes.

.. autosummary::
   :toctree: generated
   :nosignatures:

   MGSurvE.optimization
   MGSurvE.optimizationPSO
   

DataViz, Point-Processes and Auxiliaries
------------

Functions to generate synthetic landscapes, visualize our analyses, and other necessary structures needed by MGSurvE.

.. autosummary::
   :toctree: generated
   :nosignatures:

   MGSurvE.auxiliary
   MGSurvE.constants
   MGSurvE.colors
   MGSurvE.plots   
   MGSurvE.pointProcess