Difference between revisions of "Building on Ubuntu"

From GridPACK
Jump to: navigation, search
 
(18 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
This build was performed on a [https://www.virtualbox.org/ Virtual Box] instance running a clean install of [http://www.ubuntu.com/ Ubuntu Linux] 16.04 (LTS). Most of the [[Software_Required_to_Build_GridPACK|prerequisite software]] was installed using [http://www.ubuntu.com/ Ubuntu] packages. Any packages that needed to be built from source were installed in /usr/local/gridpack
+
GridPACK is relatively easy to build on Ubuntu Linux systems. This example was performed on a [https://www.virtualbox.org/ Virtual Box] instance running a clean install of [http://releases.ubuntu.com/16.04/ Ubuntu Linux 16.04 (LTS)]. Virtual Box is not required and this build should work on Linux systems using the Ubuntu operating system. If you have no need to modify the GridPACK library itself, consider [[Ubuntu_Installation| installing the binary package]]. <span style="color:red">'''You will need super user or sudo privileges for this installation'''</span>.
  
−
[http://www.boost.org Boost] was installed like this
+
A few basic development packages will be necessary. Install them with
  
−
  sudo apt-get install libboost-all-dev
+
<pre>sudo apt-get install git build-essential devscripts equivs</pre>
  
−
This installed a C++ compiler and [http://www.open-mpi.org/ OpenMPI] compiler wrappers, as well as all of [http://www.boost.org/ Boost].  Other available packages were installed using
 
  
−
  sudo apt-get install openmpi-bin make cmake git gfortran liblapack-dev doxygen
+
== Install Required Packages ==
  
−
The <code>doxygen</code> package can be skipped, since it installs a large number of dependencies. A compatible ParMETIS package is available, so install that
+
Before installing the remaining packages, you ''must'' first download GridPACK onto your computer and put it in a convenient directory. Instructions for downloading GridPACK can be found [[Download_GridPACK| here]].  
  
−
  sudo apt-get install libparmetis-dev
+
All the [https://www.gridpack.org/wiki/index.php/Software_Required_to_Build_GridPACK GridPACK prerequisites] packages can be installed using the packaging information in the source. Run this command in the top directory of the GridPACK repository:
  
 +
<pre>sudo mk-build-deps -i</pre>
  
−
== PETSc ==
+
This will make and install a virtual package called <code>gridpack-build-deps</code> with all the dependencies needed to build GridPACK.
  
−
Ubuntu packages for [http://www.mcs.anl.gov/petsc/index.html PETSc] 3.6 were available.  These can be installed with
+
Alternatively, all required packages will be installed by [[Ubuntu_Installation| installing the GridPACK binary package]].
  
−
  sudo apt-get petsc3.6-dev petsc-complex-3.6-dev
+
== Build and Test GridPACK ==
  
−
These are built with several optional packages, including Hypre, SuiteSparse, and MUMPS. SuperLU is also include, not SuperLU_DIST, which  will limit direct linear solver methods in parallel. Alternatively, PETSc can be built from source. 
 
  
 +
Configure and build GridPACK using the recipe for <code>gridpackvm</code> in <code>example_configuration.sh</code>. From the top-most GridPACK source directory, do the following:
  
−
[http://www.mcs.anl.gov/petsc/index.html PETSc] version 3.4.3 was configured and built as follows:
+
<pre>mkdir src/build
 +
cd src/build
 +
bash ../example_configuration.sh gridpackvm
 +
make
 +
make test</pre>
  
−
  prefix="$HOME/stuff"
+
Or, modify this configuration recipe to fit your needs:
−
  PETSC_DIR="$prefix/petsc-3.4.3"
 
−
  export PETSC_DIR
 
−
  python ./config/configure.py \
 
−
      PETSC_ARCH=arch-linux2-complex-opt \
 
−
      --with-prefix="$prefix" \
 
−
      --with-mpi=1 \
 
−
      --with-cc=mpicc \
 
−
      --with-fc=mpif90 \
 
−
      --with-cxx=mpicxx \
 
−
      --with-c++-support=1 \
 
−
      --with-c-support=0 \
 
−
      --with-fortran=0 \
 
−
      --with-pthread=0 \
 
−
      --with-scalar-type=complex \
 
−
      --with-fortran-kernels=generic \
 
−
      --download-superlu_dist \
 
−
      --download-parmetis \
 
−
      --download-metis \
 
−
      --with-clanguage=c++ \
 
−
      --with-shared-libraries=0 \
 
−
      --with-dynamic-loading=0 \
 
−
      --with-x=0 \
 
−
      --with-mpirun=mpirun \
 
−
      --with-mpiexec=mpiexec \
 
−
      --with-debugging=0
 
−
  make PETSC_DIR="$prefix/petsc-3.4.3" PETSC_ARCH=arch-linux2-complex-opt all
 
−
  make PETSC_DIR="$prefix/petsc-3.4.3" PETSC_ARCH=arch-linux2-complex-opt test
 
  
−
ParMETIS was included in the build, so separate compilation was not necessary.
+
<pre>CC=gcc
 +
CXX=g++
 +
export CC CXX
  
−
== Global Arrays ==
+
cmake \
 +
    -D PETSC_DIR:STRING=&quot;/usr/lib/petscdir/3.6.2&quot; \
 +
    -D PETSC_ARCH:STRING=&quot;x86_64-linux-gnu-real&quot; \
 +
    -D PARMETIS_DIR:PATH=&quot;/usr&quot; \
 +
    -D GA_EXTRA_LIBS:STRING=&quot;-lscalapack-openmpi -lblacsCinit-openmpi -lblacs-openmpi -llapack -lblas -lgfortran&quot; \
 +
    -D MPI_CXX_COMPILER:STRING=&quot;mpicxx&quot; \
 +
    -D MPI_C_COMPILER:STRING=&quot;mpicc&quot; \
 +
    -D MPIEXEC:STRING=&quot;mpiexec&quot; \
 +
    -D MPIEXEC_MAX_NUMPROCS:STRING=&quot;2&quot; \
 +
    -D GRIDPACK_TEST_TIMEOUT:STRING=60 \
 +
    -D USE_GLPK:BOOL=ON \
 +
    -D GLPK_ROOT_DIR:PATH=&quot;/usr&quot; \
 +
    -D BUILD_SHARED_LIBS:BOOL=OFF \
 +
    -D CMAKE_INSTALL_PREFIX:PATH=&quot;$HOME/gridpack&quot; \
 +
    -D CMAKE_VERBOSE_MAKEFILE:BOOL=TRUE \
 +
    ..
 +
make</pre>
  
−
[http://hpc.pnl.gov/globalarrays/ Global Arrays] version 5.2 was configured, built, and installed as follows:
+
If compilation is successful, the [[How to Build GridPACK#Running Tests|unit tests]] and/or [[How to Build GridPACK#Running_the_Powerflow_Example.28s.29|example applications]] can be run.
  
−
  prefix="$HOME/stuff"
+
== Removing Required Software ==
−
  ./configure \
 
−
      --enable-cxx \
 
−
      --enable-i4 \
 
−
      --disable-f77 \
 
−
      --with-mpi \
 
−
      --prefix="$prefix" \
 
−
      --with-blas=no \
 
−
      --with-lapack=no \
 
−
      --enable-shared=no \
 
−
      --enable-static=yes \
 
−
      MPICC=mpicc MPICXX=mpicxx MPIF77=mpif90 \
 
−
      MPIEXEC=mpiexec MPIRUN=mpirun
 
−
  make
 
−
  make install
 
  
 +
If no longer needed, the required packages can be removed using
  
−
== Building and Testing GridPACK ==
 
  
−
GridPACK was configured and built as follows:
+
<pre>sudo apt-get purge gridpack-build-deps
−
 
+
sudo apt autoremove</pre>
−
  rm -f CMakeCache.txt
 
−
  prefix="$HOME/stuff"
 
−
  cmake -Wno-dev --debug-try-compile \
 
−
      -D PETSC_DIR:STRING="$prefix/petsc-3.4.3" \
 
−
      -D PETSC_ARCH:STRING="arch-linux2-complex-opt" \
 
−
      -D GA_DIR:STRING="$prefix" \
 
−
      -D MPI_CXX_COMPILER:STRING="mpicxx" \
 
−
      -D MPI_C_COMPILER:STRING="mpicc" \
 
−
      -D MPIEXEC:STRING="mpiexec" \
 
−
      -D CMAKE_BUILD_TYPE:STRING="Debug" \
 
−
      -D CMAKE_VERBOSE_MAKEFILE:BOOL=TRUE \
 
−
      ..
 
−
  make
 
−
  make test
 

Latest revision as of 15:09, 9 May 2019

GridPACK is relatively easy to build on Ubuntu Linux systems. This example was performed on a Virtual Box instance running a clean install of Ubuntu Linux 16.04 (LTS). Virtual Box is not required and this build should work on Linux systems using the Ubuntu operating system. If you have no need to modify the GridPACK library itself, consider installing the binary package. You will need super user or sudo privileges for this installation.

A few basic development packages will be necessary. Install them with 

sudo apt-get install git build-essential devscripts equivs


Install Required Packages

Before installing the remaining packages, you must first download GridPACK onto your computer and put it in a convenient directory. Instructions for downloading GridPACK can be found here.

All the GridPACK prerequisites packages can be installed using the packaging information in the source. Run this command in the top directory of the GridPACK repository: 

sudo mk-build-deps -i

This will make and install a virtual package called gridpack-build-deps with all the dependencies needed to build GridPACK.

Alternatively, all required packages will be installed by installing the GridPACK binary package.

Build and Test GridPACK

Configure and build GridPACK using the recipe for gridpackvm in example_configuration.sh. From the top-most GridPACK source directory, do the following: 

mkdir src/build
cd src/build
bash ../example_configuration.sh gridpackvm
make 
make test

Or, modify this configuration recipe to fit your needs: 

CC=gcc
CXX=g++
export CC CXX

cmake \
    -D PETSC_DIR:STRING="/usr/lib/petscdir/3.6.2" \
    -D PETSC_ARCH:STRING="x86_64-linux-gnu-real" \
    -D PARMETIS_DIR:PATH="/usr" \
    -D GA_EXTRA_LIBS:STRING="-lscalapack-openmpi -lblacsCinit-openmpi -lblacs-openmpi -llapack -lblas -lgfortran" \
    -D MPI_CXX_COMPILER:STRING="mpicxx" \
    -D MPI_C_COMPILER:STRING="mpicc" \
    -D MPIEXEC:STRING="mpiexec" \
    -D MPIEXEC_MAX_NUMPROCS:STRING="2" \
    -D GRIDPACK_TEST_TIMEOUT:STRING=60 \
    -D USE_GLPK:BOOL=ON \
    -D GLPK_ROOT_DIR:PATH="/usr" \
    -D BUILD_SHARED_LIBS:BOOL=OFF \
    -D CMAKE_INSTALL_PREFIX:PATH="$HOME/gridpack" \
    -D CMAKE_VERBOSE_MAKEFILE:BOOL=TRUE \
    ..
make

If compilation is successful, the unit tests and/or example applications can be run.

Removing Required Software

If no longer needed, the required packages can be removed using 


sudo apt-get purge gridpack-build-deps
sudo apt autoremove
Retrieved from "https://gridpack.pnnl.gov/wiki/index.php?title=Building_on_Ubuntu&oldid=3943"