[mpas-developers] Naming Schemes

[Xylar Asay-Davis]

Hi Bill,

I definitely don't like the ice/glc convention used in CESM.  As you 
know, I'm in favor of long-winded, so landice works for me.

-Xylar

On 9/29/11 10:52 AM, William Lipscomb wrote:
> Hi all,
>
> I like this general naming scheme.  I just wonder how we should
> designate land ice as opposed to sea ice.  The current CESM convention
> is that sea ice is "ice" and land ice is "glc".  Should we use that
> convention, or should we switch to "landice" and "seaice" for greater
> clarity?  (Although "landice" is kind of long-winded, I don't think
> "lice" is a good option.)
>
> Cheers,
>
> Bill
>
>
> On Sep 29, 2011, at 10:44 AM, Doug Jacobsen wrote:
>
>> Hi All,
>>
>> Just so you know, we have decided on a formal naming scheme for
>> modules.
>> This naming scheme is chosen to try and keep all portions of mpas
>> named
>> uniformly. The generic format of this new naming scheme is as follows.
>>
>> [model]_[core]_[module_name].F
>>
>> Where [model] is going to be mpas for almost every source file. This
>> choice
>> is to help reduce potential namespace conflicts from the use of
>> module.
>>
>> [core] represents the core the code belongs to. For ocean, we are
>> using ocn
>> for [core], and atmosphere might use atmos for [core]. The choice
>> here would
>> be left up to the group developing the core to decide on.
>>
>> [module_name] is left ambiguous, and is meant to represent the
>> content of
>> the individual source file.
>>
>> As an example, module_time_integration.F from the ocean core would be
>> transformed using this naming scheme to mpas_ocn_time_integration.F.
>>
>> Also, all letter should be lower case in this naming scheme, to keep
>> file
>> name uniform looking.
>>
>> I have also provided a simple bash script you can use to migrate
>> file names
>> to the new format, and update the Makefile for the core. I would read
>> through it and edit it if you need to before running it, but it
>> should give
>> a simple example of how to do this.
>>
>> If there are any questions or comments on this choice please let me
>> know,
>> but I am going to be implementing this across our ocean core. Please
>> use
>> this naming scheme when creating new modules.
>>
>> Thank you!
>> Doug
>> <transform.sh>_______________________________________________
>> mpas-developers mailing list
>> mpas-developers at mailman.ucar.edu
>> http://mailman.ucar.edu/mailman/listinfo/mpas-developers
> *******************************************************************************
> William H. Lipscomb					E-mail: lipscomb at lanl.gov
> Los Alamos National Laboratory		Phone: (505) 667-0395
> Group T-3, Mail Stop B216			Fax: (505) 665-5926
> Los Alamos, NM 87545
> *******************************************************************************
>
>
>
>
> _______________________________________________
> mpas-developers mailing list
> mpas-developers at mailman.ucar.edu
> http://mailman.ucar.edu/mailman/listinfo/mpas-developers


-- 

***********************
Xylar S. Asay-Davis
E-mail: xylar at lanl.gov
Phone: (505) 606-0025
Fax: (505) 665-2659
CNLS, MS B258
Los Alamos National Laboratory
Los Alamos, NM 87545
***********************