added ms conversion documentation

docs/msconversion.rst

@@ -4,9 +4,9 @@ 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
-.. autofunction:: conversion.asdm_to_pq
-.. autofunction:: conversion.fits_to_pq
-.. autofunction:: conversion.pq_to_ms
-.. autofunction:: conversion.pq_to_asdm
-.. autofunction:: conversion.pq_to_fits
+.. autofunction:: msconversion.ms_to_pq
+.. autofunction:: msconversion.asdm_to_pq
+.. autofunction:: msconversion.fits_to_pq
+.. autofunction:: msconversion.pq_to_ms
+.. autofunction:: msconversion.pq_to_asdm
+.. autofunction:: msconversion.pq_to_fits

msconversion/__init__.py

@@ -0,0 +1,7 @@
+# __init__.py
+from .ms_to_pq import ms_to_pq
+from .asdm_to_pq import asdm_to_pq
+from .fits_to_pq import fits_to_pq
+from .pq_to_ms import pq_to_ms
+from .pq_to_asdm import pq_to_asdm
+from .pq_to_fits import pq_to_fits

msconversion/asdm_to_pq.py

@@ -0,0 +1,21 @@
+def asdm_to_pq(infile, outfile=None):
+    """
+    .. todo::
+        This function is not yet implemented
+    
+    Convert ASDM format to Apache Parquet format (future)
+
+    Parameters
+    ----------
+    infile : str
+        Input ASDM filename
+    outfile : str
+        Output Parquet filename. If None, will use infile name with .pq extension
+
+    Returns
+    -------
+    bool
+        Success status
+    """
+    return True
+

msconversion/fits_to_pq.py

@@ -0,0 +1,21 @@
+def fits_to_pq(infile, outfile=None):
+    """
+    .. todo::
+        This function is not yet implemented
+    
+    Convert FITS format MS to Apache Parquet format (future)
+
+    Parameters
+    ----------
+    infile : str
+        Input FITS filename
+    outfile : str
+        Output Parquet filename. If None, will use infile name with .pq extension
+
+    Returns
+    -------
+    bool
+        Success status
+    """
+    return True
+

msconversion/ms_to_pq.py

@@ -0,0 +1,21 @@
+def ms_to_pq(infile, outfile=None):
+    """
+    .. todo::
+        This function is not yet implemented
+    
+    Convert Legacy MS to Apache Parquet format
+
+    Parameters
+    ----------
+    infile : str
+        Input MS filename
+    outfile : str
+        Output Parquet filename. If None, will use infile name with .pq extension
+
+    Returns
+    -------
+    bool
+        Success status
+    """
+    return True
+

msconversion/pq_to_asdm.py

@@ -0,0 +1,21 @@
+def pq_to_asdm(infile, outfile=None):
+    """
+    .. todo::
+        This function is not yet implemented
+    
+    Convert Apache Parquet MS to ASDM format (future)
+
+    Parameters
+    ----------
+    infile : str
+        Input Parquet filename
+    outfile : str
+        Output ASDM filename. If None, will use infile name with .asdm extension
+
+    Returns
+    -------
+    bool
+        Success status
+    """
+    return True
+

msconversion/pq_to_fits.py

@@ -0,0 +1,21 @@
+def pq_to_fits(infile, outfile=None):
+    """
+    .. todo::
+        This function is not yet implemented
+    
+    Convert Apache Parquet MS to FITS format (future)
+
+    Parameters
+    ----------
+    infile : str
+        Input Parquet filename
+    outfile : str
+        Output FITS filename. If None, will use infile name with .fits extension
+
+    Returns
+    -------
+    bool
+        Success status
+    """
+    return True
+

msconversion/pq_to_ms.py

@@ -0,0 +1,21 @@
+def pq_to_ms(infile, outfile=None):
+    """
+    .. todo::
+        This function is not yet implemented
+    
+    Convert Apache Parquet MS to Legacy CASA MS format
+
+    Parameters
+    ----------
+    infile : str
+        Input Parquet filename
+    outfile : str
+        Output MS filename. If None, will use infile name with .ms extension
+
+    Returns
+    -------
+    bool
+        Success status
+    """
+    return True
+