Difference between revisions of "Building on Debian"

From GridPACK
Jump to: navigation, search
(Created page with "Building GridPACK is relatively straightforward on [https://www.debian.org/ | Debian 9 (stretch)] systems. At the time of writing, [https://www.debian.org/ | Debian 9] was th...")
 
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
Building GridPACK is relatively straightforward on [https://www.debian.org/ | Debian 9 (stretch)] systems.  At the time of writing, [https://www.debian.org/ | Debian 9] was the current stable distribution. There is no need to build any [[Software_Required_to_Build_GridPACK | prerequisite software]].  All can be installed from Debian package repositories.   
+
Building GridPACK is relatively straightforward on [https://www.debian.org/ Debian 9 (stretch)] systems.  At the time of writing, [https://www.debian.org/ Debian 9] was the current stable distribution. There is no need to build any [[Software_Required_to_Build_GridPACK | prerequisite software]].  All can be installed from Debian package repositories.  This documents a GridPACK build on [https://www.debian.org/ Debian 9 (stretch)] installed on a [https://www.virtualbox.org/ VirtualBox] virtual machine (VM) using the [https://www.debian.org/CD/ complete installation image]. Virtual Box is not required and this build should work on Linux systems using the Debian operating system.
  
 
== System Preparation ==
 
== System Preparation ==
  
−
Starting with a ''clean'', minimal installation, add contrib and non-free components of the Debian distribution need to apt sources (ParMETIS is in non-free). Edit '''/etc/apt/sources.list''' and make the main repository line look like this:
+
<span style="color:red">'''You will need super user or sudo privileges for this installation'''</span>. You will not be able to edit files <code>/etc/apt/sources.list</code> or use utilities such as <code>apt-get</code> without them.  Here, the <tt>sudo</tt> command is used to perform super user activities. This command was installed automatically in this case. Your system may be different as it was in [https://github.com/GridOPTICS/GridPACK/issues/27 at least one other case]. 
 +
 
 +
Starting with a ''clean'' installation, add <tt>contrib</tt> and <tt>non-free</tt> components of the Debian distribution to apt sources (ParMETIS is in non-free). Edit <code>/etc/apt/sources.list</code> and make the main repository line look like this:
  
 
  deb http://ftp.us.debian.org/debian/ stretch main contrib non-free
 
  deb http://ftp.us.debian.org/debian/ stretch main contrib non-free
 
  deb-src http://ftp.us.debian.org/debian/ stretch main contrib non-free
 
  deb-src http://ftp.us.debian.org/debian/ stretch main contrib non-free
  
−
and then refresh the system package lists with
+
It may be necessary to change the file permissions before editing:
 +
 
 +
sudo chmod +w /etc/apt/sources.list
 +
 
 +
Refresh the system package lists with
  
 
  sudo apt-get update
 
  sudo apt-get update
Line 27: Line 33:
 
     libboost-random-dev libboost-filesystem-dev libboost-system-dev
 
     libboost-random-dev libboost-filesystem-dev libboost-system-dev
  
−
This will install the default MPI implementation (OpenMPI), including compiler wrappers, also.
+
This will also install the default MPI implementation (OpenMPI), including compiler wrappers.
  
 
=== PETSc ===
 
=== PETSc ===
 +
 +
Install the real-valued version of [https://www.mcs.anl.gov/petsc/ PETSc] with
 +
 +
sudo apt-get install petsc-dev
 +
 +
or the complex-valued version with
 +
 +
sudo apt-get install libpetsc3.7.5-dev
  
 
=== Global Arrays ===
 
=== Global Arrays ===
 +
 +
[https://github.com/GlobalArrays/ga Global Arrays] has lots of dependencies. Unfortunately, installing the Debian GA package (version <code>5.4~beta~r10636+dfsg-5</code>) does not enforce any of them. Installing [https://www.mcs.anl.gov/petsc/ PETSc] first will install most of them. This should complete the GA installation:
 +
 +
sudo apt-get install libglobalarrays-dev libarmci-mpi-dev
 +
 +
=== ParMETIS ===
 +
 +
Install [http://glaros.dtc.umn.edu/gkhome/metis/parmetis/overview ParMETIS] using
 +
 +
sudo apt-get install libparmetis-dev libmetis-dev
 +
 +
=== GNU Linear Programming Kit ===
 +
 +
[https://www.gnu.org/software/glpk/ GLPK] is optional and can be installed with
 +
sudo apt-get install libglpk-dev
 +
 +
== GridPACK Configuration and Build ==
 +
 +
[https://www.gridpack.org/wiki/index.php/Download_GridPACK Obtain the GridPACK release or development code] and put it in a convenient directory, like <code><span style="color:red">$HOME/gridpack/src</span></code>. The top level GridPACK directory is denoted below by the variable <tt>$GRIDPACK</tt>.
 +
 +
It is a good idea to build GridPACK in a separate directory under the GridPACK source tree. The example below assumes that a directory called <tt>build</tt> has been created under <tt>$GRIDPACK/src</tt> and that you have cd'd into this directory:
 +
 +
  cd $GRIDPACK/src
 +
  mkdir build
 +
  cd build
 +
 +
Configure GridPACK as follows
 +
<pre>
 +
CC=gcc
 +
CXX=g++
 +
CFLAGS=-pthread
 +
CXXFLAGS=-pthread
 +
export CC CXX CFLAGS CXXFLAGS
 +
 +
cmake \
 +
    -D PETSC_DIR:STRING="/usr/lib/petsc" \
 +
    -D PARMETIS_DIR:PATH="/usr" \
 +
    -D GA_EXTRA_LIBS:STRING="-lscalapack-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=30 \
 +
    -D USE_GLPK:BOOL=ON \
 +
    -D GLPK_ROOT_DIR:PATH="/usr" \
 +
    -D CMAKE_BUILD_TYPE:STRING=Release \
 +
    -D CMAKE_VERBOSE_MAKEFILE:BOOL=TRUE \
 +
    -D CFLAGS="-pthread" FCFLAGS="-pthread" CXXFLAGS="-pthread" \
 +
    ..
 +
</pre>
 +
 +
Then, build
 +
 +
  make
 +
 +
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.

Latest revision as of 15:10, 9 May 2019

Building GridPACK is relatively straightforward on Debian 9 (stretch) systems. At the time of writing, Debian 9 was the current stable distribution. There is no need to build any prerequisite software. All can be installed from Debian package repositories. This documents a GridPACK build on Debian 9 (stretch) installed on a VirtualBox virtual machine (VM) using the complete installation image. Virtual Box is not required and this build should work on Linux systems using the Debian operating system.

System Preparation

You will need super user or sudo privileges for this installation. You will not be able to edit files /etc/apt/sources.list or use utilities such as apt-get without them. Here, the sudo command is used to perform super user activities. This command was installed automatically in this case. Your system may be different as it was in at least one other case.

Starting with a clean installation, add contrib and non-free components of the Debian distribution to apt sources (ParMETIS is in non-free). Edit /etc/apt/sources.list and make the main repository line look like this: 

deb http://ftp.us.debian.org/debian/ stretch main contrib non-free
deb-src http://ftp.us.debian.org/debian/ stretch main contrib non-free

It may be necessary to change the file permissions before editing: 

sudo chmod +w /etc/apt/sources.list

Refresh the system package lists with 

sudo apt-get update

Prerequisite Installation

General

Install a C++ compiler, CMake, and Git: 

sudo apt-get install git cmake g++

Boost

Install necessary Boost libraries: 

sudo apt-get install libboost-dev libboost-mpi-dev \
   libboost-random-dev libboost-filesystem-dev libboost-system-dev

This will also install the default MPI implementation (OpenMPI), including compiler wrappers.

PETSc

Install the real-valued version of PETSc with 

sudo apt-get install petsc-dev

or the complex-valued version with 

sudo apt-get install libpetsc3.7.5-dev

Global Arrays

Global Arrays has lots of dependencies. Unfortunately, installing the Debian GA package (version 5.4~beta~r10636+dfsg-5) does not enforce any of them. Installing PETSc first will install most of them. This should complete the GA installation: 

sudo apt-get install libglobalarrays-dev libarmci-mpi-dev

ParMETIS

Install ParMETIS using 

sudo apt-get install libparmetis-dev libmetis-dev

GNU Linear Programming Kit

GLPK is optional and can be installed with 

sudo apt-get install libglpk-dev

GridPACK Configuration and Build

Obtain the GridPACK release or development code and put it in a convenient directory, like $HOME/gridpack/src. The top level GridPACK directory is denoted below by the variable $GRIDPACK.

It is a good idea to build GridPACK in a separate directory under the GridPACK source tree. The example below assumes that a directory called build has been created under $GRIDPACK/src and that you have cd'd into this directory: 

 cd $GRIDPACK/src
 mkdir build
 cd build

Configure GridPACK as follows 

CC=gcc
CXX=g++
CFLAGS=-pthread
CXXFLAGS=-pthread
export CC CXX CFLAGS CXXFLAGS

cmake \
    -D PETSC_DIR:STRING="/usr/lib/petsc" \
    -D PARMETIS_DIR:PATH="/usr" \
    -D GA_EXTRA_LIBS:STRING="-lscalapack-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=30 \
    -D USE_GLPK:BOOL=ON \
    -D GLPK_ROOT_DIR:PATH="/usr" \
    -D CMAKE_BUILD_TYPE:STRING=Release \
    -D CMAKE_VERBOSE_MAKEFILE:BOOL=TRUE \
    -D CFLAGS="-pthread" FCFLAGS="-pthread" CXXFLAGS="-pthread" \
    ..

Then, build 

  make

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

Retrieved from "https://gridpack.pnnl.gov/wiki/index.php?title=Building_on_Debian&oldid=3944"