Added command line feature for remap_restarts.py

[weiyuan-jiang]

This PR added command line features. The interface also changed. To get help, please use
./remap_restarts.py -h
./remap_restarts.py config_file -h
./remap_restarts.py command_line -h

[weiyuan-jiang]

@biljanaorescanin Thanks for helping testing. Please save some examples so I can added to the test cases

[mathomp4]

@weiyuan-jiang You should change to use the choices argument for argparser. For example, in my create_expt.py code I have:

        p.add_argument('--moist', help="Moist microphysics to use (Default: BACM)", type=str, default='BACM',
                choices=['BACM','GFDL','MGB2'])

and when I run create_expt.py -h I see:

  --moist {BACM,GFDL,MGB2}
                        Moist microphysics to use (Default: GFDL)

So argparse sort of automatically fills out the allowed choices which is nice and restricts it so you can't pass in unallowed options:

❯ create_expt.py test-c12 --moist ABCD
usage: create_expt.py [-h] [-v] [-q] [--expdsc EXPDSC] [--expdir EXPDIR]
...
create_expt.py: error: argument --moist: invalid choice: 'ABCD' (choose from 'BACM', 'GFDL', 'MGB2')

You can equivalently do something like:

        moist_choices = ['BACM','GFDL','MGB2']
        p.add_argument('--moist', help="Moist microphysics to use (Default: BACM)", type=str, default='BACM',
                choices=moist_choices)

I'm never quite sure when's the right time to make a separate array. I suppose if you can use the array in more than one place...

[weiyuan-jiang]

Great.

[weiyuan-jiang]

The last commit addressed the issue #20 . Ben's scripts are slightly modified and plugged into this package. @bena-nasa I didn't take catchment's conversion because it is already converted during regridding.

[gmao-rreichle]

@weiyuan-jiang can you add a notebook (clear output before pushing to github) to show at least one use case, for e.g., remap_upper.py? Thanks!

@sanAkel -- we have updated the Wiki page: https://github.com/GEOS-ESM/GEOS_Util/wiki/remap_restarts-package and ironed out a few more kinks (incl. making the package ready for NAS). Please take another look and see if this works for you. If so, please approve, so we can put this on @sdrabenh's desk. I'll defer to @sdrabenh on whether a notebook is needed, and we can always add it later. My preference would be to move this forward before a potential shutdown. Note also that we provide pre-configured test cases / examples in the ./test dir. Thanks!

cc: @weiyuan-jiang @biljanaorescanin

[gmao-rreichle]

re-approving after bug fix

[biljanaorescanin]

@weiyuan-jiang we will need few more changes to run this on NAS. We did rsync BCS files but seems they use PBS to submit jobs there and now our script is SBATCH hardcoded.

For everything else this PR was tested:

1. automatic tests that are part of package ( this will work only on discover since NAS doesn't have baseline tests for comparison. )
2. 12 more random cases which also included few coupled cases where we just change resolution.

I couldn't find any issues. @sdrabenh let me know if you find something during your testing.

Wiki looks reasonable for PR approval

[sdrabenh]

@mathomp4 can you approve on behalf of cmake-team? @bena-nasa doesn't appear to have permissions

[mathomp4]

@mathomp4 can you approve on behalf of cmake-team? @bena-nasa doesn't appear to have permissions

Odd. He definitely should! I'll look into that next week

[sanAkel]

@weiyuan-jiang can you add a notebook (clear output before pushing to github) to show at least one use case, for e.g., remap_upper.py? Thanks!

@sanAkel -- we have updated the Wiki page: https://github.com/GEOS-ESM/GEOS_Util/wiki/remap_restarts-package and ironed out a few more kinks (incl. making the package ready for NAS). Please take another look and see if this works for you. If so, please approve, so we can put this on @sdrabenh's desk. I'll defer to @sdrabenh on whether a notebook is needed, and we can always add it later. My preference would be to move this forward before a potential shutdown. Note also that we provide pre-configured test cases / examples in the ./test dir. Thanks!

cc: @weiyuan-jiang @biljanaorescanin

Thanks @gmao-rreichle wiki looks self-sufficient.