get_file_structure_for_readme.py

# %%
from joanne.Level_3 import dicts
import joanne

from importlib import reload

reload(dicts)

# %%
dicts.list_of_vars

directory = "/Users/geet/Documents/JOANNE/joanne/Level_3/"

var_name = dicts.list_of_vars

Dimensions = ["height", "sounding"]
Coordinates = ["launch_time", "lat", "lon"]
Variables = [
    var for var in var_name if (var not in Dimensions) & (var not in Coordinates)
]


def string_table_row(var):

    desc = dicts.nc_attrs[var]["long_name"]
    units = dicts.nc_attrs[var]["units"]
    dims_list = dicts.nc_dims[var]
    dims = ', '.join(dims_list)
    str_trow = f"|`{var}`|{desc}|{units}|{dims}|\n"

    return str_trow


def rows_for_objects(Object):

    id_ = 0
    for i in var_name:
        if i in eval(Object):
            if id_ == 0:
                file.write(f"|**{Object}**" + string_table_row(i))
                id_ += 1
            else:
                file.write("|" + string_table_row(i))
                id_ += 1


file = open(f"{directory}file_structure_v{joanne.__version__}.txt", "w",)

file.write("|**OBJECT**|**NAME**|**DESCRIPTION**|**UNITS**|**DIMENSION**|\n")
file.write(f"|---|---|---|---|---|\n")

for Object in ["Dimensions", "Coordinates", "Variables"]:
    rows_for_objects(Object)

file.close()
# %%