Building CVS Baselibs: Difference between revisions
mNo edit summary |
|||
| (22 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
This page will detail the process of building Baselibs. For the purposes of this page, GMAO-Baselibs- | This page will detail the process of building Baselibs. For the purposes of this page, <tt>GMAO-Baselibs-4_0_7</tt> as an example tag, but this process should work with any tag after <tt>GMAO-Baselibs-3_3_0</tt>. | ||
NOTE: This is now outdated as Baselibs has moved to GitHub. | |||
== Obtaining Baselibs == | |||
=== Set up the 'bcvs' alias === | === Check out Baselibs === | ||
The first step is to check out the tag you want. Tags on CVS are versions of Baselibs 2.x.y, 3.x.y, and 4.x.y. For version 5.x.y, the recommended Baselibs is now hosted on NASA Internal Github and build instructions can be found on [[Building_Git_Baselibs|the Building Git Baselibs page]]. | |||
==== Set up the 'bcvs' alias ==== | |||
Something useful to set up first is an alias that you can use to refer to the CVS repo for Baselibs. This is because the Baselibs are hosted on progress while the GEOS-5 model and most other tools are on the CVSACL repo. So, I recommend setting a 'bcvs' alias: | Something useful to set up first is an alias that you can use to refer to the CVS repo for Baselibs. This is because the Baselibs are hosted on progress while the GEOS-5 model and most other tools are on the CVSACL repo. So, I recommend setting a 'bcvs' alias: | ||
| Line 13: | Line 17: | ||
where <tt>USERNAME</tt> is your username ''at progress''. Note that this works on discover and pleiades, but elsewhere you'll need to set up a tunnel to progress and alter the CVSROOT appropriately. | where <tt>USERNAME</tt> is your username ''at progress''. Note that this works on discover and pleiades, but elsewhere you'll need to set up a tunnel to progress and alter the CVSROOT appropriately. | ||
=== Checking out the tag === | ==== Checking out the tag ==== | ||
Next, checkout the tag: | Next, checkout the tag: | ||
$ bcvs co -r GMAO-Baselibs- | $ bcvs co -r GMAO-Baselibs-4_0_7 -d GMAO-Baselibs-4_0_7 Baselibs | ||
This will create a <tt>GMAO-Baselibs- | This will create a <tt>GMAO-Baselibs-4_0_7</tt> inside which is a <tt>src</tt> directory. | ||
== Build Baselibs == | == Build Baselibs == | ||
The next task is to build Baselibs. In order to correctly build it, two arguments are needed: <tt>ESMF_COMM</tt> and <tt>CONFIG_SETUP</tt>. <tt>ESMF_COMM</tt> is the MPI stack used by ESMF (usually | The next task is to build Baselibs. In order to correctly build it, two arguments are needed: <tt>ESMF_COMM</tt> and <tt>CONFIG_SETUP</tt>. <tt>ESMF_COMM</tt> is the MPI stack used by ESMF (usually <tt>mvapich2</tt>, <tt>mpi</tt> (for SGI MPT or other vendor MPI), <tt>openmpi</tt>, or <tt>intelmpi</tt>). <tt>CONFIG_SETUP</tt> is actually an "identifier" that will allow you to build multiple versions of Baselibs for multiple compiler/MPI combination in the same checkout. The style recommended is for, say, Intel 15.0.2.164 and Intel MPI 5.0.3.048 is: <tt>CONFIG_SETUP=ifort_15.0.2.164-intelmpi_5.0.3.048</tt> where you identify the compiler (by its name on the command line), its version, the MPI stack, and its version. | ||
Note that if you do not add a <tt>CONFIG_SETUP</tt>, it will instead build into a directory named after <tt>$(FC)</tt>, so <tt>ifort</tt> or <tt>gfortran</tt>. This is fine as long as you only build for that compiler once. Build again (say for a different MPI stack) and you will overwrite that first build! | |||
=== Load modules === | === Load modules === | ||
| Line 29: | Line 35: | ||
For our example we want to load these modules: | For our example we want to load these modules: | ||
1) comp/intel-15.0.2.164 | |||
2) mpi/impi-5.0.3.048 | |||
3) lib/mkl-15.0.2.164 | |||
4) other/comp/gcc-4.6.3-sp1 | |||
5) other/SIVO-PyD/spd_1.20.0_gcc-4.6.3-sp1_mkl-15.0.0.090 | |||
For other modules see the table at the end. | For other modules see the table at the end. | ||
| Line 40: | Line 47: | ||
=== Undo any CPP Environment Variable === | === Undo any CPP Environment Variable === | ||
Before doing any make, you should issue: | Before doing any make (especially with PGI), you should issue: | ||
$ unsetenv CPP DEFAULT_CPP | $ unsetenv CPP DEFAULT_CPP | ||
Some modules set these and most of the Baselibs assume the C-preprocessor will be gcc, not, say, pgcpp. | Some modules set these and most of the Baselibs assume the C-preprocessor will be gcc, not, say, pgcpp (which is '''not''' a C++ compiler!). | ||
=== Set MPICC_CC and MPICXX_CXX variables if using MPT === | === (OPTIONAL) Set MPICC_CC and MPICXX_CXX variables if using MPT === | ||
If you are using MPT | If you are using SGI MPT, and you wish to use, say, the PGI C and C++ compilers instead of GNU, you must set the MPICC_CC and MPICXX_CXX variables to be the "correct" compilers. This can be done either in the environment full (beware!) or during the install by adding at the end: | ||
MPICC_CC=pgcc MPICXX_CXX=pgc++ | |||
MPICC_CC=pgcc MPICXX_CXX= | |||
=== Build and install === | === Build and install === | ||
| Line 57: | Line 63: | ||
So for the above example you'd issue: | So for the above example you'd issue: | ||
$ make install ESMF_COMM= | $ make install ESMF_COMM=intelmpi CONFIG_SETUP=ifort_15.0.2.164-intelmpi_5.0.3.048 |& tee makeinstall.ifort_15.0.2.164-intelmpi_5.0.3.048.log | ||
and it would build all the libraries. The <tt>tee</tt> is so that you can capture the install log, and also see it real-time. | and it would build all the libraries. The <tt>tee</tt> is so that you can capture the install log, and also see it real-time. | ||
Once built, check for "Error" in your log file | Once built, check for "Error" in your log file, and if you don't see any "<tt>Error 2</tt>" messages, you are probably safe. | ||
==== make verify ==== | |||
You can also use <tt>make verify</tt> which will check the status of the build (by looking for xxx.config and xxx.install files) and print a table like: | |||
-------+---------+---------+-------------- | |||
Config | Install | Check | Package | |||
-------+---------+---------+-------------- | |||
ok | ok | -- | jpeg | |||
ok | ok | -- | zlib | |||
ok | ok | -- | szlib | |||
ok | ok | -- | curl | |||
ok | ok | -- | hdf4 | |||
ok | ok | -- | hdf5 | |||
ok | ok | -- | h5edit | |||
ok | ok | -- | netcdf | |||
ok | ok | -- | netcdf-fortran | |||
ok | ok | -- | udunits2 | |||
ok | ok | -- | nco | |||
ok | ok | -- | cdo | |||
ok | ok | -- | esmf | |||
ok | ok | -- | hdfeos | |||
ok | ok | -- | uuid | |||
ok | ok | -- | cmor | |||
ok | ok | -- | hdfeos5 | |||
ok | ok | -- | SDPToolkit | |||
-------+---------+---------+-------------- | |||
Note that this is not as comprehensive as looking at the log file as it is possible that some submakes will fail but not communicate that well enough to the main make process. Test | |||
== Checking Baselibs == | == Checking Baselibs == | ||
| Line 79: | Line 102: | ||
This is optional, but recommended. Many of the Baselibs have the ability to do a check. You should do this only in an environment where you can run MPI (like compute nodes at NCCS or NAS). This is because parallel NetCDF and ESMF tests are run: | This is optional, but recommended. Many of the Baselibs have the ability to do a check. You should do this only in an environment where you can run MPI (like compute nodes at NCCS or NAS). This is because parallel NetCDF and ESMF tests are run: | ||
$ make check ESMF_COMM= | $ make check ESMF_COMM=intelmpi CONFIG_SETUP=ifort_15.0.2.164-intelmpi_5.0.3.048 |& tee makecheck.ifort_15.0.2.164-intelmpi_5.0.3.048.log | ||
Note that at the moment, many will exit with errors. For example, NetCDF has tests that require internet access and if a check is done on a compute node with no external access, it will fail. | |||
[[Category:Baselibs]] | [[Category:Baselibs]] | ||
[[Category:SI Team]] | [[Category:SI Team]] | ||