https://github.com/RadioAstronomySoftwareGroup/pyuvdata
Revision b86f3ea682d8441fc6d368a1c323ae8d7f166929 authored by jburba on 01 March 2018, 15:08 UTC, committed by jburba on 01 March 2018, 15:08 UTC
1 parent c20e1bc
Raw File
Tip revision: b86f3ea682d8441fc6d368a1c323ae8d7f166929 authored by jburba on 01 March 2018, 15:08 UTC
Updating plotting output
Tip revision: b86f3ea
make_cal_parameters.py
"""
Format the UVCal object parameters into a sphinx rst file.
"""
import os
import inspect
from pyuvdata import UVCal
import numpy as np
from astropy.time import Time


def write_calparams_rst(write_file=None):
    cal = UVCal()
    out = 'UVCal Parameters\n==========================\n'
    out += ("These are the standard attributes of UVCal objects.\n\nUnder the hood "
            "they are actually properties based on UVParameter objects.\n\n")
    out += 'Required\n----------------\n'
    out += ('These parameters are required to have a sensible UVCal object and \n'
            'are required for most kinds of uv cal files.')
    out += "\n\n"
    for thing in cal.required():
        obj = getattr(cal, thing)
        out += '**{name}**\n'.format(name=obj.name)
        out += '     {desc}\n'.format(desc=obj.description)
        out += "\n"

    out += 'Optional\n----------------\n'
    out += ('These parameters are defined by one or more file standard but are not '
            'always required.\nSome of them are required depending on the '
            'cal_type (as noted below).')
    out += "\n\n"
    for thing in cal.extra():
        obj = getattr(cal, thing)
        out += '**{name}**\n'.format(name=obj.name)
        out += '     {desc}\n'.format(desc=obj.description)
        out += "\n"
    t = Time.now()
    t.out_subfmt = 'date'
    out += "last updated: {date}".format(date=t.iso)
    if write_file is None:
        write_path = os.path.dirname(os.path.abspath(inspect.stack()[0][1]))
        write_file = os.path.join(write_path, 'uvcal_parameters.rst')
    F = open(write_file, 'w')
    F.write(out)
    print("wrote " + write_file)
back to top