Files
segpy/docs/source/index.rst
T
Robert Smallshire 52cb3a7005 Documentation outline
2015-02-24 11:32:46 +01:00

50 lines
1.1 KiB
ReStructuredText

.. Segpy documentation master file, created by
sphinx-quickstart on Sat Jan 31 17:56:17 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
=====
Segpy
=====
*Segpy* is a Python package for reading and writing SEG Y data. The SEG Y file format is one of several standards
developed by the Society of Exploration Geophysicists for storing geophysical seismic data. It is an open standard, and
is controlled by the SEG Technical Standards Committee, a non-profit organization.
This project aims to implement an open SEG Y module in Python for transporting seismic data between SEG Y files and
Python data structures.
Contents
========
Front Matter
------------
.. toctree::
:maxdepth: 2
Narrative Documentation
-----------------------
Read this to learn how to use *Segpy*:
Reference Documentation
-----------------------
Descriptions and examples for every public function, class and method in *Segpy*.
Change History
--------------
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`