begin api documentation

casangi · Oct 15, 2019 · 839c2e8 · 839c2e8
1 parent 694c7e6
commit 839c2e8
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 2 deletions.
diff --git a/docs/images.rst b/docs/images.rst
@@ -0,0 +1,5 @@
+Image
+====================
+
+The functions in this section act on Image data.  Functions labeled as (future) are future growth to be added after the prototype phase.
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,12 +1,12 @@
 CASA Next Generation Infrastructure
 ===============================================================
-
-.. autofunction:: conversion.ms_to_pq
 
 .. toctree::
    :maxdepth: 2
    :caption: Content:
 
+   measurementsets
+   images
 
 
 Indices and tables

diff --git a/docs/measurementsets.rst b/docs/measurementsets.rst
@@ -0,0 +1,10 @@
+MeasurementSet
+===================
+
+The functions in this section act on MeasurementSet data.  Functions labeled as (future) are future growth to be added after the prototype phase.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Content:
+
+   msconversion
diff --git a/docs/msconversion.rst b/docs/msconversion.rst
@@ -0,0 +1,7 @@
+Conversion
+====================
+
+Legacy CASA uses a custom MS format while CNGI uses the standard Apache Parquet (PQ) format.  These functions allow conversion between the two as well as directly from the telescope archival science data model (ASDM) (future growth).  Note that both the MS and PQ formats are directories, not single files.
+
+
+.. autofunction:: conversion.ms_to_pq