Skip to content

Latest commit

 

History

History
77 lines (60 loc) · 7.03 KB

installation.md

File metadata and controls

77 lines (60 loc) · 7.03 KB
Raw

#Installation guide

GridDyn is written in C++ and makes use of a few external libraries not included in the released source code.
External software packages needing installation prior to compilation of GridDyn include

  • Boost 1.61 for most parts of GridDyn Boost 1.58 or greater will be sufficient but going forward some part of GridDyn will be making use of libraries only found in 1.61 or higher. GridDyn currently compiles with Boost version >1.49.
  • SUNDIALS 2.6.2 (GridDyn will be updated to use the new version of SUNDIALS when it is released later in 2016 at which time that will become the required version)
  • KLU in the suitesparse package.
  • cmake for building
  • Doxygen for building in source documentation.
  • all other third party code is included in the release.

Boost can be downloaded from Boost many of the features in GridDyn will work with older versions but going forward we will be making use of some features from Boost 1.61 and will use that as the baseline going forward. SUNDIALS can downloaded at sundial the current version is 2.6.2 but will be upgraded to the new version when it is released in the near future. SUNDIALS should be built with KLU support enabled for reasonable performance. KLU is part of SuiteSparse on most Linux type systems it can be installed as a package, on Windows cmake files can be found at KLU.

GridDyn uses a cmake build system to construct buid files for whatever platform you happen to be on (assuming it is supported by cmake)
GridDyn uses C++11 extensively and will make use of some C++14 features in the near future. Therefore, required future compilers are

  • Visual Studio 2015
  • gcc 4.9.3 or higher (4.8 works for the moment but will not in near future updates)
  • clang 3.5 or higher (openMP must be turned off to use 3.4)
  • Intel 16.0 (not thoroughly tested as of yet)

At present GridDyn will likely compile on gcc 4.8 and visual studio 2013 but that is expected to change with future updates.
#cmake options

  • BOOST_ROOT if boost is not found in the system directories or a different version is desired the root location of boost can be specified in BOOST_ROOT
  • BUILD_SERVERMODE the servermode for GridDyn is a work in progress, it is recommended that this option be disabled pending further progress
  • DEBUG_LOG_ENABLE unselecting disables all DEBUG and TRACE log messages from getting compiled
  • TRACE_LOG_ENABLE unselecting disables all TRACE log messages from getting compiled
  • DOXYGEN_OUTPUT_DIR location for the generated doxygen documentation
  • ENABLE_64BIT_INDEXING select if you want support inside GridDyn for more than $2^{32}-2$ states or objects (I find this unlikely at this time)
  • ENABLE_EXPERIMENTAL_TEST_CASES select to enable some experiemental test cases in the test suite
  • FMI_ENABLE enable experiemental support for FMI objects. This is in development, recommended to leave unselected unless you are developing
  • FSKIT_ENABLE enable to build additional libraries and support for integration into FSKIT and PARGRID for tool coupling
  • GRIDDYN_GENERATE_DOXYGEN_DOC select to create a case to build the doxygen docs
  • GRIDDYN_OPENMP (doesn't do any thing yet) eventually it will enable openMP in the GridDyn evaluation functions
  • KLU_ENABLE this option may be removed in the future recommended to leave selected otherwise KLU support will not be built in
  • KLU_INSTALL_DIR point to the installation dir for KLU if it was not found in the system directories
  • LOAD_ARKODE build in support for ARKODE for solving differential equations
  • LOAD_CVODE build in support for CVODE for solving differential equations Neither cvode or arkode are used at present but will be in the near future
  • LOAD_EXTRA_MODELS select to build an additional library containing a few optional models-more will likely be added in the future
  • LOG_ENABLE unselect to turn off all logging functions
  • MPI_ENABLE select to build with MPI support using an MPI compatible compiler
  • OPENMP_ENABLE option to build in support for openMP in both the solvers and in GridDyn
  • OPTIMIZATION_ENABLE enable building of the optimization extension. This is a work in progress and doesn't do much yet, recommended to leave unselected unless you are developing on that section.
  • SUNDIALS_INSTALLATION_DIR point to the installation location for SUNDIALS
  • SUNDIALS_OPENMP select to enable OpenMP in SUNDIALS assumes SUNDIALS was built with openmp support
  • TEST_ENABLE enable building of the testSuites
  • THREAD_ENABLE not used at preset but will eventually enable threaded execution in some models

#installation notes ##mac Example of successful build on a mac OS X GridDyn on Mac OS X

1. Install MacPorts
2. Install cmake port
3.	Download [SuiteSparse 4.2.1](http://faculty.cse.tamu.edu/davis/suitesparse.html)
4. Build/install SuiteSparse
5. Download [SUNDIALS 2.6.2](http://computation.llnl.gov/projects/SUNDIALS-suite-nonlinear-differential-algebraic-equation-solvers/download/SUNDIALS-2.6.2.tar.gz) you may have submit some information first- don't build dynamic libs because they caused issue with GridDyn runtime
6. Configure/build/install SUNDIALS (cd SUNDIALS-2.6.2; mkdir build; ccmake ..; update paths for your install location (prefix, klu lib and include dirs), set KLU\_ENABLE to ON); make; make install)
7. Download/configure/build/install BOOST 
8. Configure GridDyn (cd transmission; mkdir build; cd build; ccmake -DKLU\_DIR=$<\hdots>$ -DBoost\_INCLUDE\_DIR=$<\hdots>$ -DBoost\_LIBRARY\_DIRS=$<\hdots>$; ) or use cmake-gui

##Linux Depending on the distribution, Boost or an updated version of it may need to be installed. SUNDIALS and KLU may need to be installed as well. Typically camke is used to generate makefiles thought it has been used to generate Eclipse projects. BOOST_ROOT, SUNDIALS_INSTALLATION_DIR, and KLU_INSTALL_DIR may need to be user specified if they are not in the system directories. This can be done in the cmake-gui or through the command line tools. Them running make will complile the program.
Running make install will copy the executables and libraries to the install directory.

##Windows GridDyn has been successfully built with Visual Studio 2015 and on Msys2. The msys2 build is much like building on linux. This works fine with gcc, the current clang version on msys2 has library incompatibilities with some of the boost libraries due to changes in gcc. I don't fully follow what the exact issue is on but clang won't work on Msys2 to compile GridDyn unless SUNDIALS, boost, and KLU are compiled with the same compiler, I suspect the same issue is also present in some other linux platforms that use gcc 5.0 or greater as the default compiler. The suitesparse version available through pacman on msys2 seems to work fine.

For compilation with Visual Studio boost will need to built with the same version as is used to compile GridDyn. Otherwise follow the same instructions.