Add docs

CHANGELOG.txt

@@ -1,4 +1,8 @@
 Master:
+docs
+ * Added inital compiled verison.  Use docsrc for changes.
+docsrc
+ * Added reStructuredText documentation for file format.
 ph5
  * fixed errors in entry_points.py that prevented apps from executing.
  * fixed: seg2toph5, ph5toevt. 

Makefile

@@ -0,0 +1,28 @@
+# USE THIS FOR DOCUMENTATION ONLY NOT FOR MAIN PH5 BUILD
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = docsrc
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+github:
+	@make html
+	@cp -a build/html/. ./docs
+
+clean:
+	@rm -r ./build ./docs
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+

docs/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: b2b2f4cf8ae46fdc293dc52faa763935
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_sources/common.rst.txt

@@ -0,0 +1,95 @@
+tag_timestamp
+
+ascii_s
+```````
+:Type: String
+:Range: Limited to 32 characters
+:Description: Timestamp the table was created in an ascii format.  Example: Thu Dec 19 10:12:27 2019
+
+epoch_l
+```````
+:Type: int 64
+:Range: Limited by integer size
+:Description: The timestamp in epoch seconds.  Also known as Unix time.
+
+micro_seconds_i
+```````````````
+:Type: int 32
+:Range: Limited by integer size
+:Description: Microseconds to add to epoch
+
+type_s
+``````
+:Type: String
+:Range: Limited to 8 characters
+:Description: Epoch, ASCII, or BOTH
+
+end_timestamp_tag
+
+tag_coord
+
+value_d
+'''''''
+:Type: Float 64
+:Range: Limited by coordinate system
+:Description: Value of the coordinate
+
+units_s
+'''''''
+:Type: String
+:Range: Limited to 16 characters
+:Description: Unit of the value
+
+end_coord_tag
+
+tag_corner
+
+coordinate_system_s
+```````````````````
+:Type: String
+:Range: Limited to 32 characters
+:Description: Geographic coordinate system such as decimal degrees used for X and Y fields.
+
+projection_s
+````````````
+:Type: String
+:Range: Limited to 32 characters
+:Description: Projection such as UTM used for X and Y fields.
+
+ellipsoid_s
+```````````
+:Type: String
+:Range: Limited to 32 characters
+:Description: Ellipsoid used for projection such as WGS-84.
+
+description_s
+`````````````
+:Type: String
+:Range: Limited to 1024 characters
+:Description: Description of the corner
+
+X
+`
+Typically longitude in decimal degrees of the corner of a bounding box for the experiment.
+
+.. include:: common.rst
+    :start-after: tag_coord
+    :end-before: end_coord_tag
+
+Y
+`
+Typically latitude in decimal degrees of the corner of a bounding box for the experiment.
+
+.. include:: common.rst
+    :start-after: tag_coord
+    :end-before: end_coord_tag
+
+Z
+`
+Elevation typically in meters.
+
+.. include:: common.rst
+    :start-after: tag_coord
+    :end-before: end_coord_tag
+
+end_corner_tag

docs/_sources/experiment_t.rst.txt

@@ -0,0 +1,79 @@
+Experiment_t
+============
+The Experiment Table is comprised of general
+information, such as a summary of the experiment, the general geographic
+location, and principal investigator names and institutions.  This table
+should consist of a single row for the single experiment archived in PH5
+file.
+
+experiment_id_s
+---------------
+:Type: string
+:Range: Limited to 8 characters
+:Description: This field is usually an IRIS assigned code
+    in the format of ##-####.
+
+net_code_s
+----------
+:Type: String
+:Range: Limited to 8 characters
+:Description: This field is the two letter FDSN assigned network code.
+
+nickname_s
+----------
+:Type: String
+:Range: Limited to 32 characters
+:Description: This field is a short descriptive name of the experiment.  This is
+    used to name SEG-Y files generated by ph5toevt. We
+    recommend using an experiment nickname without any spaces.
+
+longname_s
+----------
+:Type: String
+:Range: Limited to 256 characters
+:Description: This field is a longer name of the experiment.   It is
+    recommended that this match the experiment long name in the PASSCAL
+    experiment database and on the DMC mobilization form.
+
+PIs_s
+-----
+:Type: String
+:Range: Limited to 1024 characters
+:Description: This field is a list of principle investigators for the experiment.
+
+institutions_s
+--------------
+:Type: String
+:Range: Limited to 1024 characters
+:Description: The institutions with which the experiment PIs are affiliated. It
+    is recommended that the institutions be listed in the same order as the PIs.
+
+summary_paragraph_s
+-------------------
+:Type: String
+:Range: Limited to 2048 characters
+:Description: This field should contain a short paragraph summarizing the experiment
+
+time_stamp
+-----------
+Timestamp of when this table was created.
+
+.. include:: common.rst
+    :start-after: tag_timestamp
+    :end-before: end_timestamp_tag
+
+north_west_corner
+-----------------
+
+.. include:: common.rst
+    :start-after: tag_corner
+    :end-before: end_corner_tag
+
+
+south_east_corner
+-----------------
+
+.. include:: common.rst
+    :start-after: tag_corner
+    :end-before: end_corner_tag
+