.. _gxpy:

gxpy modules reference
======================

The :mod:`geosoft.gxpy` modules provide a Python-oriented API that takes advantage of Python to simplify
much of the complexity of the `low-level GX API <geosoft.gxapi.html>`__.

Submodules
----------

The following sub-modules organize functions into logical groups.

.. currentmodule:: geosoft.gxpy

.. autosummary::
   :toctree:

   geosoft.gxpy.agg
   geosoft.gxpy.coordinate_system
   geosoft.gxpy.dap_client
   geosoft.gxpy.dataframe
   geosoft.gxpy.gdb
   geosoft.gxpy.geometry
   geosoft.gxpy.geometry_utility
   geosoft.gxpy.grid
   geosoft.gxpy.grid_fft
   geosoft.gxpy.grid_utility
   geosoft.gxpy.group
   geosoft.gxpy.gx
   geosoft.gxpy.map
   geosoft.gxpy.metadata
   geosoft.gxpy.project
   geosoft.gxpy.segy_reader
   geosoft.gxpy.spatialdata
   geosoft.gxpy.surface
   geosoft.gxpy.system
   geosoft.gxpy.utility
   geosoft.gxpy.va
   geosoft.gxpy.view
   geosoft.gxpy.viewer
   geosoft.gxpy.vox
   geosoft.gxpy.vox_display
   geosoft.gxpy.vv
   
See https://github.com/GeosoftInc/gxpy/tree/master/examples for example scripts that use the Python modules.

See https://github.com/GeosoftInc/gxpy/tree/master/geosoft/gxpy/tests for tests that exercise the gxpy modules.

.. automodule:: geosoft.gxpy
    :members:
    :undoc-members:
    :show-inheritance: