CROCODILE-CESM / regional-mom6

Automatic generation of regional configurations of the Modular Ocean Model 6 (MOM6) in Python
https://regional-mom6.readthedocs.io/en/latest
MIT License
0 stars 2 forks source link

Verbs for methods, and add more properties to expt #9

Closed ashjbarnes closed 1 month ago

ashjbarnes commented 1 month ago

As suggested by @manishvenu , we should make methods start with verbs. I'd also like to add more properties, so that experiments can be easier tested and organised from python rather than NCVIEW. /

For example, after running initial_condition, it would be nice to be able to call expt.initial_condition to get a dataarray containing the initial condition. In this case, I'd suggest that the method be renamed to setup_initial_condition, and then initial_condition be changed to a property that returns a dataarray by reading the IC from disk, and prints "No initial condition yet, please run setup_initial_condition first" if the IC isn't found on disk.

Ideally, all of the data in the input directory (hgrid,vgrid,forcing segments, ic, topo) should be readable directly via a python wrapper. So far this is true of hgrid, topo and vgrid only.

ashjbarnes commented 1 month ago

This was closed with #12