SMART-UQ

(Strathclyde Mechanical and Aerospace Research Toolbox for Uncertainty Quantification)

======================================================================

SMART is a collection of toolboxes developed and maintained since 2015 by the Department of Mechanical & Aerospace Engineering at the University of Strathclyde in Scotland. SMART-UQ in particular is a collection of uncertainity quantification techniques.

SMART is aimed at making code development inside the Centre more efficient, reusable and easy maintainabile.

SMART is CMake-based C++ project. It can be used as the basis for new projects.

Features

• General directory structure common to C++ projects
• Example of CMake module
• Testing framework (Catch)
• Install script (make install)
• CPack script for packaging (make package)
• Automatic API documentation (Doxygen)
• Continuous Integration (Travis CI) (PENDING)
• Example of how to include external dependencies (using ExternalProject module)

Requirements

To install this project, please ensure that you have installed the following (installation guides are provided on the respective websites):

• Git
• A C++ compiler, e.g., GCC, clang, MinGW
• CMake
• Doxygen (optional)

SMART-UQ does not depend on any libraries, at the stage. The following library is optional (see Build options):

• CATCH (unit testing library necessary for BUILD_TESTS build option) This dependency will be downloaded and configured automagically if not already present locally (requires an internet connection).
• FFTW3 (This library is necessary for DCT-based multiplication of polynomials in Chebyshev basis. DCT-based multiplication is the default behaviour of operator * for Chebyshev_Polynomial in smart-uq, since it is generally faster than direct multiplication (which is also available as a function). For DCT-based multiplication to work, the library needs to be installed three times: regularly (for double precision), compiled with the --enable-float flag and compiled with the --enable-long-double flag. If any of these installs is missing, operator * between Chebyshev_Polynomial objects will perform direct multiplication.

Installation

Run the following commands to download, build, and install this project.

git clone https://github.com/space-art/smart-uq.git
(Enter your username and password)
cd smart-uq
mkdir build && cd build
cmake .. && make

To install the header files, run the following from within the build directory:

make install

Note that dependencies are installed by fetching them online, in case they cannot be detected on your local system. If the build process fails, check the error log given. Typically, building fails due to timeout. Simply run the cmake --build . command once more.

Build options

You can pass the following, general command-line options when running CMake:

• -DCMAKE_INSTALL_PREFIX[=$install_dir]: set path prefix for install script (make install); if not set, defaults to usual locations
• -DBUILD_SHARED_LIBS=[on|off (default)]: build shared libraries instead of static
• -DBUILD_MAIN[=on|off (default)]: build the main-function
• -DBUILD_DOCS[=ON|OFF (default)]: build the Doxygen documentation (LaTeX must be installed with amsmath package)
• -DBUILD_TESTS[=ON|OFF (default)]: build tests (execute tests from build-directory using ctest -V)
• -DBUILD_DEPENDENCIES[=ON|OFF (default)]: force local build of dependencies, instead of first searching system-wide using find_package()

The following command is conditional and can only be set if BUILD_TESTS = ON:

requires GCC compiler; execute coverage analysis from build-directory using make coverage)

Pass these options either directly to the cmake .. build command or run ccmake .. instead to bring up the interface that can be used to toggle options.

Contributing

Once you've made your great commits:

1. Fork smart-uq
2. Create a topic branch - git checkout -b my_branch
3. Push to your branch - git push origin my_branch
4. Create a Pull Request from your branch
5. That's it!

Disclaimer

The copyright holders are not liable for any damage(s) incurred due to improper use of smart-uq.

To do

• Unit tests :)