[mpas-developers] Naming Schemes

Doug Jacobsen jacobsen.douglas at gmail.com
Thu Sep 29 10:44:03 MDT 2011


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
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mailman.ucar.edu/pipermail/mpas-developers/attachments/20110929/63e18c65/attachment.html 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: transform.sh
Type: application/x-sh
Size: 451 bytes
Desc: not available
Url : http://mailman.ucar.edu/pipermail/mpas-developers/attachments/20110929/63e18c65/attachment.sh 


More information about the mpas-developers mailing list