Guidelines for Packaging NTCC Modules

Guidance for Makefiles
Guidance for Naming Conventions
Hints for Linking Mixed Languages

Guidance for Makefiles:

Use GNU make: usually available in /usr/local/bin or /usr/gnu/bin

Provide a Makefile that supports:

different Operating Systems -- see Make.flags as an example for an include file
options for source and target directories -- to allow one source for multiple architectures
install -- to handle multiple packages
-- see Makefile as an example. (Note: this is a hand made Makefile. With the include file, it produces the same result as the examples below, using Autoconf.)
Use Autoconf to generate configuration scripts for Makefiles
- see configure.in as an example for a configure template
- see Makefile.in as an example for a Makefile template for configure
See GNU Autoconf for more information on Autoconf.
See NERSC Tutorials for an introduction to Makefiles.

Guidance for Naming Conventions:

To avoid potential name conflicts of public f90 modules and public header files between various packages, follow these conventions:

file type	name	destination	usage
header	<name>.h	<PREFIX>/include/<package>	#include "<package>/<name>.h"
header	<name>.h	<PREFIX>/include/<package>	-I <PREFIX>/include
f90 module	<package>_<name>	<PREFIX>/mod	USE <package>_<name>
f90 module	<package>_<name>	<PREFIX>/mod	-M<PREFIX>/mod
library	lib<name>.a	<PREFIX>/lib	-L<PREFIX>/lib -l<package>
executable	<name>	<PREFIX>/bin	add to PATH
script	<name>	<PREFIX>/etc	add to PATH

Example: package xyz produces library libxyz.a and contains f90 module xyz_aaa and headerfile xxx.h
When installed in PREFIX=$HOME
usage would be:

in fortran source:
#include "xyz/xxx.h"
      USE xyz_AAA

compiler flags: -M$HOME/mod -I$HOME/include
linker flags:   -L$HOME/lib -lxyz

Note: -M is vendor dependent and could be -p or -I.

Send mail to transp_support with questions, comments, etc.

Home Guide for Submitters Review Procedures Modules Library

This project is sponsored by the Office of Fusion Energy Sciences of the U. S. Department of Energy.