build roms - Revision history

Robertson at 18:37, 5 May 2025

2025-05-05T18:37:42Z

← Older revision		Revision as of 18:37, 5 May 2025
Line 114:		Line 114:
	<section begin=USE_PIO />;<span id="USE_PIO"></span>[[USE_PIO]]		<section begin=USE_PIO />;<span id="USE_PIO"></span>[[USE_PIO]]
	: Activate parallel I/O using Parallel IO (PIO) libraries developed at NCAR. More information can be found on on the [[IO\|ROMS I/O]] page.<section end=USE_PIO />		: Activate parallel I/O using Parallel IO (PIO) libraries developed at NCAR. More information can be found on on the [[IO\|ROMS I/O]] page.<section end=USE_PIO />


	~~<section begin=USE_SCORPIO />;<span id="USE_SCORPIO"></span>[[USE_SCORPIO]]~~
	: Activate parallel I/O using the Software for Caching Output and Reads for Parallel I/O ('''SCORPIO''') library intended for the DOE's Energy Exascale Earth Model System ([https://e3sm.org/scorpio-parallel-io-library/ E<sup>3</sup>SM]). More information can be found on on the [[IO\|ROMS I/O]] page.<section end=USE_SCORPIO />

Robertson at 16:44, 8 April 2022

2022-04-08T16:44:38Z

← Older revision		Revision as of 16:44, 8 April 2022
Line 84:		Line 84:
	====Library Types and Executable====		====Library Types and Executable====

	The options in this section allow you to choose whether to build ROMS using a shared or static (or both) library. If you enable both SHARED, STATIC and EXEC, the ROMS executable will automatically choose the shared library (except in cygwin). Building the ROMS executable using the shared library <span class="red">is not recommended</span> because it requires keeping track of the matching libROMS.{so\|dylib} which is located in the Build_roms or Build_romsG directory and will be lost and/or replaced with each new build. The option to build the shared version of libROMS is for use in model coupling systems ~~like JCSDA-JEDI~~.		The options in this section allow you to choose whether to build ROMS using a shared or static (or both) library. If you enable both SHARED, STATIC and EXEC, the ROMS executable will automatically choose the shared library (except in cygwin). Building the ROMS executable using the shared library <span class="red">is not recommended</span> because it requires keeping track of the matching libROMS.{so\|dylib} which is located in the Build_roms or Build_romsG directory and will be lost and/or replaced with each new build. The option to build the shared version of libROMS is for use in model coupling systems.

			{{note}}'''NOTE:''' If both SHARED and STATIC are unset but EXEC is set, ROMS will automatically build with the static library. If all three are unset, ROMS will default to building the roms executable with the static library.


Line 96:		Line 98:

	<section begin=EXEC />;<span id="EXEC"></span>[[EXEC]]		<section begin=EXEC />;<span id="EXEC"></span>[[EXEC]]
	: Build the ROMS executable. In most cases you will want this on. The only time this should be off is if you are building the ROMS library for inclusion in a model coupling ~~system like JCSDA-JEDI~~.<section end=EXEC/>		: Build the ROMS executable. In most cases you will want this on. The only time this should be off is if you are building the ROMS library for inclusion in a model coupling systems.<section end=EXEC/>

	====ROMS I/O Choices====		====ROMS I/O Choices====

Robertson at 14:45, 8 April 2022

2022-04-08T14:45:02Z

← Older revision		Revision as of 14:45, 8 April 2022
Line 15:		Line 15:
	:<div class="box">'''Usage:'''<br /><br /><span class="red"> ./build_roms.csh [options]</span><br /><br />'''Options:'''<br /><br /><span class="red"> -j [N]</span> Compile in parallel using <span class="red">N</span> CPUs<br /> omit argument for all available CPUs.<br /><br /><span class="red"> -p macro</span> Prints any [[makefile]] variable value. For example,<br /><br /> build_roms.sh -p FFLAGS<br /><br /><span class="red"> -noclean</span> Do not clean already compiled objects.<br /><br />'''Example:'''<br /><br /><span class="green"> ./build_roms.sh -j 2</span></div>		:<div class="box">'''Usage:'''<br /><br /><span class="red"> ./build_roms.csh [options]</span><br /><br />'''Options:'''<br /><br /><span class="red"> -j [N]</span> Compile in parallel using <span class="red">N</span> CPUs<br /> omit argument for all available CPUs.<br /><br /><span class="red"> -p macro</span> Prints any [[makefile]] variable value. For example,<br /><br /> build_roms.sh -p FFLAGS<br /><br /><span class="red"> -noclean</span> Do not clean already compiled objects.<br /><br />'''Example:'''<br /><br /><span class="green"> ./build_roms.sh -j 2</span></div>

	==User Definable ~~Compilation~~ Options==		==User Definable Configuation Options==
	ROMS has a growing list of choices the user must make about the compilation before starting the compile process. These user-defined variables can be set in the build script. Since we use '''gnu make''', it is possible to set the value of these variables in the Unix environment, rather than inside the '''Makefile''' (see [[gmake]]). ~~The~~ user-definable variables understood by the ROMS '''makefile''' ~~are:~~		ROMS has a growing list of choices the user must make about the compilation before starting the compile process. These user-defined variables can be set in the build script. Since we use '''gnu make''', it is possible to set the value of these variables in the Unix environment, rather than inside the '''Makefile''' (see [[gmake]]). This page describes the user-definable variables understood by the ROMS '''makefile'''.

			===Application and File Locations===

	<section begin=ROMS_APPLICATION />;<span id="ROMS_APPLICATION"></span>[[ROMS_APPLICATION]]		<section begin=ROMS_APPLICATION />;<span id="ROMS_APPLICATION"></span>[[ROMS_APPLICATION]]
Line 38:		Line 39:
	: Directory where [[make]] can find your system/compiler specific mk include files as described in [[#FORT\|FORT]]. In some situations you will need to edit the appropriate mk file in the Compilers directory (i.e. '''Compilers/Linux-gfortran.mk'''). Rather than editing the mk files released with ROMS and possibly creating conflicts during updates, we suggest that you copy the appropriate system specific mk file and the '''Compilers/make_macros.mk''' to another folder and set [[COMPILERS]] to that folder.<section end=COMPILERS />		: Directory where [[make]] can find your system/compiler specific mk include files as described in [[#FORT\|FORT]]. In some situations you will need to edit the appropriate mk file in the Compilers directory (i.e. '''Compilers/Linux-gfortran.mk'''). Rather than editing the mk files released with ROMS and possibly creating conflicts during updates, we suggest that you copy the appropriate system specific mk file and the '''Compilers/make_macros.mk''' to another folder and set [[COMPILERS]] to that folder.<section end=COMPILERS />

			===Dynamic CPP Option Tuning===

	<section begin=MY_CPP_FLAGS />;<span id="MY_CPP_FLAGS"></span>[[MY_CPP_FLAGS]]		<section begin=MY_CPP_FLAGS />;<span id="MY_CPP_FLAGS"></span>[[MY_CPP_FLAGS]]
	: Additional CPP options to activate. Sometimes it is desirable to activate one or more CPP options to run different variants of the same application without modifying its header file. If this is the case, specify such options here using the '''-D''' syntax. Notice that you need to use your shell's quoting syntax to enclose the definitions. For example:		: Additional CPP options to activate. Sometimes it is desirable to activate one or more CPP options to run different variants of the same application without modifying its header file. If this is the case, specify such options here using the '''-D''' syntax. Notice that you need to use your shell's quoting syntax to enclose the definitions. For example:
	:<div class="box">setenv [[MY_CPP_FLAGS]] "-D[[Options#AVERAGES\|AVERAGES]]"<br />setenv [[MY_CPP_FLAGS]] "${[[MY_CPP_FLAGS]]} -D[[Options#ANA_INITIAL\|ANA_INITIAL]]"</div>		:<div class="box">setenv [[MY_CPP_FLAGS]] "-D[[Options#AVERAGES\|AVERAGES]]"<br />setenv [[MY_CPP_FLAGS]] "${[[MY_CPP_FLAGS]]} -D[[Options#ANA_INITIAL\|ANA_INITIAL]]"</div>
	:can be ~~use~~ to write time-averaged fields and use analytical initial conditions. Notice that you can have as many definitions as you want by appending values.<section end=MY_CPP_FLAGS />		:can be used to write time-averaged fields and use analytical initial conditions. Notice that you can have as many definitions as you want by appending values.<section end=MY_CPP_FLAGS />

			===Compiling Options===

	{{warning}}'''Warning:''' Be sure to leave environment variables meant to be off set to an empty string or commented out. Any string value (including '''off''') will evaluate to '''TRUE''' in conditional if-statements.		{{warning}}'''Warning:''' Be sure to leave environment variables meant to be off set to an empty string or commented out. Any string value (including '''off''') will evaluate to '''TRUE''' in conditional if-statements.

			====Parallel Execution Options====

	<section begin=USE_MPI />;<span id="USE_MPI"></span>[[USE_MPI]]		<section begin=USE_MPI />;<span id="USE_MPI"></span>[[USE_MPI]]
Line 63:		Line 67:
	: Compile your application using OpenMP librairies and compiler options. '''Note:''' you cannot set [[USE_OpenMP]] and [[#USE_MPI\|USE_MPI]] at the same time.<section end=USE_OpenMP />		: Compile your application using OpenMP librairies and compiler options. '''Note:''' you cannot set [[USE_OpenMP]] and [[#USE_MPI\|USE_MPI]] at the same time.<section end=USE_OpenMP />

			====Compiler and Options====

	<section begin=FORT />;<span id="FORT"></span>[[FORT]]		<section begin=FORT />;<span id="FORT"></span>[[FORT]]
Line 76:		Line 81:
	<section begin=USE_LARGE />;<span id="USE_LARGE"></span>[[USE_LARGE]]		<section begin=USE_LARGE />;<span id="USE_LARGE"></span>[[USE_LARGE]]
	: If applicable, activate 64-bit compilation.<section end=USE_LARGE />		: If applicable, activate 64-bit compilation.<section end=USE_LARGE />

			====Library Types and Executable====

			The options in this section allow you to choose whether to build ROMS using a shared or static (or both) library. If you enable both SHARED, STATIC and EXEC, the ROMS executable will automatically choose the shared library (except in cygwin). Building the ROMS executable using the shared library <span class="red">is not recommended</span> because it requires keeping track of the matching libROMS.{so\|dylib} which is located in the Build_roms or Build_romsG directory and will be lost and/or replaced with each new build. The option to build the shared version of libROMS is for use in model coupling systems like JCSDA-JEDI.


			<section begin=SHARED />;<span id="SHARED"></span>[[SHARED]]
			: Build the shared library version of libROMS.<section end=SHARED />


			<section begin=STATIC />;<span id="STATIC"></span>[[STATIC]]
			: Build the static library version of libROMS.<section end=STATIC />


			<section begin=EXEC />;<span id="EXEC"></span>[[EXEC]]
			: Build the ROMS executable. In most cases you will want this on. The only time this should be off is if you are building the ROMS library for inclusion in a model coupling system like JCSDA-JEDI.<section end=EXEC/>

			====ROMS I/O Choices====
			A more complete description of the available options can be found on the [[IO]] page. Most users will want to enable at least USE_NETCDF4 because that will instruct the ROMS build system to use nf-config to determine the necessary libraries and paths to link into the ROMS executable.


Line 96:		Line 120:
	<section begin=USE_HDF5 />;<span id="USE_HDF5"></span>[[USE_HDF5]]		<section begin=USE_HDF5 />;<span id="USE_HDF5"></span>[[USE_HDF5]]
	: If any of the coupling components use the HDF5 Fortran API for primary I/O, we need to compile the main driver with the HDF5 Fortran library.<section end=USE_HDF5 />		: If any of the coupling components use the HDF5 Fortran API for primary I/O, we need to compile the main driver with the HDF5 Fortran library.<section end=USE_HDF5 />

			====Earth Systems Models (ESM) coupling====
			If coupling Earth Systems Models (ESM), set the location of the ESM component libraries and modules. The strategy is to compile and link each ESM component separately first, and then ROMS since it is driving the coupled system. Only the ESM components activated are considered and the rest are ignored. Some components like WRF cannot be built in a directory specified by the user but in its own root directory, and cannot be moved when debugging with tools like TotalView.


Line 101:		Line 128:
	: WRF cannot be built in a directory specified by the user; it must be built in its own root directory and cannot be moved when debugging with tools like TotalView. If you wish to couple ROMS with the Earth Systems Model (ESM) WRF, ROMS needs to know the WRF root directory.<section end=WRF_SRC_DIR />		: WRF cannot be built in a directory specified by the user; it must be built in its own root directory and cannot be moved when debugging with tools like TotalView. If you wish to couple ROMS with the Earth Systems Model (ESM) WRF, ROMS needs to know the WRF root directory.<section end=WRF_SRC_DIR />


			====Various Path options====

	<section begin=USE_MY_LIBS />;<span id="USE_MY_LIBS"></span>[[USE_MY_LIBS]]		<section begin=USE_MY_LIBS />;<span id="USE_MY_LIBS"></span>[[USE_MY_LIBS]]

Arango: /* Build Script Debugging */

2021-06-02T19:11:24Z

Build Script Debugging

← Older revision		Revision as of 19:11, 2 June 2021
Line 131:		Line 131:
	:We highly recommend to use this option to inquire your environment when having errors during compiling and linking. For Example:		:We highly recommend to use this option to inquire your environment when having errors during compiling and linking. For Example:
	:<div class="box"><span class="red">build_roms.sh -p</span> '''MKFILE'''<br /><br /><br /><span class="twilightBlue">Using customized library paths from:</span> <span class="hotPink">/Users/arango/Compilers/ROMS/my_build_paths.sh</span><br /><br /><span class="red">MKFILE</span> = /Users/arango/Compilers/ROMS/Darwin-ifort.mk</div>		:<div class="box"><span class="red">build_roms.sh -p</span> '''MKFILE'''<br /><br /><br /><span class="twilightBlue">Using customized library paths from:</span> <span class="hotPink">/Users/arango/Compilers/ROMS/my_build_paths.sh</span><br /><br /><span class="red">MKFILE</span> = /Users/arango/Compilers/ROMS/Darwin-ifort.mk</div>
			:Notice that there is not a compilation, but a report about the value of local [[makefile]] variable <span class="red">MKFILE</span>.

	==Library and Executable Paths==		==Library and Executable Paths==

Arango: /* Build Script Debugging */

2021-06-02T19:07:43Z

Build Script Debugging

← Older revision		Revision as of 19:07, 2 June 2021
Line 130:		Line 130:
	:<div class="box"><span class="red">build_roms.sh -p</span> '''LIBS'''<br /><span class="red">build_roms.sh -p</span> '''libraries'''<br /><span class="red">build_roms.sh -p</span> '''modules'''<br /><span class="red">build_roms.sh -p</span> '''includes'''<br /><span class="red">build_roms.sh -p</span> '''sources'''<br /><span class="red">build_roms.sh -p</span> '''CPPFLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MY_CPP_FLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MY_ROOT_DIR'''<br /><span class="red">build_roms.sh -p</span> '''MY_ROMS_SRC'''<br /><span class="red">build_roms.sh -p</span> '''MKFILE'''<br /><span class="red">build_roms.sh -p</span> '''FFLAGS'''<br /></div>		:<div class="box"><span class="red">build_roms.sh -p</span> '''LIBS'''<br /><span class="red">build_roms.sh -p</span> '''libraries'''<br /><span class="red">build_roms.sh -p</span> '''modules'''<br /><span class="red">build_roms.sh -p</span> '''includes'''<br /><span class="red">build_roms.sh -p</span> '''sources'''<br /><span class="red">build_roms.sh -p</span> '''CPPFLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MY_CPP_FLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MY_ROOT_DIR'''<br /><span class="red">build_roms.sh -p</span> '''MY_ROMS_SRC'''<br /><span class="red">build_roms.sh -p</span> '''MKFILE'''<br /><span class="red">build_roms.sh -p</span> '''FFLAGS'''<br /></div>
	:We highly recommend to use this option to inquire your environment when having errors during compiling and linking. For Example:		:We highly recommend to use this option to inquire your environment when having errors during compiling and linking. For Example:
	:<div class="box"><span class="red">build_roms.sh -p</span> '''MKFILE'''</~~div~~><br /><span class="twilightBlue">Using customized library paths from:</span> <span class="hotPink">/Users/arango/Compilers/ROMS/my_build_paths.sh</span><br /><br /><span class="red">MKFILE</span> = /Users/arango/Compilers/ROMS/Darwin-ifort.mk		:<div class="box"><span class="red">build_roms.sh -p</span> '''MKFILE'''<br /><br /><br /><span class="twilightBlue">Using customized library paths from:</span> <span class="hotPink">/Users/arango/Compilers/ROMS/my_build_paths.sh</span><br /><br /><span class="red">MKFILE</span> = /Users/arango/Compilers/ROMS/Darwin-ifort.mk</div>

	==Library and Executable Paths==		==Library and Executable Paths==

Arango: /* Build Script Debugging */

2021-06-02T19:05:34Z

Build Script Debugging

← Older revision		Revision as of 19:05, 2 June 2021
Line 130:		Line 130:
	:<div class="box"><span class="red">build_roms.sh -p</span> '''LIBS'''<br /><span class="red">build_roms.sh -p</span> '''libraries'''<br /><span class="red">build_roms.sh -p</span> '''modules'''<br /><span class="red">build_roms.sh -p</span> '''includes'''<br /><span class="red">build_roms.sh -p</span> '''sources'''<br /><span class="red">build_roms.sh -p</span> '''CPPFLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MY_CPP_FLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MY_ROOT_DIR'''<br /><span class="red">build_roms.sh -p</span> '''MY_ROMS_SRC'''<br /><span class="red">build_roms.sh -p</span> '''MKFILE'''<br /><span class="red">build_roms.sh -p</span> '''FFLAGS'''<br /></div>		:<div class="box"><span class="red">build_roms.sh -p</span> '''LIBS'''<br /><span class="red">build_roms.sh -p</span> '''libraries'''<br /><span class="red">build_roms.sh -p</span> '''modules'''<br /><span class="red">build_roms.sh -p</span> '''includes'''<br /><span class="red">build_roms.sh -p</span> '''sources'''<br /><span class="red">build_roms.sh -p</span> '''CPPFLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MY_CPP_FLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MY_ROOT_DIR'''<br /><span class="red">build_roms.sh -p</span> '''MY_ROMS_SRC'''<br /><span class="red">build_roms.sh -p</span> '''MKFILE'''<br /><span class="red">build_roms.sh -p</span> '''FFLAGS'''<br /></div>
	:We highly recommend to use this option to inquire your environment when having errors during compiling and linking. For Example:		:We highly recommend to use this option to inquire your environment when having errors during compiling and linking. For Example:
	:<div class="box"><span class="red">build_roms.sh -p</span> '''~~FFLAGS~~'''</div><br /><span class="twilightBlue">Using customized library paths from:</span> <span class="hotPink">/Users/arango/Compilers/ROMS/my_build_paths.sh</span><br /><br /><span class="red">~~FFLAGS~~</span> = ~~-fp-model source -heap-arrays -ip -O3 -traceback -check uninit -Wl,-stack_size,0x68000000 -I~~/~~opt~~/~~intelsoft~~/~~openmpi~~/~~esmf-8.1.0_nc4_ompi-2.1.6/mod/modO~~/Darwin~~.intel.64.openmpi.default~~ -~~I/opt/intelsoft/openmpi/esmf-8.1.0_nc4_ompi-2.1~~.~~6/include -I/opt/intelsoft/serial/netcdf-4.7.4/include -I/opt/intelsoft/serial/netcdf-4.7.4/include~~		:<div class="box"><span class="red">build_roms.sh -p</span> '''MKFILE'''</div><br /><span class="twilightBlue">Using customized library paths from:</span> <span class="hotPink">/Users/arango/Compilers/ROMS/my_build_paths.sh</span><br /><br /><span class="red">MKFILE</span> = /Users/arango/Compilers/ROMS/Darwin-ifort.mk

	==Library and Executable Paths==		==Library and Executable Paths==

Arango: /* Build Script Debugging */

2021-06-02T19:02:30Z

Build Script Debugging

← Older revision		Revision as of 19:02, 2 June 2021
Line 129:		Line 129:
	{{note}}'''Note:''' The build script has the <span class="red">-p</span> option to inquire and report about any of the environmental and local variables used in the [[makefile]] or build scripts. Usefull build commands are:		{{note}}'''Note:''' The build script has the <span class="red">-p</span> option to inquire and report about any of the environmental and local variables used in the [[makefile]] or build scripts. Usefull build commands are:
	:<div class="box"><span class="red">build_roms.sh -p</span> '''LIBS'''<br /><span class="red">build_roms.sh -p</span> '''libraries'''<br /><span class="red">build_roms.sh -p</span> '''modules'''<br /><span class="red">build_roms.sh -p</span> '''includes'''<br /><span class="red">build_roms.sh -p</span> '''sources'''<br /><span class="red">build_roms.sh -p</span> '''CPPFLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MY_CPP_FLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MY_ROOT_DIR'''<br /><span class="red">build_roms.sh -p</span> '''MY_ROMS_SRC'''<br /><span class="red">build_roms.sh -p</span> '''MKFILE'''<br /><span class="red">build_roms.sh -p</span> '''FFLAGS'''<br /></div>		:<div class="box"><span class="red">build_roms.sh -p</span> '''LIBS'''<br /><span class="red">build_roms.sh -p</span> '''libraries'''<br /><span class="red">build_roms.sh -p</span> '''modules'''<br /><span class="red">build_roms.sh -p</span> '''includes'''<br /><span class="red">build_roms.sh -p</span> '''sources'''<br /><span class="red">build_roms.sh -p</span> '''CPPFLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MY_CPP_FLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MY_ROOT_DIR'''<br /><span class="red">build_roms.sh -p</span> '''MY_ROMS_SRC'''<br /><span class="red">build_roms.sh -p</span> '''MKFILE'''<br /><span class="red">build_roms.sh -p</span> '''FFLAGS'''<br /></div>
	:We highly recommend to use this option to inquire your environment when having errors during compiling and linking.		:We highly recommend to use this option to inquire your environment when having errors during compiling and linking. For Example:
			:<div class="box"><span class="red">build_roms.sh -p</span> '''FFLAGS'''</div><br /><span class="twilightBlue">Using customized library paths from:</span> <span class="hotPink">/Users/arango/Compilers/ROMS/my_build_paths.sh</span><br /><br /><span class="red">FFLAGS</span> = -fp-model source -heap-arrays -ip -O3 -traceback -check uninit -Wl,-stack_size,0x68000000 -I/opt/intelsoft/openmpi/esmf-8.1.0_nc4_ompi-2.1.6/mod/modO/Darwin.intel.64.openmpi.default -I/opt/intelsoft/openmpi/esmf-8.1.0_nc4_ompi-2.1.6/include -I/opt/intelsoft/serial/netcdf-4.7.4/include -I/opt/intelsoft/serial/netcdf-4.7.4/include

	==Library and Executable Paths==		==Library and Executable Paths==

Arango: /* Build Script Debugging */

2021-06-02T18:39:58Z

Build Script Debugging

← Older revision		Revision as of 18:39, 2 June 2021
Line 127:		Line 127:
	==Build Script Debugging==		==Build Script Debugging==

	{{note}}'''Note:''' The build script has the <span class="red">-p</span> option to inquire about any of environmental and local variables used in the [[makefile]] or build scripts. Usefull build commands are:		{{note}}'''Note:''' The build script has the <span class="red">-p</span> option to inquire and report about any of the environmental and local variables used in the [[makefile]] or build scripts. Usefull build commands are:
	:<div class="box"><span class="red">build_roms.sh -p</span> '''LIBS'''<br /><span class="red">build_roms.sh -p</span> '''libraries'''<br /><span class="red">build_roms.sh -p</span> '''modules'''<br /><span class="red">build_roms.sh -p</span> '''includes'''<br /><span class="red">build_roms.sh -p</span> '''sources'''<br /><span class="red">build_roms.sh -p</span> '''CPPFLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MY_CPP_FLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MY_ROOT_DIR'''<br /><span class="red">build_roms.sh -p</span> '''MY_ROMS_SRC'''<br /><span class="red">build_roms.sh -p</span> '''MKFILE'''<br /><span class="red">build_roms.sh -p</span> '''FFLAGS'''<br /></div>		:<div class="box"><span class="red">build_roms.sh -p</span> '''LIBS'''<br /><span class="red">build_roms.sh -p</span> '''libraries'''<br /><span class="red">build_roms.sh -p</span> '''modules'''<br /><span class="red">build_roms.sh -p</span> '''includes'''<br /><span class="red">build_roms.sh -p</span> '''sources'''<br /><span class="red">build_roms.sh -p</span> '''CPPFLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MY_CPP_FLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MY_ROOT_DIR'''<br /><span class="red">build_roms.sh -p</span> '''MY_ROMS_SRC'''<br /><span class="red">build_roms.sh -p</span> '''MKFILE'''<br /><span class="red">build_roms.sh -p</span> '''FFLAGS'''<br /></div>
	:We highly recommend to use this option to inquire your environment when having errors during compiling and linking.		:We highly recommend to use this option to inquire your environment when having errors during compiling and linking.

Arango: /* Build Script Debugging */

2021-06-02T18:37:16Z

Build Script Debugging

← Older revision		Revision as of 18:37, 2 June 2021
Line 128:		Line 128:

	{{note}}'''Note:''' The build script has the <span class="red">-p</span> option to inquire about any of environmental and local variables used in the [[makefile]] or build scripts. Usefull build commands are:		{{note}}'''Note:''' The build script has the <span class="red">-p</span> option to inquire about any of environmental and local variables used in the [[makefile]] or build scripts. Usefull build commands are:
	:<div class="box"><span class="red">build_roms.sh -p</span> '''LIBS'''<br /><span class="red">build_roms.sh -p</span> '''libraries'''<br /><span class="red">build_roms.sh -p</span> '''modules'''<br /><span class="red">build_roms.sh -p</span> '''includes'''<br /><span class="red">build_roms.sh -p</span> '''sources'''<br /><span class="red">build_roms.sh -p</span> '''CPPFLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MY_CPP_FLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MKFILE'''<br /><span class="red">build_roms.sh -p</span> '''FFLAGS'''<br /></div>		:<div class="box"><span class="red">build_roms.sh -p</span> '''LIBS'''<br /><span class="red">build_roms.sh -p</span> '''libraries'''<br /><span class="red">build_roms.sh -p</span> '''modules'''<br /><span class="red">build_roms.sh -p</span> '''includes'''<br /><span class="red">build_roms.sh -p</span> '''sources'''<br /><span class="red">build_roms.sh -p</span> '''CPPFLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MY_CPP_FLAGS'''<br /><span class="red">build_roms.sh -p</span> '''MY_ROOT_DIR'''<br /><span class="red">build_roms.sh -p</span> '''MY_ROMS_SRC'''<br /><span class="red">build_roms.sh -p</span> '''MKFILE'''<br /><span class="red">build_roms.sh -p</span> '''FFLAGS'''<br /></div>
	:We highly recommend to use this option to inquire your environment when having errors during compiling and linking.		:We highly recommend to use this option to inquire your environment when having errors during compiling and linking.

Arango: /* Introduction */

2021-06-02T18:34:10Z

Introduction

← Older revision		Revision as of 18:34, 2 June 2021
Line 13:		Line 13:
	There are two of these build scripts in the '''ROMS/Bin''' directory: '''build_roms.csh''' and '''build_roms.sh'''. The build scripts use environment variables to provide values for the user-defined [[make]] variables, overwriting those found in the ROMS '''makefile'''. Just as in the multiple '''makefile''' option, you will need as many copies of the build script as you have applications. However, the scope of these variables is local to the build script, allowing you to compile different applications at the same time from the same sources as long as each '''$([[#SCRATCH_DIR\|SCRATCH_DIR]])''' is unique.		There are two of these build scripts in the '''ROMS/Bin''' directory: '''build_roms.csh''' and '''build_roms.sh'''. The build scripts use environment variables to provide values for the user-defined [[make]] variables, overwriting those found in the ROMS '''makefile'''. Just as in the multiple '''makefile''' option, you will need as many copies of the build script as you have applications. However, the scope of these variables is local to the build script, allowing you to compile different applications at the same time from the same sources as long as each '''$([[#SCRATCH_DIR\|SCRATCH_DIR]])''' is unique.

	:<div class="box">'''Usage:'''<br /><br /><span class="red"> ./build_roms.csh [options]</span><br /><br />'''Options:'''<br /><br /><span class="red"> -j [N]</span> Compile in parallel using <span class="red">N</span> CPUs<br /> omit argument for all available CPUs.<br /><br /><span class="red"> -p macro</span> Prints any [[makefile]] ~~macro~~ value. For example,<br /><br /> build_roms.sh -p FFLAGS<br /><br /><span class="red"> -noclean</span> Do not clean already compiled objects.<br /><br />'''Example:'''<br /><br /><span class="green"> ./build_roms.sh -j 2</span></div>		:<div class="box">'''Usage:'''<br /><br /><span class="red"> ./build_roms.csh [options]</span><br /><br />'''Options:'''<br /><br /><span class="red"> -j [N]</span> Compile in parallel using <span class="red">N</span> CPUs<br /> omit argument for all available CPUs.<br /><br /><span class="red"> -p macro</span> Prints any [[makefile]] variable value. For example,<br /><br /> build_roms.sh -p FFLAGS<br /><br /><span class="red"> -noclean</span> Do not clean already compiled objects.<br /><br />'''Example:'''<br /><br /><span class="green"> ./build_roms.sh -j 2</span></div>

	==User Definable Compilation Options==		==User Definable Compilation Options==