MohidWiki - User contributions [en]

Mohid Makefile

2008-02-05T22:35:17Z

89.180.71.13: /* References */

Following the makefile [[Makefile CCCP| cross-platform, cross-compiler project methodology]], we finally developped a sound [[makefile]] project for [[MOHID]].

[[Image:makeDAGtreemed.png|frame|'''MOHID makefile project DAG tree''':Orange ellipsoids are makefiles; orange rectangles are makefile code snippets; Diamond arrows are inclusions; Quiver arrows are recursive makes; Large rectangles are project folders; purple octagons are junction nodes. ''Sketch made using [http://www.yworks.com/en/products_yed_about.htm yED]'']]

== Global environment variables ==
There is one thing that allow this project to be easily cross-platformed:
# The use of global environment variables. They are all defined in the respective platform makefile: ''win.mk'', ''nix.mk'', etc... Every new addition of a module, of a fortran file, or of an action must be followed by an update of all the respective platform makefiles (''win.mk'', ''nix.mk'', etc...)

== Platform/Compiler expandible ==
The project makefile's DAG meta-tree shows currently 4 platforms/compilers available: windows ''win.mk'', linux ''nix.mk'', linux with [http://www.pgroup.com/ Portland Group Fortran] ''nix_pgf.mk'' and macintosh ''mac.mk''.
*To add a new compiler and/or a new architecture, one needs to change the main ''Makefile'' and create a new ''arch_Fcomp.mk'' file.

== Action expandible ==
An ''action'' is one given process to apply to the whole project: it could be to ''build'' the project, to ''clean'' the project, to ''install'' the binaries of the project to a safe place, to ''Get'' the files of the project from [[Sos|SourceOffSite]] etc ... The [[makefile]] code for the ''actions'' of the MOHID project is located in the files contained by the ''makefiles'' folder (at the bottom of the image).
*To add an action, one needs to edit the ''actions.mk'' file and create in the ''makefiles'' folder a new ''myaction.mk'' file.

== Module expandible ==
The MOHID project has a modular nature. In this makefile project, each module is subject to the same overall actions and each module is contained in a light-blue folder in the image (''MohidWater'', ''Mohid_Base_1'', ''Mohid_Base_2'' and ''...'').
*To add a new file to an existing module: one must edit the ''Files.mk'' and the ''Dependencies.mk'' within the module's folder.
*To add a new module: one must create a new folder, name it after the module, copy the module's files, create the corresponding ''Files.mk'' and ''Dependencies.mk'' files. Finally, one must edit the ''Modules.mk'' and ''Dependencies.mk'' from the ''root'' folder.

== User's guide ==
=== Linux ===
*Build
>make nix
Please edit the ''nix_template.mk'' first and save it as ''nix.mk''
*Clean
>make nix.clean
*Get from SourceOffSite
>make nix.sos
Please edit the ''../makefiles/Sos_template.mk'' file first and save it as ''../makefiles/Sos.mk''.
*Install
>make nix.install
This will copy the binaries to a specific location on the harddisk. You can change the location by editing the ''nix.mk'' file.

===Windows ===
Use GNUmake! Attention: Rename ''gmake.exe'' to ''make.exe''.
*Build
>make win
*Clean
>make win.clean
*Get from SourceOffSite
>make win.sos
Please edit the ''../makefiles/Sos.mk'' file first.

== References ==
# The [[Makefile CCCP|makefile]] methodology.
# The [http://www.gnu.org/software/make/manual/make.html GNU make manual].
# The graph editor [http://www.yworks.com/en/index.html yED].
[[Category:Technology]]
[[Category:Windows]]
[[Category:Linux]]
[[Category:Makefile]]

Makefile CCCP

2008-02-05T22:34:27Z

89.180.71.13:

This section describes a cross-platform, cross-compiler [[makefile]] development methodology. The syntax to use would be:
make ''platform''.''action''
''(ex: make win, make unix.clean, etc...).''

== The project filetree ==
The project should split the code into modules, and each module should be assigned a folder from the root folder. Therefore there would only be a two-level folders tree:
#The root
#The modules

== The project makefiles distribution ==
The root folder must contain:
*The Makefile (''Makefile'')
*One specific makefile per platform and per compiler (ex: ''win.mk'', ''unix.mk'', etc...)
*An auxiliary file included in the latter (''aux.mk'')

And each module must contain:
*The module standard Makefile (''module/Makefile'')
*The dependencies file included in the latter (''module/Dependencies.mk'')
*The local environment variables file included in the former (''module/Vars.mk'')

== The makefile's global variables ==
The idea is to use '''global variables''' to pass arguments to the different modules makefiles. Thus, each specific platform makefile in the root folder defines these global variables. Then, it calls the modules makefiles who will use the global variables in their syntax. If a systematic approach of using global variables is implemented, then it is fairly easy to have a cross-platform makefile project implemented; and easily extended.

==The [[Mohid Makefile]] Project==

== A sample project for Mohid2D ==
Here we apply the methodology described above.

=== ''Makefile'' ===
SHELL = /bin/sh

export MAKE = make
PLATCLEAN = win.clean nix.clean
PLAT = $(PLATCLEAN:.clean=)

.PHONY: default $(PLATCLEAN) $(PLAT)

default:
@echo Please choose your platform from:
@echo $(PLAT).
@echo Type "make win(.clean)" or "make nix(.clean)".

$(PLAT):
$(MAKE) -f $@.mk all

$(PLATCLEAN) :
$(MAKE) -f $(@:.clean=).mk clean

=== ''win.mk'' ===
SHELL = /bin/sh

###### WIN Exported variables #########
export DEL = del /Q
export O = obj
export F = f90
export MOD = mod
export CC= ifort
export CCFLAGS = -c -fpp -nologo # Debug: -g Profiling: -p
export LFLAGS = -fpp -nologo # Profiling: -p
export AR = ar rc
export HDF5 = D:/Projectos/Mohid_v4/IntelLibs
export LIBS = \
../Library/Library.lib \
../Modulos/Modulos.lib \
../Boxdif_hidrodin/Boxdif_hidrodin.lib \
../Mohid_Base/Mohid_Base.lib \
$(HDF5)/hdf5.lib \
$(HDF5)/hdf5_hl.lib \
$(HDF5)/hdf5c.lib \
$(HDF5)/hdf5f90.lib \
$(HDF5)/szlib.lib \
$(HDF5)/zlib.lib
#### End of exported variables ####

include aux.mk

=== ''nix.mk'' ===
SHELL = /bin/sh

###### NIX Exported variables #########
export DEL = rm
export O = o
export F = f90
export MOD = mod
export CC= ifort
export CCFLAGS = -c -fpp -nologo # Debug: -g Profiling: -p
export LFLAGS = -fpp -nologo # Profiling: -p
export AR = ar rc
export HDF5 = /opt/hdf5/hdf5/lib
export LIBS = \
../Boxdif_hidrodin/Boxdif_hidrodin.lib \
../Mohid_Base/Mohid_Base.lib \
../Modulos/Modulos.lib \
../Library/Library.lib \
$(HDF5)/libhdf5_fortran.a \
$(HDF5)/libhdf5.a \
$(HDF5)/libhdf5_hl.a
#### End of exported variables ####

include aux.mk

=== ''aux.mk'' ===
MODCLEAN = Modulos.clean Boxdif_hidrodin.clean Library.clean Mohid_Base.clean Mohid2D.clean
MODULES = $(MODCLEAN:.clean=.all)

.PHONY: all clean $(MODULES) $(MODCLEAN)

all: $(MODULES)

clean: $(MODCLEAN)

$(MODULES):
$(MAKE) -C $(@:.all=) all

$(MODCLEAN):
$(MAKE) -C $(@:.clean=) clean

#Modules dependencies
Mohid2D.all: Mohid_Base Library.all
Mohid_Base.all: Boxdif_hidrodin.all
Library.all: Modulos.all

=== ''ModuleA/Vars.mk'' ===
SHELL = /bin/sh

INCS = -I../ -I$(HDF5)
SRCS = \
ModuleGlobalData.$(F) \
ModuleHDF5.$(F) \
ModuleTime.$(F) \
Module_EnterData.$(F) \
ModuleOilSpill.$(F) \
ModuleAppPART3D.$(F) \
ModuleEuler.$(F) \
ModuleOxygenSaturation.$(F)
TARGET = Modulos.lib

=== ''ModuleA/Makefile'' ===
include Vars.mk

OBJS = $(SRCS:.$(F)=.$(O))

.PHONY: all clean

all: $(TARGET)

$(TARGET) : $(OBJS)
@$(AR) $@ $^
@echo Finished building $@.

clean:
@-$(DEL) *.$(O) *.$(MOD) $(TARGET)
@echo Erased $(TARGET) files.

%.$(O) : %.$(F)
@$(CC) $(CCFLAGS) $(INCS) $<
@echo $* .............. [OK]

include Dependencies.mk

=== ''ModuleA/Dependencies.mk'' ===
#Dependencies
ModuleHDF5.$(O) : ModuleGlobalData.$(O)
Module_EnterData.$(O) : ModuleTime.$(O)
ModuleOilSpill.$(O) : Module_EnterData.$(O)
ModuleAppPART3D.$(O) : ModuleOilSpill.$(O)
ModuleEuler.$(O) : ../param.cmb

==See also==
*[[Makefile]]
*[[Mohid Makefile]]

[[Category:Makefile]]
[[Category:Windows]]
[[Category:Linux]]

Makefile methodology

2008-02-05T22:33:59Z

89.180.71.13:

#REDIRECT[[Makefile CCCP]]

[[Category:Makefile]]

Makefile methodologyP

2008-02-05T22:31:25Z

89.180.71.13:

#REDIRECT[[Makefile CCCP]]

Template

2008-02-05T16:22:13Z

89.180.71.13:

*[[Template:Anchor]], ''name''

Blog

2008-02-05T16:13:19Z

89.180.71.13: /* youTube */

[[Blog]] is a derived word from ''web-log'', which stands as a web-based log. The interest is that it can be easily published, as well as can contain, besides text, multimedia rich content such as images, sound or films. A published [[blog]] typically provides an [[Wiki RSS|rss]] feed, thus enabling broadcasting. An already notorious blogging site is [http://www2.blogger.com Blogger].

==Music==
Here's how to embed an mp3 file in [http://www2.blogger.com blogger].

===Odeo===

<embed src="http://odeo.com/flash/audio_player_tiny_gray.swf" quality="high" width="145"
height="25" type="application/x-shockwave-flash"
flashvars="audio_id=5440573&audio_duration=1337.1&valid_sample_rate=true&external_url=
http://downloads.oreilly.com/digitalmedia/2007/01/08/dmi6-dtm-in-japan.mp3"></embed>

<odeo>http://downloads.oreilly.com/digitalmedia/2007/01/08/dmi6-dtm-in-japan.mp3</odeo>

==Video==

===youTube===
Here's how to embed a youTube video in [http://www2.blogger.com blogger].

<object width="425" height="350"><param name="movie" value="http://www.youtube.com/v/
MkEbkbTTNss"><param name="wmode" value="transparent"><embed src="http://www.youtube.com/v/
MkEbkbTTNss" type="application/x-shockwave-flash" wmode="transparent" width="425" height="350">
</embed></object>

Here's how to embed the same video in this [[wiki]]
<youtube>ZZgIJZwQalw</youtube>

<youtube>ZZgIJZwQalw</youtube>

[[Category:wiki]]
[[Category:Technology]]