diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000000000000000000000000000000000..04daf0cf17e6126ef9d780fd5f8281b56fe4066b --- /dev/null +++ b/docs/README.md @@ -0,0 +1,15 @@ +Geomag Algorithms Documents Folder +================================== + +Documents explaining geomag-algorithms + +[XYZ.md](https://github.com/usgs/geomag-algorithms/blob/master/docs/XYZ.md) +------ + +Describes Geomag XYZ algorithm + +[Metadata.md](https://github.com/usgs/geomag-algorithms/blob/master/docs/metadata.md) +----------- + +Describes the metadata stored in the obspy.core.trace.stats class used for +geomag data.