Difference between revisions of "Building on Ubuntu"

From GridPACK
Jump to: navigation, search
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
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)]. If you have no need to modify the GridPACK library itself, consider [[Ubuntu_Installation| installing the binary package]].  
+
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>.
  
 
A few basic development packages will be necessary. Install them with
 
A few basic development packages will be necessary. Install them with
Line 5: Line 5:
 
<pre>sudo apt-get install git build-essential devscripts equivs</pre>
 
<pre>sudo apt-get install git build-essential devscripts equivs</pre>
  
== Obtain GridPACK Source ==
 
  
'''''At the time of writing (1/5/2018), these instructions only work with the Github repository code. These instructions will not work with the most recent official release (3.1).'''''
+
== Install Required Packages ==
  
In a convenient location, clone the GridPACK repository
+
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]].
  
<pre>git clone https://github.com/GridOPTICS/GridPACK.git
+
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:
cd GridPACK
 
git submodule update --init</pre>
 
 
 
 
 
 
 
== Install Required Packages ==
 
 
 
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 cloned repository:
 
  
 
<pre>sudo mk-build-deps -i</pre>
 
<pre>sudo mk-build-deps -i</pre>
Line 29: Line 20:
 
== Build and Test GridPACK ==
 
== Build and Test GridPACK ==
  
Configure and build GridPACK using the recipe for <code>gridpackvm</code> in <code>example_configuration.sh</code>:
+
 
 +
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:
  
 
<pre>mkdir src/build
 
<pre>mkdir src/build
Line 52: Line 44:
 
     -D MPIEXEC:STRING=&quot;mpiexec&quot; \
 
     -D MPIEXEC:STRING=&quot;mpiexec&quot; \
 
     -D MPIEXEC_MAX_NUMPROCS:STRING=&quot;2&quot; \
 
     -D MPIEXEC_MAX_NUMPROCS:STRING=&quot;2&quot; \
     -D GRIDPACK_TEST_TIMEOUT:STRING=20 \
+
     -D GRIDPACK_TEST_TIMEOUT:STRING=60 \
 
     -D USE_GLPK:BOOL=ON \
 
     -D USE_GLPK:BOOL=ON \
 
     -D GLPK_ROOT_DIR:PATH=&quot;/usr&quot; \
 
     -D GLPK_ROOT_DIR:PATH=&quot;/usr&quot; \
Line 58: Line 50:
 
     -D CMAKE_INSTALL_PREFIX:PATH=&quot;$HOME/gridpack&quot; \
 
     -D CMAKE_INSTALL_PREFIX:PATH=&quot;$HOME/gridpack&quot; \
 
     -D CMAKE_VERBOSE_MAKEFILE:BOOL=TRUE \
 
     -D CMAKE_VERBOSE_MAKEFILE:BOOL=TRUE \
     ..</pre>
+
     ..
 
+
make</pre>
Build and test GridPACK normally:
 
  
<pre>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. 
make test</pre>
 
  
 
== Removing Required Software ==
 
== Removing Required Software ==

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