Skip to content

Latest commit

 

History

History
217 lines (175 loc) · 8.89 KB

BASIC_INSTALL.md

File metadata and controls

217 lines (175 loc) · 8.89 KB

GridPACK step=by-step installation instructions

This document provides a step-by-step guide to install GridPACK and its dependencies. They are meant to be used with GridPACK's develop branch. The installation instructions have been tested on Linux, MacOS, and Ubuntu.

Prerequisite software

Before building GridPACK using these instructions, you will need to make sure that

  • CMake is available on your system (version newer than 3.5.0)
  • you have a GNU compiler installed,
  • you will also need to have MPI installed on your platform. Most clusters already have MPI available, but if you are building GridPACK on a workstation or a virtual machine, you may need to install or build MPI on your own. More information on configuring your Linux platform can be found here.

Submodule(s)

If building a verions of GridPACK that has been cloned directly from the Github repository, it is first necessary to download some submodules. This can be done by running the following command in the top-level GridPACK directory.

git submodule update --init

Detailed installation instructions

The instructions below install GridPACK and all its dependencies. If the dependencies are already installed then one can directly go to step 4.

Step 1: Install Boost 1.78.0

Step 1.1 Download boost 1.78.0

wget https://boostorg.jfrog.io/artifactory/main/release/1.78.0/source/boost_1_78_0.tar.gz

Step 1.2. Untar file

tar -xvf boost_1_78_0.tar.gz

Step 1.3. cd boost_1_78_0

Step 1.4. Build Boost with the needed libraries and set the installation directory. Here, we'll use install_for_gridpack as the installation directory.

./bootstrap.sh --prefix=install_for_gridpack --with-libraries=mpi,serialization,random,filesystem,system

Step 1.5. Edit project-config.jam file and add a line to it with the text using mpi ;

Step 1.6. Install Boost. This is done by the following two commands

./b2 -a -d+2 link=static stage

and

./b2 -a -d+2 link=static install

Note: To build shared libraries for Boost, use the flag link=shared instead of link=static.

Step 1.7. If boost installation goes through correctly, then you should see include and lib subdirectories in your installation directory install_for_gridpack

If you run into difficulties more information on building and installing Boost can be found here

Step 2: Install Global arrays

Step 2.1. Download GA-5.8

wget https://github.com/GlobalArrays/ga/releases/download/v5.8/ga-5.8.tar.gz

Step 2.2. Untar file

tar -xvf ga-5.8.tar.gz

Step 2.3. cd ga-5.8

Step 2.4. Configure ga and set the installation directory

./configure --with-mpi-ts --disable-f77 --without-blas --enable-cxx --enable-i4 --prefix=${PWD}/install_for_gridpack

Note: To build shared libraries for GA, add the flag --enable-shared

Step 2.5. Compile GA and install

make -j 10 install

Step 2.6. If the compilation succeeds, include, lib, and bin directories should be created in your installation directory ${PWD}/install_for_gridpack

More information on building and installing GA can be found here

Step 3: Install PETSc 3.16.4

Step 3.1. Download PETSc release

git clone https://gitlab.com/petsc/petsc.git

Step 3.2.

cd petsc
git checkout v3.16.4

Step 3.3. Set environment variables needed for PETSc

export PETSC_DIR=${PWD}
export PETSC_ARCH=build-dir

Step 3.4. Build PETSc. GridPACK needs a few other libraries installed with PETSc. We'll install them during configure stage of PETSc.

./configure --download-superlu_dist --download-metis --download-parmetis --download-suitesparse --download-f2cblaslapack --download-cmake --prefix=${PWD}/install_for_gridpack

Note: To build shared libraries for PETSc, add the flag --with-shared-libraries=1

Note: --download-f2cblaslapack and --download-cmake is not required if the system has a functional BLAS/LAPACK compatible with PETSc, and the CMake version is 3.18.1 or higher. On EIOC-Ubuntu8 you'll need to add both these configuration options.

This step will take a few minutes.

Step 3.5. Once the configuration is complete, run the following commands to compile and test PETSc

make
make install
make check

Step 3.6. Once PETSc installation is complete and all tests pass after running make check, you'll see three directories include, lib, and bin under the installation directory ${PWD}/install_for_gridpack

More information on building and installing PETSc can be found here. In the unlikely event that PETSc cannot download and build ParMETIS, more information of building this library can be found here.

Step 4: Install GridPACK

Now that we have installed the needed dependencies, we can proceed with downloading and installing GridPACK.

Step 4.1. Download GridPACK

git clone https://github.com/GridOPTICS/GridPACK.git

Step 4.2. cd GridPACK/src

Step 4.3. Change branch to develop

git checkout develop

Step 4.4. Create build directory mkdir build, and cd to it - cd build

Step 4.5. Copy the following GridPACK configuration commands to a file (name it for e.g. build.sh)

rm -rf CMake*                                                                               
cmake \                                                                                     
   -D GA_DIR:STRING="/home/abhy245/software/ga-5.8/install_for_gridpack" \                
   -D BOOST_ROOT:STRING="/home/abhy245/software/boost_1_78_0/install_for_gridpack" \    
     -D Boost_DIR:STRING="/home/abhy245/software/boost_1_78_0/install_for_gridpack/lib/cmake/Boost-1.78.0" \   
   -D BOOST_LIBRARYDIR:STRING="/home/abhy245/software/boost_1_78_0/build/lib"\   
   -D PETSC_DIR:PATH="/home/abhy245/software/petsc/install_for_gridpack" \                  
   -D MPI_CXX_COMPILER:STRING='mpicxx' \     
   -D MPI_C_COMPILER:STRING='mpicc' \                                         
   -D MPIEXEC:STRING='mpiexec' \                                                            
   -D GRIDPACK_TEST_TIMEOUT:STRING=30 \                                                     
   -D CMAKE_INSTALL_PREFIX:PATH="/home/abhy245/software/GridPACK/src/install" \             
   -D CMAKE_BUILD_TYPE:STRING=Debug \                                                       
    ..

Note: To build shared libraries, add -D BUILD_SHARED_LIBS=YES to the abovve commands.

Note: Change the paths for GA_DIR,BOOST_DIR,PETSC_DIR to point to the installation directories for GA, Boost, and PETSc, respectively.

Note: Change the path for CMAKE_INSTALL_PREFIX to your choice. This is the directory where GridPACK will be installed.

Note: If you do not use --prefix=${PWD}/install_for_gridpack flag for PETSc install then PETSc will write the installation files in $PETSC_DIR/$PETSC_ARCH. So, you'll need to add -D PETSC_ARCH=<PETSC_ARCH_NAME> to the above CMake commands.

Step 4.6. Make the file executable chmod +x build.sh

Step 4.7. Run build.sh

./build.sh

Step 4.8. Compile and install

make -j 10 install

During installation, you may see several warnings generated. This is typical of GridPACK install. You can ignore them.

Step 4.9. Test GridPACK install by running tests.

make test

You may perhaps see several of the tests failing. This is fine. We'll test in the next step whether the dynamics simulation application is running correctly.

Step 4.10. Test GridPACK install by running dynamics simulation

cd applications/dynamic_simulation_full_y
cp input_145.xml input.xml
./dsf.x

If the application runs smoothly then you should see the timing stats printed out after the run.

This completes the installation and testing of GridPACK