frecatalog.py suggested changes

NOAA-GFDL / fre-cli

Python-based command line interface for FRE (FMS Runtime Environment) to compile and run FMS-based models and post-process their output.

GNU Lesser General Public License v3.0

3 stars 7 forks source link

frecatalog.py suggested changes #36

Closed aradhakrishnanGFDL closed 1 month ago

aradhakrishnanGFDL commented 7 months ago

https://github.com/NOAA-GFDL/fre-cli/blob/main/fre/frecatalog/frecatalog.py#L8

it says get_intake_gfdl , the file in catalogbuilder is gen_intake_gfdl.py. Make this consistent.

The shebang could use an update to use whatever python is in user environment.

So, use #!/usr/bin/env python instead of /usr/bin/python.

help needs some help.

Usage: frecatalog.py [OPTIONS] COMMAND [ARGS]...

Options: --help Show this message and exit.

Commands: buildcatalog - Execute fre catalog build

ilaflott commented 2 months ago

To close this issue:

add help descriptions in frecatalog.py, status: incomplete

add/update shebang in frecatalog.py, status: incomplete

Already done:

get_intake_gfdl --> gen_intake_gfdl, status: complete

ilaflott commented 1 month ago

@aradhakrishnanGFDL does set of help description(s) still need attention? I know CatalogBuilder's gen_intake_gfdl.py has a click interface- does that clash with fre/catalog/frecatalog.py's current approach ? has anyone tested?

aradhakrishnanGFDL commented 1 month ago

@ilaflott yes likely resolved by others. heads up @ceblanton - catalog builder will have some [overdue] changes in the pythonic interactions. This will impact fre-cli, and issues will be created when ready.

ilaflott commented 1 month ago

closing- resolved by others, see above comment!