pax_global_header00006660000000000000000000000064137545522400014521gustar00rootroot0000000000000052 comment=4d67b8a3d04b92639324b6d7a6beedaf4f373add tiledarray-1.0.0/000077500000000000000000000000001375455224000136575ustar00rootroot00000000000000tiledarray-1.0.0/.clang-format000066400000000000000000000055661375455224000162460ustar00rootroot00000000000000--- Language: Cpp # BasedOnStyle: Google AccessModifierOffset: -1 AlignAfterOpenBracket: Align AlignConsecutiveAssignments: false AlignConsecutiveDeclarations: false AlignEscapedNewlines: Left AlignOperands: true AlignTrailingComments: true AllowAllParametersOfDeclarationOnNextLine: true AllowShortBlocksOnASingleLine: false AllowShortCaseLabelsOnASingleLine: false AllowShortFunctionsOnASingleLine: All AllowShortIfStatementsOnASingleLine: true AllowShortLoopsOnASingleLine: true AlwaysBreakAfterDefinitionReturnType: None AlwaysBreakAfterReturnType: None AlwaysBreakBeforeMultilineStrings: true AlwaysBreakTemplateDeclarations: true BinPackArguments: true BinPackParameters: true BraceWrapping: AfterClass: false AfterControlStatement: false AfterEnum: false AfterFunction: false AfterNamespace: false AfterObjCDeclaration: false AfterStruct: false AfterUnion: false BeforeCatch: false BeforeElse: false IndentBraces: false BreakBeforeBinaryOperators: None BreakBeforeBraces: Attach BreakBeforeInheritanceComma: false BreakBeforeTernaryOperators: true BreakConstructorInitializersBeforeComma: false BreakConstructorInitializers: BeforeColon BreakAfterJavaFieldAnnotations: false BreakStringLiterals: true ColumnLimit: 80 CommentPragmas: '^ IWYU pragma:' CompactNamespaces: false ConstructorInitializerAllOnOneLineOrOnePerLine: true ConstructorInitializerIndentWidth: 4 ContinuationIndentWidth: 4 Cpp11BracedListStyle: true DerivePointerAlignment: true DisableFormat: false ExperimentalAutoDetectBinPacking: false FixNamespaceComments: true ForEachMacros: [ foreach, Q_FOREACH, BOOST_FOREACH ] IncludeCategories: - Regex: '^<.*\.h>' Priority: 1 - Regex: '^<.*' Priority: 2 - Regex: '.*' Priority: 3 IncludeIsMainRegex: '([-_](test|unittest))?$' IndentCaseLabels: true IndentWidth: 2 IndentWrappedFunctionNames: false JavaScriptQuotes: Leave JavaScriptWrapImports: true KeepEmptyLinesAtTheStartOfBlocks: false MacroBlockBegin: '' MacroBlockEnd: '' MaxEmptyLinesToKeep: 1 NamespaceIndentation: None ObjCBlockIndentWidth: 2 ObjCSpaceAfterProperty: false ObjCSpaceBeforeProtocolList: false PenaltyBreakAssignment: 2 PenaltyBreakBeforeFirstCallParameter: 1 PenaltyBreakComment: 300 PenaltyBreakFirstLessLess: 120 PenaltyBreakString: 1000 PenaltyExcessCharacter: 1000000 PenaltyReturnTypeOnItsOwnLine: 200 PointerAlignment: Left ReflowComments: true SortIncludes: true SpaceAfterCStyleCast: false SpaceAfterTemplateKeyword: true SpaceBeforeAssignmentOperators: true SpaceBeforeParens: ControlStatements SpaceInEmptyParentheses: false SpacesBeforeTrailingComments: 2 SpacesInAngles: false SpacesInContainerLiterals: true SpacesInCStyleCastParentheses: false SpacesInParentheses: false SpacesInSquareBrackets: false Standard: Auto TabWidth: 8 UseTab: Never ... tiledarray-1.0.0/.codecov.yml000066400000000000000000000004011375455224000160750ustar00rootroot00000000000000 # Team Yaml codecov: token: 61cfdbc8-5e68-415c-990b-5593eae1be3f coverage: round: down precision: 5 # Repository Yaml coverage: round: up range: 0..10 # Used in Codecov after updating coverage: round: up range: 0..10 precision: 5 ignore: tiledarray-1.0.0/.pre-commit-config.yaml000066400000000000000000000036531375455224000201470ustar00rootroot00000000000000# See https://pre-commit.com for more information # See https://pre-commit.com/hooks.html for more hooks repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v2.4.0 hooks: - id: check-added-large-files - id: check-case-conflict - id: check-merge-conflict # - id: check-yaml ... both .codecov and .travis contain duplicate keys - id: end-of-file-fixer - repo: https://github.com/Lucas-C/pre-commit-hooks rev: v1.1.7 hooks: - id: remove-crlf - id: forbid-tabs # MPQC output and JS/XML/CSS/CMake can contain tabs exclude: \.(out|cmake|js|xml|css)$ # see https://github.com/Lucas-C/pre-commit-hooks#forbid--remove-some-unicode-characters - repo: local hooks: - id: forbid-unicode-non-breaking-spaces name: Detect unicode non-breaking space character U+00A0 aka M-BM- language: system entry: perl -ne 'print if $m = /\xc2\xa0/; $t ||= $m; END{{exit $t}}' files: '' - id: forbid-en-dashes name: Detect the EXTREMELY confusing unicode character U+2013 language: system entry: perl -ne 'print if $m = /\xe2\x80\x93/; $t ||= $m; END{{exit $t}}' files: '' - id: dependency-version-update name: Updates versions of dependencies language: system files: versions\.cmake$ entry: bin/admin/dependency-versions-update-hook.py - id: clang-format name: Format C/C++ code using clang-format. language: system files: \.(c|cc|cxx|cpp|h|hpp|hxx)$ entry: clang-format -i args: [--style=file] additional_dependencies: [clang-format] tiledarray-1.0.0/.travis.yml000066400000000000000000000117111375455224000157710ustar00rootroot00000000000000# See http://about.travis-ci.org/docs/user/build-configuration/ # To validate this file: http://lint.travis-ci.org/ language: cpp dist: bionic cache: ccache cache: directories: - /home/travis/_install os: linux addons: apt: packages: &base_packages - libboost-all-dev - libblas-dev - liblapack-dev - liblapacke-dev - libtbb-dev - lcov - python3 - python3-pip - python3-pytest - python3-numpy env: global: - BUILD_PREFIX=/home/travis/_build - INSTALL_PREFIX=/home/travis/_install matrix: fast_finish: true include: - compiler: gcc env: GCC_VERSION=7 BUILD_TYPE=Debug addons: apt: packages: - *base_packages - g++-7 - gfortran-7 - compiler: gcc env: GCC_VERSION=7 BUILD_TYPE=Release addons: apt: packages: - *base_packages - g++-7 - gfortran-7 - compiler: gcc env: GCC_VERSION=8 BUILD_TYPE=Debug COMPUTE_COVERAGE=1 addons: apt: packages: - *base_packages - g++-8 - gfortran-8 - compiler: gcc env: GCC_VERSION=8 BUILD_TYPE=Release addons: apt: packages: - *base_packages - g++-8 - gfortran-8 - compiler: gcc env: GCC_VERSION=9 BUILD_TYPE=Debug addons: apt: sources: - sourceline: 'ppa:ubuntu-toolchain-r/test' packages: - *base_packages - g++-9 - gfortran-9 - compiler: gcc env: GCC_VERSION=9 BUILD_TYPE=Release addons: apt: sources: - sourceline: 'ppa:ubuntu-toolchain-r/test' packages: - *base_packages - g++-9 - gfortran-9 - compiler: clang env: CLANG_VERSION=8 GCC_VERSION=8 BUILD_TYPE=Debug addons: apt: packages: - *base_packages - g++-8 - gfortran-8 - clang-8 - libc++-8-dev - libc++abi-8-dev - compiler: clang env: CLANG_VERSION=8 GCC_VERSION=8 BUILD_TYPE=Release DEPLOY=1 addons: apt: packages: - *base_packages - g++-8 - gfortran-8 - clang-8 - libc++-8-dev - libc++abi-8-dev - graphviz # provides dot for doxygen graphs - fonts-liberation # recommended by graphviz - compiler: clang env: CLANG_VERSION=9 GCC_VERSION=8 BUILD_TYPE=Debug addons: apt: sources: - sourceline: 'deb http://apt.llvm.org/bionic/ llvm-toolchain-bionic-9 main' key_url: 'https://apt.llvm.org/llvm-snapshot.gpg.key' packages: - *base_packages - g++-8 - gfortran-8 - clang-9 - libc++-9-dev - libc++abi-9-dev - compiler: clang env: CLANG_VERSION=9 GCC_VERSION=8 BUILD_TYPE=Release addons: apt: sources: - sourceline: 'deb http://apt.llvm.org/bionic/ llvm-toolchain-bionic-9 main' key_url: 'https://apt.llvm.org/llvm-snapshot.gpg.key' packages: - *base_packages - g++-8 - gfortran-8 - clang-9 - libc++-9-dev - libc++abi-9-dev #notifications: # email: # recipients: # - @github.com # on_success: change # on_failure: always before_install: - env - mkdir -p ${BUILD_PREFIX} && mkdir -p ${INSTALL_PREFIX} # use timeout to stop long-running (i.e. cache-rebuilding) jobs right before they get killed by Travis-CI # in case of timeout report success to Travis to force cache upload script: - travis_wait 50 timeout 2200 ${TRAVIS_BUILD_DIR}/bin/build-$TRAVIS_OS_NAME.sh; RESULT=$?; if [ $RESULT -eq 0 ] || [ $RESULT -eq 124 ]; then true; else false; fi; after_failure: - cat ${BUILD_PREFIX}/TA/external/madness-build/CMakeFiles/CMakeError.log - cat ${BUILD_PREFIX}/TA/external/madness-build/CMakeFiles/CMakeOutput.log - cat ${BUILD_PREFIX}/TA/CMakeFiles/CMakeError.log - cat ${BUILD_PREFIX}/TA/CMakeFiles/CMakeOutput.log # codecov after_success: # create report - cd ${TRAVIS_BUILD_DIR} - if [ "$COMPUTE_COVERAGE" = "1" ]; then lcov --gcov-tool gcov-${GCC_VERSION} --directory ${BUILD_PREFIX}/TA --capture --output-file coverage.info; fi; # capture coverage info - if [ "$COMPUTE_COVERAGE" = "1" ]; then lcov --remove coverage.info '/usr/*' '*/madness/*' '*/btas/*' '*/tests/*' --output-file coverage.info; fi; # filter out non-project files - if [ "$COMPUTE_COVERAGE" = "1" ]; then lcov --list coverage.info; fi; #debug info - echo ${TRAVIS_CMD} # upload report to CodeCov - if [ "$COMPUTE_COVERAGE" = "1" ]; then bash <(curl -s https://codecov.io/bash) -t token; fi; # deploy artifacts: currently only dox - if [ "$DEPLOY" = "1" ]; then bash ${TRAVIS_BUILD_DIR}/bin/deploy-$TRAVIS_OS_NAME.sh; fi; tiledarray-1.0.0/CHANGES000066400000000000000000000051601375455224000146540ustar00rootroot00000000000000 TILEDARRAY REVISION HISTORY Following is a brief summary of changes made in each release of TiledArray. - 16-November-2020: 1.0.0 - resolved issue 77: negative indices are supported, use signed 1-index type by default (this brings TA::Range in sync with btas::RangeNd), to revert to legacy behavior configure with TA_SIGNED_1INDEX_TYPE=OFF (PR #214) - removed interface to Elemental (PR #201) - added Python interface (PR #198 and #212) - added interface to ScaLAPACK (PR #173) - added ability to fuse vector -> DistArray and extract subarray from the fused array (PR #160 and #162) - resolved boost check issue (PR #161) - revamped TA::foreach and improved conversions to be able to handle non-standard policies - C++17 is now prerequisite - CUDA 11 is now prerequisite for execution on NVIDIA GPUs; CMake 3.18 is required if CUDA is enabled - 07-June-2019: 1.0.0-alpha.2 - modernized CMake handling of CUDA, CMake 3.10 is now required - improved CMake handling of MADNESS arguments, e.g. gperftools - Pmaps no longer have to store O(N) data, and no existing Pmap does - 09-May-2019: 1.0.0-alpha.1 - first-class support for CUDA; requires Umpire [github.com/LLNL/Umpire] and cuTT [github.com/ValeevGroup/cutt fork of github.com/ap-hynninen/cutt], both can be installed automatically - better usability with BTAS tensors and hierarchical tiles (i.e. tensors of tensors) - disabled automatic conversion of multiply expressions into scalars - updates to support C++17 (but only C++14 is required) - resolved issues 145, 157 - bump to CMake 3.8 - 15-Feb-2018: 0.7.0 - MADNESS bump to 0.11.0, requires C++14 as the result - added interface to latest Elemental ('El') - resolved issues 96, 100, 101, 102, 104, 106, 107, 108, 110, 124 - significant API changes: - mixed-expressions branch is incorporated, it makes possible to implement operations on arrays of different types, e.g. sparse + dense = dense, etc. It also supports asynchronous tile conversion operators (i.e. returning Future rather than Tile) to support expensive/communicating conversions. - added expr.set_{world,shape,pmap}() to override the computed defaults; key application is to impose the sparsity on the result of an expression - TiledRange1::element2tile -> TiledRange1::element_to_tile for consistency with TiledRange - ArrayIiterator -> ArrayIterator - BTAS is a required dependence, automatically installed if missing - 27-Nov-2016: 0.6.0 - block expression code - DSL extensions to "force" shape, world, and pmap - minor API improvements and bug fixes. tiledarray-1.0.0/CMakeLists.txt000066400000000000000000000406741375455224000164320ustar00rootroot00000000000000#; -*-CMake-*- # # This file is a part of TiledArray. # Copyright (C) 2013 Virginia Tech # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . # # Justus Calvin # Department of Chemistry, Virginia Tech # # CMakeLists.txt # Jul 19, 2013 # cmake_minimum_required (VERSION 3.15.0) # need list(PREPEND for toolchains ############################################################################### # Bring ValeevGroup cmake toolkit ############################################################################### include(FetchContent) FetchContent_Populate( vg_cmake_kit QUIET GIT_REPOSITORY https://github.com/ValeevGroup/kit-cmake.git SOURCE_DIR ${CMAKE_CURRENT_BINARY_DIR}/cmake/vg BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR}/cmake/vg-build SUBBUILD_DIR ${CMAKE_CURRENT_BINARY_DIR}/cmake/vg-subbuild ) project (TiledArray LANGUAGES) enable_language(CXX) # Set TiledArray version ======================================================= # see https://semver.org/ set(TILEDARRAY_MAJOR_VERSION 1) set(TILEDARRAY_MINOR_VERSION 0) set(TILEDARRAY_MICRO_VERSION 0) set(TILEDARRAY_PRERELEASE_ID alpha.3) set(TILEDARRAY_VERSION "${TILEDARRAY_MAJOR_VERSION}.${TILEDARRAY_MINOR_VERSION}.${TILEDARRAY_MICRO_VERSION}") if (TILEDARRAY_PRERELEASE_ID) set(TILEDARRAY_EXT_VERSION "${TILEDARRAY_VERSION}-${TILEDARRAY_PRERELEASE_ID}") else(TILEDARRAY_PRERELEASE_ID) set(TILEDARRAY_EXT_VERSION "${TILEDARRAY_VERSION}") endif(TILEDARRAY_PRERELEASE_ID) # Set install paths ============================================================ set(TILEDARRAY_INSTALL_BINDIR "bin" CACHE PATH "TiledArray binary install directory") set(TILEDARRAY_INSTALL_INCLUDEDIR "include" CACHE PATH "TiledArray INCLUDE install directory") set(TILEDARRAY_INSTALL_LIBDIR "lib" CACHE PATH "TiledArray LIB install directory") set(TILEDARRAY_INSTALL_SHAREDIR "share/tiledarray/${TILEDARRAY_EXT_VERSION}" CACHE PATH "TiledArray DATA install directory") set(TILEDARRAY_INSTALL_DATADIR "${TILEDARRAY_INSTALL_SHAREDIR}/data" CACHE PATH "TiledArray DATA install directory") set(TILEDARRAY_INSTALL_DOCDIR "${TILEDARRAY_INSTALL_SHAREDIR}/doc" CACHE PATH "TiledArray DOC install directory") set(TILEDARRAY_INSTALL_CMAKEDIR "lib/cmake/tiledarray" CACHE PATH "TiledArray CMAKE install directory") # Add module directory and modules ============================================= list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake/modules/) include(CMakePushCheckState) include(GNUInstallDirs) include(AppendFlags) include(RedefaultableOption) include(DetectMADNESSConfig) include(AddCustomTargetSubproject) include(AddTAExecutable) include(FindPackageRegimport) init_package_regimport() include(LoadFetchContent) # Load extra CMake features ==================================================== include(CMakeDependentOption) include(CMakePackageConfigHelpers) include(FeatureSummary) # Preload versions/tags of all dependencies ==================================== include(external/versions.cmake) # Configure options ======================================================= option(ENABLE_MPI "Enable MPI" ON) add_feature_info(MPI ENABLE_MPI "Message-Passing Interface supports distributed-memory parallel programs") option(ENABLE_SCALAPACK "Enable ScaLAPACK Bindings in TiledArray" OFF) add_feature_info(ScaLAPACK ENABLE_SCALAPACK "ScaLAPACK provides distributed linear algebra") redefaultable_option(ENABLE_MKL "Enable use of MKL (info passed to MADNESS)" ON) add_feature_info(MKL ENABLE_MKL "Intel Math Kernel Library provides linear algebra and other math functionality") redefaultable_option(ENABLE_TBB "Enable use of TBB with MADNESS" OFF) add_feature_info(TBB ENABLE_TBB "Intel Thread-Building Blocks (TBB) supports programming shared-memory systems") option(ENABLE_CUDA "Enable use of CUDA with TiledArray" OFF) add_feature_info(CUDA ENABLE_CUDA "NVIDIA CUDA support for GPU") if(ENABLE_CUDA) option(ENABLE_CUDA_ERROR_CHECK "TiledArray will always check errors in CUDA calls" ON) add_feature_info(CUDA_ERROR_CHECK ENABLE_CUDA_ERROR_CHECK "Checks CUDA Error") endif() option(ENABLE_GPERFTOOLS "Enable linking with Gperftools" OFF) add_feature_info(GPERFTOOLS ENABLE_GPERFTOOLS "Google Performance Tools provide fast memory allocation and performance profiling") option(ENABLE_TCMALLOC_MINIMAL "Enable linking with tcmalloc_minimal" OFF) if((ENABLE_GPERFTOOLS OR ENABLE_TCMALLOC_MINIMAL) AND CMAKE_SYSTEM_NAME MATCHES "Linux") set(ENABLE_LIBUNWIND ON) add_feature_info(Libunwind ENABLE_LIBUNWIND "Libunwind provides stack unwinding") endif() option(TA_BUILD_UNITTEST "Causes building TiledArray unit tests" OFF) option(TA_EXPERT "TiledArray Expert mode: disables automatically downloading or building dependencies" OFF) option(TA_SIGNED_1INDEX_TYPE "Enables the use of signed 1-index coordinate type (OFF in 1.0.0-alpha.2 and older)" ON) add_feature_info(SIGNED_1INDEX_TYPE TA_SIGNED_1INDEX_TYPE "Use of signed 1-index coordinate type in TiledArray") option(TA_TRACE_TASKS "Enable debug tracing of MADNESS tasks in (some components of) TiledArray" OFF) add_feature_info(TASK_TRACE_DEBUG TA_TRACE_TASKS "Debug tracing of MADNESS tasks in (some components of) TiledArray") set(TILEDARRAY_ENABLE_TASK_DEBUG_TRACE ${TA_TRACE_TASKS}) option(TA_ENABLE_TILE_OPS_LOGGING "Enable logging of (some) TiledArray tile ops" OFF) add_feature_info(TILE_OPS_LOGGING TA_ENABLE_TILE_OPS_LOGGING "Debug logging of TiledArray tile ops") if(TA_ENABLE_TILE_OPS_LOGGING AND NOT DEFINED TA_TILE_OPS_LOG_LEVEL) set(TA_TILE_OPS_LOG_LEVEL 1) endif(TA_ENABLE_TILE_OPS_LOGGING AND NOT DEFINED TA_TILE_OPS_LOG_LEVEL) option(TA_ENABLE_RANGEV3 "Enable Range-V3 library" OFF) add_feature_info(ENABLE_RANGEV3 TA_ENABLE_RANGEV3 "Range-V3 ranges library") # Enable shared library support options redefaultable_option(TA_ASSUMES_ASLR_DISABLED "TiledArray assumes the Address Space Layout Randomization (ASLR) to be disabled" OFF) add_feature_info(ASSUMES_ASLR_DISABLED TA_ASSUMES_ASLR_DISABLED "TiledArray assumes the Address Space Layout Randomization (ASLR) to be disabled") get_property(SUPPORTS_SHARED GLOBAL PROPERTY TARGET_SUPPORTS_SHARED_LIBS) if (SUPPORTS_SHARED AND TA_ASSUMES_ASLR_DISABLED) set(default_BUILD_SHARED_LIBS ON) else () set(default_BUILD_SHARED_LIBS OFF) endif() redefaultable_option(BUILD_SHARED_LIBS "Enable shared libraries" ${default_BUILD_SHARED_LIBS}) if (BUILD_SHARED_LIBS OR (NOT ${TA_ASSUMES_ASLR_DISABLED})) set(default_CMAKE_POSITION_INDEPENDENT_CODE ON) else () set(default_CMAKE_POSITION_INDEPENDENT_CODE OFF) endif() redefaultable_option(CMAKE_POSITION_INDEPENDENT_CODE "Default value for POSITION_INDEPENDENT_CODE of targets" ${default_CMAKE_POSITION_INDEPENDENT_CODE}) if(BUILD_SHARED_LIBS) set(BLA_STATIC FALSE CACHE BOOL "Whether to use static linkage for BLAS, LAPACK, and related libraries") set(CMAKE_MACOSX_RPATH TRUE) else() set(BLA_STATIC TRUE CACHE BOOL "Whether to use static linkage for BLAS, LAPACK, and related libraries") set(CMAKE_MACOSX_RPATH FALSE) endif() # miscellaneous cmake platform-neutral and platform-specific configuration ============================= set(CMAKE_FIND_NO_INSTALL_PREFIX TRUE) # do not search in CMAKE_INSTALL_PREFIX set(CMAKE_SKIP_RPATH FALSE) set(CMAKE_SKIP_BUILD_RPATH FALSE) set(CMAKE_SKIP_INSTALL_RPATH FALSE) set(CMAKE_NO_SYSTEM_FROM_IMPORTED TRUE) # do not use -isystem by default to avoid include dir ordering issues as well as other issues like https://gcc.gnu.org/onlinedocs/cpp/System-Headers.html if(CMAKE_SYSTEM_NAME MATCHES "Darwin") # look for frameworks and appbundles last set(CMAKE_FIND_FRAMEWORK LAST) set(CMAKE_FIND_APPBUNDLE LAST) endif() ########################## # Standard build variables ########################## # Get standard build variables from the environment if they have not already been set if(NOT CMAKE_C_FLAGS OR NOT DEFINED CMAKE_C_FLAGS) set(CMAKE_C_FLAGS "$ENV{CPPFLAGS}") append_flags(CMAKE_C_FLAGS "$ENV{CFLAGS}") endif() if(NOT CMAKE_CXX_FLAGS OR NOT DEFINED CMAKE_CXX_FLAGS) set(CMAKE_CXX_FLAGS "$ENV{CPPFLAGS}") append_flags(CMAKE_CXX_FLAGS "$ENV{CXXFLAGS}") endif() if(NOT CMAKE_EXE_LINKER_FLAGS OR NOT DEFINED CMAKE_EXE_LINKER_FLAGS) set(CMAKE_EXE_LINKER_FLAGS "$ENV{LDFLAGS}") endif() if (NOT CMAKE_CXX_COMPILER) message(FATAL_ERROR "C++ compiler not found") endif() # Set the default fortran integer type. This is only used by MADNESS. set(INTEGER4 TRUE CACHE BOOL "If TRUE, use integer*4 Fortran integers in BLAS calls. Otherwise use integer*8.") mark_as_advanced(INTEGER4) # Set the CPU L1 cache line size. set(VECTOR_ALIGNMENT "16" CACHE STRING "Set the vector alignment in memory (DO NOT CHANGE THIS VALUE UNLESS YOU KNOW WHAT YOU ARE DOING)") mark_as_advanced(VECTOR_ALIGNMENT) set(TILEDARRAY_ALIGNMENT ${VECTOR_ALIGNMENT}) # Set the vectory. set(CACHE_LINE_SIZE "64" CACHE STRING "Set the CPU L1 cache line size in bytes (DO NOT CHANGE THIS VALUE UNLESS YOU KNOW WHAT YOU ARE DOING)") mark_as_advanced(CACHE_LINE_SIZE) set(TILEDARRAY_CACHELINE_SIZE ${CACHE_LINE_SIZE}) ########################## # Get the git revision tag information ########################## if(EXISTS ${PROJECT_SOURCE_DIR}/.git) find_package(Git REQUIRED) execute_process( COMMAND ${GIT_EXECUTABLE} rev-parse -q HEAD WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} OUTPUT_VARIABLE TILEDARRAY_REVISION ) string(REGEX MATCH "[0-9a-f]*" TILEDARRAY_REVISION "${TILEDARRAY_REVISION}") else() set(TILEDARRAY_REVISION "unknown") endif() ########################## # Check compiler features ########################## # need C++17, insist on strict standard set(CMAKE_CXX_STANDARD 17 CACHE STRING "C++ ISO Standard version") if (NOT(CMAKE_CXX_STANDARD EQUAL 17 OR CMAKE_CXX_STANDARD EQUAL 20)) message(FATAL_ERROR "C++ 2017 ISO Standard or higher is required to compile TiledArray") endif() # C++20 is only configurable via compile features with cmake 3.12 and older if (CMAKE_CXX_STANDARD EQUAL 20 AND CMAKE_VERSION VERSION_LESS 3.12.0) cmake_minimum_required (VERSION 3.12.0) endif() set(CMAKE_CXX_STANDARD_REQUIRED ON) set(CMAKE_CXX_EXTENSIONS OFF CACHE BOOL "Whether to use extensions of C++ ISO Standard version") # Check type support include(CheckTypeSize) check_type_size("long double" TILEDARRAY_HAS_LONG_DOUBLE LANGUAGE CXX) check_type_size("long long" TILEDARRAY_HAS_LONG_LONG LANGUAGE CXX) ########################## # convert string values of TA_ERROR to numerical values expected by TA_DEFAULT_ERROR ########################## set (TA_DEFAULT_ERROR 3) # default is to abort so that it works with or without NDEBUG # assert when CMAKE_BUILD_TYPE is Debug or RelWithDebugUnfo string(TOUPPER "${CMAKE_BUILD_TYPE}" uppercase_CMAKE_BUILD_TYPE) if (CMAKE_BUILD_TYPE AND uppercase_CMAKE_BUILD_TYPE MATCHES "^(DEBUG|RELWITHDEBINFO)$") set (TA_DEFAULT_ERROR 2) endif() if (TA_ERROR STREQUAL none) set (TA_DEFAULT_ERROR 0) elseif (TA_ERROR STREQUAL throw) set (TA_DEFAULT_ERROR 1) elseif (TA_ERROR STREQUAL assert) set (TA_DEFAULT_ERROR 2) elseif (TA_ERROR STREQUAL abort) set (TA_DEFAULT_ERROR 3) endif() ########################## # Include source dirctories ########################## include_directories(${PROJECT_SOURCE_DIR}/src ${PROJECT_BINARY_DIR}/src) ########################## # external dependencies ########################## add_custom_target(External-tiledarray) # required deps: include(external/madness.cmake) detect_MADNESS_configuration() include(external/eigen.cmake) # find BTAS first, so that it finds Boost more carefully and also has a chance to memorize where it found it include(FindOrFetchBTAS) include(external/boost.cmake) if(ENABLE_CUDA) include(external/cuda.cmake) endif() if(ENABLE_SCALAPACK) include(external/scalapack.cmake) endif() if (TA_ENABLE_RANGEV3) include(FindOrFetchRangeV3) endif(TA_ENABLE_RANGEV3) # optional deps: # 1. ccache find_program(CCACHE ccache) if(CCACHE) message (STATUS "Found ccache: ${CCACHE}") set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ${CCACHE}) set_property(GLOBAL PROPERTY RULE_LAUNCH_LINK ${CCACHE}) endif(CCACHE) ########################## # sources ########################## add_subdirectory(src) add_subdirectory(examples) add_subdirectory(doc) ########################## # checking/testing ########################## enable_testing() if (TA_BUILD_UNITTEST) add_custom_target_subproject(tiledarray check USES_TERMINAL COMMAND ${CMAKE_CTEST_COMMAND} -V) add_subdirectory(tests) else() add_custom_target_subproject(tiledarray check USES_TERMINAL COMMAND echo "WARNING: unit testing disabled. To enable, add --unittest to configure, or give -DTA_BUILD_UNITTEST=TRUE to cmake") endif() ########################## # QT CREATOR file grabber ########################## if(USING_QT_CREATOR_AS_IDE) include_directories(tests) include_directories(examples) file(GLOB_RECURSE QT_CREATOR_SRC "*.h" "*.cpp" "*.c" "*.cc" "*.hpp" "*.txt" ".in") add_library(qt_creator_get_sources EXCLUDE_FROM_ALL ${QT_CREATOR_SRC}) set_target_properties(qt_creator_get_sources PROPERTIES LINKER_LANGUAGE CXX) endif(USING_QT_CREATOR_AS_IDE) ########################## # pkg-config variables ########################## foreach(_inc ${TiledArray_CONFIG_INCLUDE_DIRS}) append_flags(TiledArray_PC_CFLAGS "-I${_inc}") endforeach() foreach(_lib ${TiledArray_CONFIG_LIBRARIES}) append_flags(TiledArray_PC_LIBS "${_lib}") endforeach() ########################## # wrap up ########################## # Force cache refresh for compile flags set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS}" CACHE STRING "C compile flags" FORCE) set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}" CACHE STRING "C++ compile flags" FORCE) CONFIGURE_FILE( ${PROJECT_SOURCE_DIR}/src/TiledArray/config.h.in ${PROJECT_BINARY_DIR}/src/TiledArray/config.h ) CONFIGURE_FILE( ${PROJECT_SOURCE_DIR}/src/TiledArray/version.h.in ${PROJECT_BINARY_DIR}/src/TiledArray/version.h ) CONFIGURE_FILE( ${PROJECT_SOURCE_DIR}/tiledarray.pc.in ${PROJECT_BINARY_DIR}/tiledarray.pc ) # install config files install(FILES ${PROJECT_BINARY_DIR}/tiledarray.pc DESTINATION lib/pkgconfig) # include extra cmake files install(FILES "${PROJECT_SOURCE_DIR}/cmake/modules/SanitizeCUDAImplicitDirectories.cmake" DESTINATION "${TILEDARRAY_INSTALL_CMAKEDIR}") # Create the version file write_basic_package_version_file(tiledarray-config-version.cmake VERSION ${TILEDARRAY_VERSION} COMPATIBILITY AnyNewerVersion) # Create the targets file export(EXPORT tiledarray FILE "${PROJECT_BINARY_DIR}/tiledarray-targets.cmake") # Create the configure file configure_package_config_file(cmake/tiledarray-config.cmake.in "${PROJECT_BINARY_DIR}/tiledarray-config.cmake" INSTALL_DESTINATION "${TILEDARRAY_INSTALL_CMAKEDIR}" PATH_VARS CMAKE_INSTALL_PREFIX TILEDARRAY_INSTALL_BINDIR TILEDARRAY_INSTALL_INCLUDEDIR TILEDARRAY_INSTALL_LIBDIR TILEDARRAY_INSTALL_DOCDIR TILEDARRAY_INSTALL_CMAKEDIR) # Install config, version, and target files install(EXPORT tiledarray FILE "tiledarray-targets.cmake" DESTINATION "${TILEDARRAY_INSTALL_CMAKEDIR}" COMPONENT tiledarray) install(FILES "${PROJECT_BINARY_DIR}/tiledarray-config.cmake" "${PROJECT_BINARY_DIR}/tiledarray-config-version.cmake" DESTINATION "${TILEDARRAY_INSTALL_CMAKEDIR}" COMPONENT tiledarray) # Add target to allow on-the-fly switching of build type ADD_CUSTOM_TARGET(debug COMMAND ${CMAKE_COMMAND} -DCMAKE_BUILD_TYPE=Debug ${CMAKE_CURRENT_SOURCE_DIR} COMMAND ${CMAKE_COMMAND} --build ${CMAKE_CURRENT_BINARY_DIR} --target all COMMENT "Switch CMAKE_BUILD_TYPE to Debug" ) ADD_CUSTOM_TARGET(release COMMAND ${CMAKE_COMMAND} -DCMAKE_BUILD_TYPE=Release ${CMAKE_CURRENT_SOURCE_DIR} COMMAND ${CMAKE_COMMAND} --build ${CMAKE_CURRENT_BINARY_DIR} --target all COMMENT "Switch CMAKE_BUILD_TYPE to Release" ) feature_summary(WHAT ALL DESCRIPTION "=== TiledArray Package/Feature Info ===") option(TA_PYTHON "Build TA python module" OFF) if (TA_PYTHON) if (NOT CMAKE_POSITION_INDEPENDENT_CODE) message(FATAL_ERROR "Python module requires CMAKE_POSITION_INDEPENDENT_CODE=ON") endif() add_subdirectory(python) endif() tiledarray-1.0.0/INSTALL.md000066400000000000000000000555641375455224000153260ustar00rootroot00000000000000# Synopsis ``` $ git clone https://github.com/ValeevGroup/TiledArray.git tiledarray $ cd tiledarray $ cmake -B build \ -D CMAKE_INSTALL_PREFIX=/path/to/tiledarray/install \ -D CMAKE_TOOLCHAIN_FILE=cmake/vg/toolchains/.cmake \ . $ cmake --build build (recommended, but optional): $ cmake --build build --target check $ cmake --build build --target install ``` # Prerequisites - C++ compiler with support for the [C++17 standard](http://www.iso.org/standard/68564.html), or a more recent standard. This includes the following compilers: - [GNU C++](https://gcc.gnu.org/), version 7.0 or higher - [Clang](https://clang.llvm.org/), version 5 or higher - [Apple Clang](https://en.wikipedia.org/wiki/Xcode), version 9.3 or higher - [Intel C++ compiler](https://software.intel.com/en-us/c-compilers), version 19 or higher See the current [Travis CI matrix](.travis.yml) for the most up-to-date list of compilers that are known to work. - [CMake](https://cmake.org/), version 3.15 or higher; if CUDA support is needed, CMake 3.18 or higher is required. - [Git](https://git-scm.com/) 1.8 or later (required to obtain TiledArray and MADNESS source code from GitHub) - [Eigen](http://eigen.tuxfamily.org/), version 3.3 or higher; if CUDA is enabled then 3.3.7 is required (will be downloaded automatically, if missing) - [Boost libraries](www.boost.org/), version 1.33 or higher (will be downloaded automatically, if missing). The following principal Boost components are used: - Boost.Iterator: header-only - Boost.Container: header-only - Boost.Test: header-only or (optionally) as a compiled library, *only used for unit testing* - Boost.Range: header-only, *only used for unit testing* - [BTAS](http://github.com/BTAS/BTAS), tag 3e286d05ee3a19ac320c12c380d947c3e31d77ff (will be downloaded automatically, if missing) - BLAS library - [MADNESS](https://github.com/m-a-d-n-e-s-s/madness), tag eee5fd9f940ef422ee4ee5abf852c910bc826fd4 . Only the MADworld runtime and BLAS/LAPACK C API component of MADNESS is used by TiledArray. If usable MADNESS installation is now found, TiledArray will download and compile MADNESS. *This is the recommended way to compile MADNESS for all users*. A detailed list of MADNESS prerequisites can be found at [MADNESS' INSTALL file](https://github.com/m-a-d-n-e-s-s/madness/blob/master/INSTALL_CMake); it also also contains detailed MADNESS compilation instructions. Compiling MADNESS requires the following prerequisites: - An implementation of Message Passing Interface version 2 or 3, with support for `MPI_THREAD_MULTIPLE`. - BLAS and LAPACK libraries (only BLAS is used by TiledArray, but without LAPACK MADNESS will not compile) - (optional) Intel Thread Building Blocks (TBB), available in a [commercial](software.intel.com/tbb‎) or an [open-source](https://www.threadingbuildingblocks.org/) form Optional prerequisites: - [CUDA compiler and runtime](https://developer.nvidia.com/cuda-zone) -- for execution on CUDA-enabled accelerators. CUDA 11 or later is required. Support for CUDA also requires the following additional prerequisites, both of which will be built and installed automatically if missing: - [cuTT](github.com/ValeevGroup/cutt) -- CUDA transpose library; note that our fork of the [original cuTT repo](github.com/ap-hynninen/cutt) is required to provide thread-safety (tag 0e8685bf82910bc7435835f846e88f1b39f47f09). - [Umpire](github.com/LLNL/Umpire) -- portable memory manager for heterogeneous platforms (tag f04abd1dd038c84262915a493d8f78576bb80fd0). - [Doxygen](http://www.doxygen.nl/) -- for building documentation (version 1.8.12 or later). - [ScaLAPACK](http://www.netlib.org/scalapack/) -- a distributed-memory linear algebra package. If detected, the following C++ components will also be sought and downloaded, if missing: - [blacspp](https://github.com/wavefunction91/blacspp.git) -- a modern C++ (C++17) wrapper for BLACS (tag 88076f1706be083ead882f6ce0bfc6884a72fc03) - [scalapackpp](https://github.com/wavefunction91/scalapackpp.git) -- a modern C++ (C++17) wrapper for ScaLAPACK (tag 28433942197aee141cd9e96ed1d00f6ec7b902cb) - Python3 interpreter -- to test (optionally-built) Python bindings - [Range-V3](https://github.com/ericniebler/range-v3.git) -- a Ranges library that served as the basis for Ranges component of C++20; only used for some unit testing of the functionality anticipated to be supported by future C++ standards. Most of the dependencies (except for MADNESS) can be installed with a package manager, such as Homebrew on OS X or apt-get on Debian Linux distributions; this is the preferred method. Since on some systems configuring and building MADNESS can be difficult even for experts, we recommend letting the TiledArray download and build MADNESS for you. # Obtain TiledArray source code Check out the source code as follows: ``` $ git clone https://github.com/ValeevGroup/tiledarray.git ``` It is necessary to compile TiledArray outside of the source code tree. Most users can simply create a build directory inside the source tree: ``` $ cd tiledarray; mkdir build; cd build ``` Instructions below assume that you are located in the build directory. We will assume that the environment variable `TILEDARRAY_SOURCE_DIR` specifies the location of the TiledArray source tree. # Configure TiledArray TiledArray is configured and built with CMake. When configuring with CMake, you specify a set of CMake variables on the command line, where each variable argument is prepended with the '-D' option. Typically, you will need to specify the install path for TiledArray, build type, MPI Compiler wrappers, and BLAS and LAPACK libraries. For many platforms TiledArray provides *toolchain* files that can greatly simplify configuration; they are located under `$TILEDARRAY_SOURCE_DIR/cmake/toolchains`. It is strongly recommended that all users use one of the provided toolchains as is or as the basis for a custom toolchain file. Here's how to compile TiledArray on a macOS system: ``` $ cmake -D CMAKE_INSTALL_PREFIX=/path/to/install/tiledarray \ -D CMAKE_BUILD_TYPE=Release \ -D CMAKE_TOOLCHAIN_FILE=cmake/vg/toolchains/macos-clang-mpi-accelerate.cmake \ $TILEDARRAY_SOURCE_DIR ``` Following are several common examples of configuring TiledArray where instead of a toolchain file we specify CMake variables "manually" (on the command line). * Basic configuration. This will search for dependencies on your system. If the required dependencies are not found on your system, they will be downloaded and installed during the build process (this includes Eigen, Boost, and MADNESS, but not MPI or TBB). The CMAKE_PREFIX_PATH cache variables is a semicolon separated list of search paths. ``` $ cmake -D CMAKE_INSTALL_PREFIX=/path/to/install/tiledarray \ -D CMAKE_BUILD_TYPE=Release \ -D CMAKE_PREFIX_PATH=/path/to/dependency;/path/to/another/dependency \ $TILEDARRAY_SOURCE_DIR ``` * Basic configuration with unit tests. ``` $ cmake -D CMAKE_INSTALL_PREFIX=/path/to/install/tiledarray \ -D CMAKE_BUILD_TYPE=Debug \ -D TA_BUILD_UNITTEST=ON \ -D BOOST_ROOT=/path/to/boost \ -D CMAKE_PREFIX_PATH=/path/to/dependency;/path/to/another/dependency \ $TILEDARRAY_SOURCE_DIR ``` * Specify dependencies, w/o MADNESS installed on the system ``` $ cmake -D CMAKE_INSTALL_PREFIX=/path/to/install/tiledarray \ -D CMAKE_BUILD_TYPE=Release \ -D EIGEN3_INCLUDE_DIR=/path/to/eigen/include/eigen3 \ -D LAPACK_LIBRARIES="-L/path/to/lapack/lib -llapack -L/path/to/blas/lib -lblas" \ -D TBB_ROOT_DIR=/path/to/tbb \ -D CMAKE_C_COMPILER=gcc \ -D CMAKE_CXX_COMPILER=g++ \ -D MPI_C_COMPILER=mpicc \ -D MPI_CXX_COMPILER=mpicxx \ $TILEDARRAY_SOURCE_DIR ``` * Specify dependencies, w/ MADNESS installed on the system ``` $ cmake -D CMAKE_INSTALL_PREFIX=/path/to/install/tiledarray \ -D CMAKE_BUILD_TYPE=Release \ -D EIGEN3_INCLUDE_DIR=/path/to/eigen/include/eigen3 \ -D LAPACK_LIBRARIES="-L/path/to/lapack/lib -llapack -L/path/to/blas/lib -lblas" \ -D MADNESS_ROOT_DIR=/path/to/madness \ -D CMAKE_C_COMPILER=gcc \ -D CMAKE_CXX_COMPILER=g++ \ -D MPI_C_COMPILER=mpicc \ -D MPI_CXX_COMPILER=mpicxx \ $TILEDARRAY_SOURCE_DIR ``` Additional CMake variables are given below. ## Common CMake variables * `CMAKE_C_COMPILER` -- The C compiler * `CMAKE_CXX_COMPILER` -- The C++ compiler * `CMAKE_C_FLAGS` -- The C compile flags (includes CPPFLAGS and CFLAGS) * `CMAKE_CXX_FLAGS` -- The C++ compile flags (includes CPPFLAGS and CXXFLAGS) * `CMAKE_EXE_LINKER_FLAGS` -- The linker flags * `CMAKE_BUILD_TYPE` -- Optimization/debug build type options include `Debug` (optimization off, debugging symbols and assersions on), `Release` (optimization on, debugging symbols and assertions off), `RelWithDebInfo` (optimization on, debugging symbols and assertions on) and `MinSizeRel` (same as `Release` but optimized for executable size). The default is empty build type. It is recommended that you set the build type explicitly. * `BUILD_SHARED_LIBS` -- Enable shared libraries. This option is only available if the platform supports shared libraries; if that's true and `TA_ASSUMES_ASLR_DISABLED` is `ON` (see below) the default is `ON`, otherwise the default is `OFF`. * `CMAKE_CXX_STANDARD` -- Specify the C++ ISO Standard to use. Valid values are `17` (default), and `20`. Most of these are best specified in a _toolchain file_. TiledArray is recommended to use the toolchains distributed via [the Valeev Group CMake kit](https://github.com/ValeevGroup/kit-cmake/tree/master/toolchains). TiledArray by default downloads (via [the FetchContent CMake module](https://cmake.org/cmake/help/latest/module/FetchContent.html)) the VG CMake toolkit which makes the toolchains available without having to download the toolchain files manually. E.g., to use toolchain `x` from the VG CMake kit repository provide `-DCMAKE_TOOLCHAIN_FILE=cmake/vg/toolchains/x.cmake` to CMake when configuring TiledArray. -D CMAKE_BUILD_TYPE=(Release|Debug|RelWithDebInfo) -D BUILD_SHARED_LIBS=(TRUE|FALSE) -D CMAKE_CXX_STANDARD=(17|20) -D TA_ERROR=(none|throw|assert) It is typically not necessary to specify optimization or debug flags as the default values provided by CMake are usually correct. ## TiledArray, MADNESS runtime, and the Address Space Layout Randomization (ASLR) ASLR is a standard technique for increasing platform security implemented by the OS kernel and/or the dynamic linker by randomizing both where the shared libraries are loaded as well as (when enabled) the absolute position of the executable in memory (such executables are known as position-independent executables). Until recently TiledArray and other MADNESS-based applications could not be used on platforms with ASLR if ran with more than 1 MPI rank; if properly configured and built TA can now be safely used on ASLR platforms. Use the following variables to control the ASLR-related aspects of TiledArray and the underlying MADNESS runtime. * `TA_ASSUMES_ASLR_DISABLED` -- TiledArray and MADNESS runtime will assume that the Address Space Layout Randomization (ASLR) is off. By default `TA_ASSUMES_ASLR_DISABLED` is set to `OFF` (i.e. ASLR is assumed to be enabled); this will cause all TiledArray libraries by default to be static (`BUILD_SHARED_LIBS=OFF`) and compiled as position-independent code (`CMAKE_POSITION_INDEPENDENT_CODE=ON`). This will also enable a runtime check in MADworld for ASLR. * `CMAKE_POSITION_INDEPENDENT_CODE` -- This standard CMake variable controls whether targets are compiled by default as position-independent code or not. If `BUILD_SHARED_LIBS=OFF` need to set this to `ON` if want to use the TiledArray libraries to build shared libraries or position-independent executables. To make things more concrete, consider the following 2 scenarios: * Platform with ASLR disabled -- set `TA_ASSUMES_ASLR_DISABLED=ON` to set the defaults correctly and enable the ASLR check. `BUILD_SHARED_LIBS` can be set to `ON` (to produce shared TA/MADworld libraries, e.g., to minimize the executable size) or to `OFF` to produce static libraries. If the TA+MADworld static libraries will be linked into shared libraries set `CMAKE_POSITION_INDEPENDENT_CODE=ON`, otherwise `CMAKE_POSITION_INDEPENDENT_CODE` will be set to OFF for maximum efficiency of function calls. * Platform with ASLR enabled -- this is the default. Setting `BUILD_SHARED_LIBS=ON` in this scenario will produce executables that can only be safely used with 1 MPI rank, thus `BUILD_SHARED_LIBS` will be defaulted to OFF (i.e. TA+MADworld libraries will be built as static libraries). `CMAKE_POSITION_INDEPENDENT_CODE` is by default set to `ON`, thus TA+MADworld libraries can be linked into position-independent executables safely. TA+MADworld libraries can also be linked into a shared library, provided that *ALL* code using TA+MADworld is part of the *SAME* shared library. E.g. to link TA+MADworld into a Python module compile TA+MADworld libraries and their dependents as static libraries (with `CMAKE_POSITION_INDEPENDENT_CODE=ON`) and link them all together into a single module (same logic applies to shared libraries using TA+MADworld). ## MPI You may choose from MPICH, MVAPICH, OpenMPI, Intel MPI, or your vendor provided MPI implementation. Specify the C and C++ MPI compiler wrappers with the following CMake cache variables: * MPI_C_COMPILER -- The MPI C compiler wrapper * MPI_CXX_COMPILER -- The MPI C++ compiler wrapper You can build TiledArray without MPI support by setting ENABLE_MPI to OFF. Though we strongly recommend compiling with MPI even if you do not intend to use TiledArray in a distributed memory environment. Note, if you build MADNESS yourself, you must also configure MADNESS with `ENABLE_MPI=OFF` to enable this option. ## BLAS and LAPACK TiledArray requires a serial BLAS implementation, either by linking with a serial version of the BLAS library or by setting the number of threads to one (1) with an environment variable. This is necessary because TiledArray evaluates tensor expressions in parallel by subdividing them into small tasks, each of which is assumed to be single-threaded; attempting to run a multi-threaded BLAS function inside tasks will oversubscribe the hardware cores. BLAS library dependency is provided by the MADNESS library, which checks for presence of BLAS and LAPACK (which also depends on BLAS) at the configure time. Therefore, if MADNESS is already installed on your machine you do not need to do anything. However, the most common scenario is where TiledArray will configure and compile MADNESS as part of its compilation; in this case it is necessary to specify how to find the LAPACK library to TiledArray, which will in turn pass this info to MADNESS. This is done by setting the following CMake variables: * `LAPACK_LIBRARIES` -- a string specifying LAPACK libraries and all of its dependencies (such as BLAS library, math library, etc.); this string can also include linker directory flags (`-L`) * `LAPACK_INCLUDE_DIRS` -- (optional) a list of directories which contain BLAS/LAPACK-related header files * `LAPACK_COMPILE_DEFINITIONS` -- (optional) a list of preprocessor definitions required for any code that uses BLAS/LAPACK-related header files * `LAPACK_COMPILE_OPTIONS` -- (optional) a list of compiler options required for any code that uses BLAS/LAPACK-related header files * `BLA_STATIC` -- indicates whether static or shared LAPACK and BLAS libraries will be preferred. The last three variables are only needed if your code will use non-Fortran BLAS/LAPACK library API (such as CBLAS or LAPACKE) and thus needs access to the header files. TiledArray only uses BLAS via the Fortran API, hence the last three variables do not need to be specified. Since TiledArray uses the Fortran API of BLAS, it may be necessary to specify the Fortran integer size used by the particular BLAS library: * `INTEGER4` -- Specifies the integer size (in bytes) assumed by the BLAS/LAPACK Fortran API [Default=TRUE] TRUE = Fortran integer*4, FALSE = Fortran integer*8 You should use the default value unless you know it is necessary for your BLAS implementation. Common optimized libraries OpenBLAS/GotoBLAS, BLIS, MKL (on Intel platforms), Atlas, Accelerate (on OS X), ESSL (on BlueGene platforms), or ACML (on AMD platforms). You can also use the Netlib reference implementation if nothing else is available, but this will be very slow. Example flags: * Accelerate on OS X -D LAPACK_LIBRARIES="-framework Accelerate" * OpenBLAS with Netlib LAPACK -D LAPACK_LIBRARIES="-L/path/to/lapack/lib -llapack -L/path/to/openblas/lib -lopenblas -lpthread" * Netlib -D LAPACK_LIBRARIES="-L/path/to/lapack/lib -llapack -L/path/to/blas/lib -lblas" * MKL on Linux -D LAPACK_LIBRARIES="-L${MKLROOT}/lib/intel64 -Wl,--start-group -lmkl_intel_lp64 -lmkl_core -lmkl_sequential -Wl,--end-group -lpthread -lm” * MKL on OS X -D LAPACK_LIBRARIES="-L${MKLROOT}/lib -lmkl_intel_lp64 -lmkl_core -lmkl_sequential -lpthread -lm" For additional information on linking different versions of MKL, see the MKL Link Advisor page. https://software.intel.com/en-us/articles/intel-mkl-link-line-advisor ## CUDA Support for execution on CUDA-enabled hardware is controlled by the following variables: * `ENABLE_CUDA` -- Set to `ON` to turn on CUDA support. [Default=OFF]. * `CMAKE_CUDA_HOST_COMPILER` -- Set to the path to the host C++ compiler to be used by CUDA compiler. CUDA compilers used to be notorious for only being able to use specific C++ host compilers, but support for more recent C++ host compilers has improved. The default is determined by the CUDA compiler and the user environment variables (`PATH` etc.). * `ENABLE_CUDA_ERROR_CHECK` -- Set to `ON` to turn on assertions for successful completion of calls to CUDA runtime and libraries. [Default=OFF]. * `CUTT_INSTALL_DIR` -- the installation prefix of the pre-installed cuTT library. This should not be normally needed; it is strongly recommended to let TiledArray build and install cuTT. * `UMPIRE_INSTALL_DIR` -- the installation prefix of the pre-installed Umpire library. This should not be normally needed; it is strongly recommended to let TiledArray build and install Umpire. For the CUDA compiler and toolkit to be discoverable the CUDA compiler (`nvcc`) should be in the `PATH` environment variable. Refer to the [FindCUDAToolkit module](https://cmake.org/cmake/help/latest/module/FindCUDAToolkit.html) for more info. ## Eigen 3 You can specify the install location of Eigen 3 with the following CMake cache variable: * `EIGEN3_INCLUDE_DIR` -- The path to the Eigen 3 include directory If Eigen is not found at the configure time, it will be downloaded from the Bitbucket repository. ## Pythom To build Python bindings use the following variable: * `TA_PYTHON` -- Set to `ON` to build Python bindings. This also requires setting `BUILD_SHARED_LIBS` to `ON`. ## MADNESS TiledArray uses a non-release version of MADNESS. Therefore, you should NOT expect the most recent release of MADNESS to work with TiledArray. To ensure you are using the correct version of MADNESS, we recommend allowing CMake to automatically download, configure, and build MADNESS (this is the default behavior). When CMake is configuring TiledArray, it will checkout the correct revision of MADNESS. The following CMake options may be used to modify build behavior or find MADNESS: * `ENABLE_MPI` -- Enable MPI [Default=ON] * `ENABLE_SCALAPACK` -- Enable use of ScaLAPACK bindings [Default=OFF] * `ENABLE_TBB` -- Enable the use of TBB when building MADNESS [Default=ON] * `ENABLE_MKL` -- Enable the use of MKL when building MADNESS [Default=ON] * `ENABLE_GPERFTOOLS` -- Enable the use of gperftools when building MADNESS [Default=OFF] * `ENABLE_TCMALLOC_MINIMAL` -- Enable the use of gperftool's tcmalloc_minimal library only (the rest of gperftools is skipped) when building MADNESS [Default=OFF] * `ENABLE_LIBUNWIND` -- Force the discovery of libunwind library when building MADNESS [Default=OFF] * `MADNESS_SOURCE_DIR` -- Path to the MADNESS source directory * `MADNESS_BINARY_DIR` -- Path to the MADNESS build directory * `MADNESS_URL` -- Path to the MADNESS repository [Default=MADNESS git repository] * `MADNESS_TAG` -- Revision hash or tag to use when building MADNESS (expert only) * `MADNESS_CMAKE_EXTRA_ARGS` -- Extra flags passed to MADNESS cmake command * `MADNESS_CMAKE_GENERATOR` -- the CMake generator to use for building MADNESS [Default=Generator used to build TiledArray] The following environment variables can be used to help discovery of MADNESS dependencies: * `TBBROOT` -- the install prefix of TBB * `MKLROOT` -- the install prefix of MKL * `GPERFTOOLS_DIR` -- the install prefix of gperftools * `LIBUNWIND_DIR` -- the install prefix of libunwind If you wish to install MADNESS yourself, we recommend downloading the latest version from the MADNESS git repository. You should not expect the latest release version to work correctly with TiledArray. You can specify the install directory with: * `MADNESS_ROOT_DIR` -- MADNESS install directory * `CMAKE_INSTALL_PREFIX` -- Semicolon separated list of directory CMake will use to search for software dependencies. ## Advanced configure options: The following CMake cache variables are tuning parameters. You should only modify these values if you know the values for your patricular system. * `VECTOR_ALIGNMENT` -- The alignment of memory for Tensor in bytes [Default=16] * `CACHE_LINE_SIZE` -- The cache line size in bytes [Default=64] `VECTOR_ALIGNMENT` controls the alignment of Tensor data, and `CACHE_LINE_SIZE` controls the size of automatic loop unrolling for tensor operations. TiledArray does not currently use explicit vector instructions (i.e. intrinsics), but the code is written in such a way that compilers can more easily autovectorize the operations when supported. In a future version, explicit vectorization support may be added. ## Expert configure options: * `TA_EXPERT` -- Set to `ON` to disable automatic installation of prerequisites. Useful for experts, hence the name. [Default=OFF]. * `TA_TRACE_TASKS` -- Set to `ON` to enable tracing of MADNESS tasks using custom task tracer. Note that standard profilers/tracers are generally useless (except in the trivial cases) with MADWorld-based programs since the submission context of tasks is not captured by standard tracing tools; this makes it impossible in a nontrivial program to attribute tasks to source code. WARNING: task tracing his will greatly increase the memory requirements. [Default=OFF]. * `TA_ENABLE_RANGEV3` -- Set to `ON` to find or fetch the Range-V3 library and enable additional tests of TA components with constructs anticipated to be supported in the future. [Default=OFF]. * `TA_SIGNED_1INDEX_TYPE` -- Set to `OFF` to use unsigned 1-index coordinate type (default for TiledArray 1.0.0-alpha.2 and older). The default is `ON`, which enables the use of negative indices in coordinates. # Build TiledArray ``` $ cmake --build . (optional) $ cmake --build . --target check $ cmake --build . --target install ``` tiledarray-1.0.0/LICENSE000066400000000000000000000772461375455224000147040ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. tiledarray-1.0.0/NOTES000066400000000000000000000026571375455224000145040ustar00rootroot00000000000000Design philosophy: There are 2 fundamental reasons for tiling: physics and performance. Both of these may require multiple levels of tiling hierarchy. Unfortunately, it may not be trivial to decouple or overlap the two hierarchies. Thus we eschew the arbitrarily-deep tiling hierarchy in favor of a single level of tiling. (N.B. customization of the tile types is possible, and thus can be used to create hierarchies of tiles) This design decision is driven by the following considerations: 1) the end user should not worry about tiling for performance, the interface should be focused on the needs of domain application (quantum physics). 2) tiling in quantum physics corresponds to spatial/energetic locality (outside local domains interactions are classical and do not require operator matrices) or symmetry (not always worth it, point group symmetry conflicts with the "local" tiling). 3) the problem of tiling for performance is challenging and has been only solved for simple cases and regular memory hierarchies (e.g. BLAS). We must rely on external libraries and should optimize only at a high level and without impact on interface (e.g. tile fusion, etc. to construct data representation most suitable for performance). 4) item 2 also suggests that nonuniform(irregular) tiling must be allowed to provide the necessary flexibility for physics. 5) repacking arrays (i.e. changing tile sizes, permuting dimensions, etc.) will be frequent, but OK. tiledarray-1.0.0/README.md000066400000000000000000000170231375455224000151410ustar00rootroot00000000000000[![Build Status](https://travis-ci.org/ValeevGroup/tiledarray.svg?branch=master)](https://travis-ci.org/ValeevGroup/tiledarray) [![codecov](https://codecov.io/gh/ValeevGroup/tiledarray/branch/master/graph/badge.svg)](https://codecov.io/gh/ValeevGroup/tiledarray) # Synopsis TiledArray is a scalable, block-sparse tensor framework for rapid composition of high-performance tensor arithmetic, appearing for example in many-body quantum mechanics. It allows users to compose tensor expressions of arbitrary complexity in native C++ code that closely resembles the standard mathematical notation. The framework is designed to scale from a single multicore computer to a massive distributed-memory multiprocessor. TiledArray is built on top of MADNESS parallel runtime (MADWorld), part of [MADNESS numerical calculus framework](https://github.com/m-a-d-n-e-s-s/madness). TiledArray is a work in progress. Its development has been possible thanks to generous support from the U.S. National Science Foundation, the Alfred P. Sloan Foundation, the Camille and Henry Dreyfus Foundation, and the Department of Energy. # Design Goals * General-purpose arithmetic on dense and block-sparse tensors; * High-level (math-like) composition as well as full access to low-level data and algorithms, both from C++ * Massive shared- and distributed-memory parallelism * Deeply-reusable framework: everything can be customized, from tile types (e.g. to support on-disk or compute-on-the-fly tensors) to how the structure of sparse tensors is described. # Example Code The following example expressions are written in C++ with TiledArray. TiledArray use the [Einstein summation convention](http://en.wikipedia.org/wiki/Einstein_notation) when evaluating tensor expressions. * Matrix-matrix multiplication ``` C("m,n") = 2.0 * A("m,k") * B("k,n"); ``` * Matrix-vector multiplication ``` C("n") = A("k") * B("k,n"); ``` * A more complex tensor expression ``` E("m,n") = 2.0 * A("m,k") * B("k,n") + C("k,n") * D("k,m"); ``` The following application is a minimal example of a distributed-memory matrix multiplcation. ``` #include int main(int argc, char** argv) { // Initialize the parallel runtime TA::World& world = TA::initialize(argc, argv); // Construct a 2D tiled range structure that defines // the tiling of an array. Each dimension contains // 10 tiles. TA::TiledRange trange = { { 0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100 }, { 0, 10, 20, 30, 40, 50, 60, 70, 80, 90, 100 } }; // Construct and fill the argument arrays with data TA::TArrayD A(world, trange); TA::TArrayD B(world, trange); A.fill_local(3.0); B.fill_local(2.0); // Construct the (empty) result array. TA::TArrayD C; // Perform a distributed matrix multiplication C("i,j") = A("i,k") * B("k,j"); // Tear down the parallel runtime. TA::finalize(); return 0; } ``` # Performance Parallel performance of TiledArray for multiplication of dense square matrices on [Mira](https://www.alcf.anl.gov/mira), an IBM BlueGene/Q supercomputer at Argonne National Laboratory, compared with that of [Cyclops Tensor Framework](https://github.com/solomonik/ctf) and [ScaLAPACK](http://www.netlib.org/scalapack/): ![MM:TA-vs-CTF-vs-SCALAPACK](https://valeevgroup.github.io/tiledarray/images/BGQtime_TA_CTF_ScaLAPACK.png) This figure was obtained with the help of an award from [the Department of Energy INCITE program](http://www.doeleadershipcomputing.org/incite-program/). Excellent parallel scalability is also possible for much more complicated expressions than just a single GEMM, as demonstrated below for the coupled-cluster singles and doubles (CCSD) wave function solver. Parallel speed-up of 1 iteration of CCSD solver for uracil trimer in 6-31G* AO basis was measured on ["BlueRidge" cluster](https://secure.hosting.vt.edu/www.arc.vt.edu/computing/blueridge-sandy-bridge/) at Virginia Tech (wall time on one 16-core node = 1290 sec): ![CCSD:UracilTrimer-speedup](https://valeevgroup.github.io/tiledarray/images/uracil-trimer-ccsd-blueridge-speedup.png) This figure was obtained with the help of an allocation from [Advanced Research Computing](https://secure.hosting.vt.edu/www.arc.vt.edu/) at Virginia Tech. # Installing TiledArray The short version: assuming that MPI compiler wrappers are in your path, and this is a platform with BLAS/LAPACK installed system-wide in a standard location: ``` $ git clone https://github.com/ValeevGroup/TiledArray.git tiledarray $ cd tiledarray $ cmake -B build \ -D CMAKE_INSTALL_PREFIX=/path/to/tiledarray/install \ -D CMAKE_TOOLCHAIN_FILE=cmake/vg/toolchains/.cmake \ . $ cmake --build build (optional) $ cmake --build build --target check $ cmake --build build --target install ``` Here `` is the appropriate toolchain file from [the Valeev Group CMake kit](https://github.com/ValeevGroup/kit-cmake/tree/master/toolchains); an alternative is to provide your own toolchain file. On some standard platforms (e.g. MacOS) the toolchain file can be skipped. The detailed instructions can be found in [INSTALL.md](https://github.com/ValeevGroup/tiledarray/blob/master/INSTALL.md). # Using TiledArray TiledArray documentation is available for the following versions: - [master branch](https://valeevgroup.github.io/tiledarray/dox-master) . # Developers TiledArray is developed by the [Valeev Group](http://valeevgroup.github.io/) at [Virginia Tech](http://www.vt.edu). # License TiledArray is freely available under the terms of the GPL v3+ licence. See the the included LICENSE file for details. If you are interested in using TiledArray under different licensing terms, please contact us. # How to Cite Cite TiledArray as > "TiledArray: A general-purpose scalable block-sparse tensor framework", Justus A. Calvin and Edward F. Valeev, https://github.com/valeevgroup/tiledarray . Inner workings of TiledArray are partially described in the following publications: * Justus A. Calvin, Cannada A. Lewis, and Edward F. Valeev, "Scalable Task-Based Algorithm for Multiplication of Block-Rank-Sparse Matrices.", Proceedings of the 5th Workshop on Irregular Applications: Architectures and Algorithms, http://dx.doi.org/10.1145/2833179.2833186. * Justus A. Calvin and Edward F. Valeev, "Task-Based Algorithm for Matrix Multiplication: A Step Towards Block-Sparse Tensor Computing." http://arxiv.org/abs/1504.05046 . The MADNESS parallel runtime is described in the following publication: * Robert J. Harrison, Gregory Beylkin, Florian A. Bischoff, Justus A. Calvin, George I. Fann, Jacob Fosso-Tande, Diego Galindo, Jeff R. Hammond, Rebecca Hartman-Baker, Judith C. Hill, Jun Jia, Jakob S. Kottmann, M-J. Yvonne Ou, Junchen Pei, Laura E. Ratcliff, Matthew G. Reuter, Adam C. Richie-Halford, Nichols A. Romero, Hideo Sekino, William A. Shelton, Bryan E. Sundahl, W. Scott Thornton, Edward F. Valeev, Álvaro Vázquez-Mayagoitia, Nicholas Vence, Takeshi Yanai, and Yukina Yokoi, "madness: A Multiresolution, Adaptive Numerical Environment for Scientific Simulation.", *SIAM J Sci Comput* __38__, S123-S142 (2016), http://dx.doi.org/10.1137/15M1026171 . # Acknowledgements Development of TiledArray is made possible by past and present contributions from the National Science Foundation (awards CHE-0847295, CHE-0741927, OCI-1047696, CHE-1362655, ACI-1450262, ACI-1550456), the Alfred P. Sloan Foundation, the Camille and Henry Dreyfus Foundation, the Department of Energy Exascale Computing Project ([NWChemEx subproject](https://github.com/NWChemEx-Project)), and the Department of Energy INCITE Program. tiledarray-1.0.0/bin/000077500000000000000000000000001375455224000144275ustar00rootroot00000000000000tiledarray-1.0.0/bin/admin/000077500000000000000000000000001375455224000155175ustar00rootroot00000000000000tiledarray-1.0.0/bin/admin/dependency-versions-update-hook.py000077500000000000000000000165341375455224000243070ustar00rootroot00000000000000#!/usr/bin/env python from __future__ import print_function import sys import os import os.path as op def to_base_version(full_version): base_version = full_version plus_pos = base_version.find('+') if plus_pos != -1: base_version = base_version[0:plus_pos] minus_pos = base_version.find('-') if minus_pos != -1: base_version = base_version[0:minus_pos] return base_version def dots_to_undescores(str): return str.replace('.', '_') def escape_special_chars(str): #str = str.replace('(', '\(') #str = str.replace(')', '\)') str = str.replace('/', '\/') str = str.replace('.', '\.') return str def replace_dep_id(topsrc, file_ext, dep_name, old_id, new_id, search_prefix = '', search_postfix = ''): any_files_changed = False if old_id != new_id: # always exclude the versions file seek_retcode = os.system('grep -q -r --include="*.' + file_ext + '" --exclude="' + topsrc + '/external/versions.cmake" "' + search_prefix + old_id + search_postfix + '" ' + topsrc) if os.WIFEXITED(seek_retcode) and os.WEXITSTATUS(seek_retcode) == 0: any_files_changed = True print('changing ' + dep_name + ' id from', old_id, 'to', new_id) esc_search_prefix = escape_special_chars(search_prefix) esc_search_postfix = escape_special_chars(search_postfix) os.system('find ' + topsrc + ' -type f -name "*.' + file_ext + '" -print0 | xargs -0 sed -i \'\' -e \'s/' + esc_search_prefix + old_id + esc_search_postfix + '/' + esc_search_prefix + new_id + esc_search_postfix + '/g\'') return any_files_changed argv = sys.argv topsrc = op.normpath(op.join(op.abspath(op.dirname(sys.argv[0])), '../..')) if len(argv) == 1: version_cmake_path = topsrc + '/external/versions.cmake' elif len(argv) == 2: # no-op if given version_cmake_path = op.abspath(sys.argv[1]) if op.basename(version_cmake_path) != 'versions.cmake': sys.exit(0) else: print('invalid number of arguments') sys.exit(0) # extract dependencies tags and versions with open(version_cmake_path) as inf: for line in inf: line = line.replace('(', ' ') line = line.replace(')', ' ') tokens = line.split() if len(tokens) < 3: continue if tokens[1].find('TRACKED_BOOST') != -1: if tokens[1].find('PREVIOUS') != -1: boost_old_version = tokens[2] else: boost_new_version = tokens[2] elif tokens[1].find('INSTALL_BOOST') != -1: if tokens[1].find('VERSION') != -1: if tokens[1].find('PREVIOUS') != -1: boost_old_install_version = tokens[2] else: boost_new_install_version = tokens[2] else: # URL_HASH if tokens[1].find('PREVIOUS') != -1: boost_old_install_url_hash = tokens[2] else: boost_new_install_url_hash = tokens[2] elif tokens[1].find('TRACKED_EIGEN') != -1: if tokens[1].find('PREVIOUS') != -1: eigen_old_version = tokens[2] else: eigen_new_version = tokens[2] elif tokens[1].find('INSTALL_EIGEN') != -1: if tokens[1].find('VERSION') != -1: if tokens[1].find('PREVIOUS') != -1: eigen_old_install_version = tokens[2] else: eigen_new_install_version = tokens[2] else: # URL_HASH if tokens[1].find('PREVIOUS') != -1: eigen_old_install_url_hash = tokens[2] else: eigen_new_install_url_hash = tokens[2] elif tokens[1].find('MADNESS') != -1 and tokens[1].find('_TAG') != -1: if tokens[1].find('PREVIOUS') != -1: madness_old_tag = tokens[2] else: madness_new_tag = tokens[2] elif tokens[1].find('MADNESS') != -1 and tokens[1].find('_VERSION') != -1: if tokens[1].find('PREVIOUS') != -1: madness_old_version = tokens[2] else: madness_new_version = tokens[2] elif tokens[1].find('BTAS') != -1: if tokens[1].find('PREVIOUS') != -1: btas_old_tag = tokens[2] else: btas_new_tag = tokens[2] elif tokens[1].find('CUTT') != -1: if tokens[1].find('PREVIOUS') != -1: cutt_old_tag = tokens[2] else: cutt_new_tag = tokens[2] elif tokens[1].find('UMPIRE') != -1: if tokens[1].find('PREVIOUS') != -1: umpire_old_tag = tokens[2] else: umpire_new_tag = tokens[2] elif tokens[1].find('BLACSPP') != -1: if tokens[1].find('PREVIOUS') != -1: blacspp_old_tag = tokens[2] else: blacspp_new_tag = tokens[2] elif tokens[1].find('SCALAPACKPP') != -1: if tokens[1].find('PREVIOUS') != -1: scalapackpp_old_tag = tokens[2] else: scalapackpp_new_tag = tokens[2] any_files_changed = False # Boost version in INSTALL.md any_files_changed |= replace_dep_id(topsrc, 'md', 'Boost', boost_old_version, boost_new_version, 'boost.org/), version ', ' or higher') # Boost install version in boost.cmake any_files_changed |= replace_dep_id(topsrc, 'cmake', 'Boost', boost_old_install_version, boost_new_install_version, 'boostorg/release/', '/source/boost') any_files_changed |= replace_dep_id(topsrc, 'cmake', 'Boost', dots_to_undescores(boost_old_install_version), dots_to_undescores(boost_new_install_version), 'source/boost_', '.tar.gz') any_files_changed |= replace_dep_id(topsrc, 'cmake', 'Boost', boost_old_install_url_hash, boost_new_install_url_hash, 'SHA256=', '') # Eigen version in INSTALL.md any_files_changed |= replace_dep_id(topsrc, 'md', 'Eigen', eigen_old_version, eigen_new_version, 'eigen.tuxfamily.org), version ', ' or higher') # Eigen install version in eigen.cmake any_files_changed |= replace_dep_id(topsrc, 'cmake', 'Eigen', eigen_old_install_version, eigen_new_install_version, 'bitbucket.org/eigen/eigen/get/', '.tar.bz2') any_files_changed |= replace_dep_id(topsrc, 'cmake', 'Eigen', eigen_old_install_url_hash, eigen_new_install_url_hash, 'MD5=', '') # MADNESS version in tiledarray-config.cmake.in any_files_changed |= replace_dep_id(topsrc, 'cmake.in', 'MADNESS', madness_old_version, madness_new_version, 'find_package(MADNESS ', ' ') # MADNESS tag in INSTALL.md any_files_changed |= replace_dep_id(topsrc, 'md', 'MADNESS', madness_old_tag, madness_new_tag, 'm-a-d-n-e-s-s/madness), tag ', ' ') # BTAS tag in INSTALL.md any_files_changed |= replace_dep_id(topsrc, 'md', 'BTAS', btas_old_tag, btas_new_tag, 'BTAS/BTAS), tag ', '') # cuTT tag in INSTALL.md any_files_changed |= replace_dep_id(topsrc, 'md', 'cuTT', cutt_old_tag, cutt_new_tag, '', '') # Umpire tag in INSTALL.md any_files_changed |= replace_dep_id(topsrc, 'md', 'Umpire', umpire_old_tag, umpire_new_tag, '', '') # BLACSPP tag in INSTALL.md any_files_changed |= replace_dep_id(topsrc, 'md', 'BLACSPP', blacspp_old_tag, blacspp_new_tag, '', '') # SCALAPACKPP tag in INSTALL.md any_files_changed |= replace_dep_id(topsrc, 'md', 'SCALAPACKPP', scalapackpp_old_tag, scalapackpp_new_tag, '', '') if any_files_changed: sys.exit(1) else: sys.exit(0) tiledarray-1.0.0/bin/build-eigen3-linux.sh000077500000000000000000000020361375455224000203730ustar00rootroot00000000000000#! /bin/sh # Exit on error set -ev # Install packages # Environment variables if [ "$CXX" = "g++" ]; then export CC=/usr/bin/gcc-$GCC_VERSION export CXX=/usr/bin/g++-$GCC_VERSION export EXTRACXXFLAGS="-mno-avx" else export CC=/usr/bin/clang-$CLANG_VERSION export CXX=/usr/bin/clang++-$CLANG_VERSION export EXTRACXXFLAGS="-mno-avx -stdlib=libc++" fi # Print compiler information $CC --version $CXX --version # log the CMake version (need 3+) cmake --version # Install Eigen3 unless previous install is cached ... must manually wipe cache on version bump or toolchain update export INSTALL_DIR=${INSTALL_PREFIX}/eigen3 if [ ! -d "${INSTALL_DIR}" ]; then cd ${BUILD_PREFIX} wget -q http://bitbucket.org/eigen/eigen/get/3.3.7.tar.bz2 tar -xjf 3.3.7.tar.bz2 cd eigen-* mkdir build cd build cmake .. -DCMAKE_CXX_COMPILER=$CXX \ -DCMAKE_C_COMPILER=$CC \ -DCMAKE_CXX_FLAGS="${EXTRACXXFLAGS}" \ -DCMAKE_INSTALL_PREFIX=${INSTALL_DIR} make install else echo "Eigen3 already installed ..." fi tiledarray-1.0.0/bin/build-linux.sh000077500000000000000000000126131375455224000172250ustar00rootroot00000000000000#! /bin/sh # get the most recent cmake available if [ ! -d "${INSTALL_PREFIX}/cmake" ]; then CMAKE_VERSION=3.17.0 CMAKE_URL="https://cmake.org/files/v${CMAKE_VERSION%.[0-9]}/cmake-${CMAKE_VERSION}-Linux-x86_64.tar.gz" mkdir ${INSTALL_PREFIX}/cmake && wget --no-check-certificate -O - ${CMAKE_URL} | tar --strip-components=1 -xz -C ${INSTALL_PREFIX}/cmake fi export PATH=${INSTALL_PREFIX}/cmake/bin:${PATH} cmake --version export PYTHON_EXECUTABLE=$(which python3) export TA_PYTHON=ON ${TRAVIS_BUILD_DIR}/bin/build-mpich-linux.sh ${TRAVIS_BUILD_DIR}/bin/build-scalapack-mpich-linux.sh ${TRAVIS_BUILD_DIR}/bin/build-madness-linux.sh ${TRAVIS_BUILD_DIR}/bin/build-eigen3-linux.sh # Exit on error set -ev # download latest Doxygen if [ "$DEPLOY" = "1" ]; then DOXYGEN_VERSION=1.8.17 if [ ! -d ${INSTALL_PREFIX}/doxygen-${DOXYGEN_VERSION} ]; then cd ${BUILD_PREFIX} && wget http://doxygen.nl/files/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz cd ${INSTALL_PREFIX} && tar xzf ${BUILD_PREFIX}/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz fi export PATH=${INSTALL_PREFIX}/doxygen-${DOXYGEN_VERSION}/bin:$PATH which doxygen doxygen --version fi # Environment variables if [ "$CXX" = "g++" ]; then export CC=/usr/bin/gcc-$GCC_VERSION export CXX=/usr/bin/g++-$GCC_VERSION export EXTRACXXFLAGS="-mno-avx" # if linking statically will need fortran libs to detect liblapacke.a in BTAS export F77=gfortran-$GCC_VERSION else export CC=/usr/bin/clang-$CLANG_VERSION export CXX=/usr/bin/clang++-$CLANG_VERSION export EXTRACXXFLAGS="-mno-avx -stdlib=libc++" # if linking statically will need fortran libs to detect liblapacke.a in BTAS export F77=gfortran-$GCC_VERSION fi export MPI_HOME=${INSTALL_PREFIX}/mpich export MPICC=$MPI_HOME/bin/mpicc export MPICXX=$MPI_HOME/bin/mpicxx export LD_LIBRARY_PATH=/usr/lib/lapack:/usr/lib/libblas:${INSTALL_PREFIX}/scalapack/lib:$LD_LIBRARY_PATH # list the prebuilt prereqs ls -l ${INSTALL_PREFIX} # where to install TA (need for testing installed code) export INSTALL_DIR=${INSTALL_PREFIX}/TA # make build dir cd ${BUILD_PREFIX} mkdir -p TA cd TA # if have old installed copy of TA, make sure that BTAS tag matches the required tag, if not, remove INSTALL_DIR (will cause rebuild of TA) if [ -f "${INSTALL_DIR}/include/btas/version.h" ]; then export INSTALLED_BTAS_TAG=`grep 'define BTAS_REVISION' ${INSTALL_DIR}/include/btas/version.h | awk '{print $3}' | sed s/\"//g` echo "installed BTAS revision = ${INSTALLED_BTAS_TAG}" # extract the tracked tag of BTAS export BTAS_TAG=`grep 'set(TA_TRACKED_BTAS_TAG ' ${TRAVIS_BUILD_DIR}/external/versions.cmake | awk '{print $2}' | sed s/\)//g` echo "required BTAS revision = ${BTAS_TAG}" if [ "${BTAS_TAG}" != "${INSTALLED_BTAS_TAG}" ]; then rm -rf "${INSTALL_DIR}" fi fi # MADNESS are build separately if $BUILD_TYPE=Debug, otherwise built as part of TA if [ "$BUILD_TYPE" = "Debug" ]; then if [ "$COMPUTE_COVERAGE" = "1" ]; then export CODECOVCXXFLAGS="-O0 --coverage" fi cmake ${TRAVIS_BUILD_DIR} \ -DCMAKE_TOOLCHAIN_FILE=cmake/vg/toolchains/travis.cmake \ -DCMAKE_CXX_COMPILER=$CXX \ -DCMAKE_C_COMPILER=$CC \ -DCMAKE_Fortran_COMPILER=$F77 \ -DMPI_CXX_COMPILER=$MPICXX \ -DMPI_C_COMPILER=$MPICC \ -DCMAKE_INSTALL_PREFIX="${INSTALL_DIR}" \ -DCMAKE_BUILD_TYPE=$BUILD_TYPE \ -DCMAKE_CXX_FLAGS="-ftemplate-depth=1024 -Wno-unused-command-line-argument ${EXTRACXXFLAGS} ${CODECOVCXXFLAGS}" \ -DCMAKE_PREFIX_PATH="${INSTALL_PREFIX}/madness;${INSTALL_PREFIX}/eigen3" \ -DPYTHON_EXECUTABLE="${PYTHON_EXECUTABLE}" \ -DTA_PYTHON="${TA_PYTHON}" \ -DTA_BUILD_UNITTEST=ON \ -DTA_ERROR="throw" \ -DENABLE_SCALAPACK=ON else # if have old installed copy of TA, make sure that MADNESS tag matches the required tag, if not, remove INSTALL_DIR (will cause rebuild of MADNESS) if [ -f "${INSTALL_DIR}/include/madness/config.h" ]; then export INSTALLED_MADNESS_TAG=`grep 'define MADNESS_REVISION' ${INSTALL_DIR}/include/madness/config.h | awk '{print $3}' | sed s/\"//g` echo "installed MADNESS revision = ${INSTALLED_MADNESS_TAG}" # extract the tracked tag of MADNESS export MADNESS_TAG=`grep 'set(TA_TRACKED_MADNESS_TAG ' ${TRAVIS_BUILD_DIR}/external/versions.cmake | awk '{print $2}' | sed s/\)//g` echo "required MADNESS revision = ${MADNESS_TAG}" if [ "${MADNESS_TAG}" != "${INSTALLED_MADNESS_TAG}" ]; then rm -rf "${INSTALL_DIR}" fi fi cmake ${TRAVIS_BUILD_DIR} \ -DCMAKE_TOOLCHAIN_FILE=cmake/vg/toolchains/travis.cmake \ -DCMAKE_CXX_COMPILER=$CXX \ -DCMAKE_C_COMPILER=$CC \ -DCMAKE_Fortran_COMPILER=$F77 \ -DMPI_CXX_COMPILER=$MPICXX \ -DMPI_C_COMPILER=$MPICC \ -DCMAKE_INSTALL_PREFIX="${INSTALL_DIR}" \ -DCMAKE_BUILD_TYPE=$BUILD_TYPE \ -DCMAKE_CXX_FLAGS="-ftemplate-depth=1024 -Wno-unused-command-line-argument ${EXTRACXXFLAGS}" \ -DCMAKE_PREFIX_PATH="${INSTALL_PREFIX}/eigen3" \ -DPYTHON_EXECUTABLE="${PYTHON_EXECUTABLE}" \ -DTA_PYTHON="${TA_PYTHON}" \ -DTA_BUILD_UNITTEST=ON \ -DTA_ERROR="throw" \ -DENABLE_SCALAPACK=ON fi # Build all libraries, examples, and applications make -j2 all VERBOSE=1 make install # Validate make -j1 ta_test VERBOSE=1 export MAD_NUM_THREADS=2 # to find dep shared libs (do we need this since El is gone?) export LD_LIBRARY_PATH=${INSTALL_PREFIX}/TA/lib:${INSTALL_PREFIX}/madness/lib:${LD_LIBRARY_PATH} make check # Build examples make -j2 examples VERBOSE=1 tiledarray-1.0.0/bin/build-madness-linux.sh000077500000000000000000000053311375455224000206540ustar00rootroot00000000000000#! /bin/sh # Exit on error set -ev # Will build MADNESS stand-alone for Debug builds only if [ "$BUILD_TYPE" = "Debug" ]; then # Environment variables if [ "$CXX" = "g++" ]; then export CC=/usr/bin/gcc-$GCC_VERSION export CXX=/usr/bin/g++-$GCC_VERSION export EXTRACXXFLAGS="-mno-avx" export F77=gfortran-$GCC_VERSION else export CC=/usr/bin/clang-$CLANG_VERSION export CXX=/usr/bin/clang++-$CLANG_VERSION export EXTRACXXFLAGS="-mno-avx -stdlib=libc++" export F77=gfortran-$GCC_VERSION fi export MPI_HOME=${INSTALL_PREFIX}/mpich export MPICC=$MPI_HOME/bin/mpicc export MPICXX=$MPI_HOME/bin/mpicxx export LD_LIBRARY_PATH=/usr/lib/lapack:/usr/lib/libblas:$LD_LIBRARY_PATH # list the prebuilt prereqs ls -l ${INSTALL_PREFIX} # where to install MADNESS (need for testing installed code) export INSTALL_DIR=${INSTALL_PREFIX}/madness # extract the tracked tag of MADNESS export MADNESS_TAG=`grep 'set(TA_TRACKED_MADNESS_TAG ' ${TRAVIS_BUILD_DIR}/external/versions.cmake | awk '{print $2}' | sed s/\)//g` echo "required MADNESS revision = ${MADNESS_TAG}" # make sure installed MADNESS tag matches the required tag, if not, remove INSTALL_DIR (will cause reinstall) if [ -f "${INSTALL_DIR}/include/madness/config.h" ]; then export INSTALLED_MADNESS_TAG=`grep 'define MADNESS_REVISION' ${INSTALL_DIR}/include/madness/config.h | awk '{print $3}' | sed s/\"//g` echo "installed MADNESS revision = ${INSTALLED_MADNESS_TAG}" if [ "${MADNESS_TAG}" != "${INSTALLED_MADNESS_TAG}" ]; then rm -rf "${INSTALL_DIR}" fi fi if [ ! -d "${INSTALL_DIR}" ]; then # make build dir cd ${BUILD_PREFIX} mkdir -p madness cd madness # check out the tracked tag of MADNESS git clone https://github.com/m-a-d-n-e-s-s/madness madness_src && cd madness_src && git checkout ${MADNESS_TAG} && cd .. cmake madness_src \ -DCMAKE_TOOLCHAIN_FILE="${TRAVIS_BUILD_DIR}/cmake/toolchains/travis.cmake" \ -DCMAKE_CXX_COMPILER=$CXX \ -DCMAKE_C_COMPILER=$CC \ -DMPI_CXX_COMPILER=$MPICXX \ -DMPI_C_COMPILER=$MPICC \ -DCMAKE_INSTALL_PREFIX="${INSTALL_DIR}" \ -DCMAKE_BUILD_TYPE=$BUILD_TYPE \ -DCMAKE_CXX_FLAGS="-ftemplate-depth=1024 -Wno-unused-command-line-argument ${EXTRACXXFLAGS}" \ -DENABLE_MPI=ON \ -DMPI_THREAD=multiple \ -DENABLE_TBB=OFF \ -DTBB_ROOT_DIR=/usr \ -DENABLE_MKL=OFF \ -DFORTRAN_INTEGER_SIZE=4 \ -DENABLE_LIBXC=OFF \ -DENABLE_GPERFTOOLS=OFF \ -DASSERTION_TYPE=throw \ -DDISABLE_WORLD_GET_DEFAULT=ON # Build MADworld + LAPACK/BLAS interface make -j2 install-madness-world install-madness-clapack install-madness-common install-madness-config VERBOSE=1 fi fi tiledarray-1.0.0/bin/build-mpich-linux.sh000077500000000000000000000023531375455224000203230ustar00rootroot00000000000000#! /bin/sh # Exit on error set -ev # Install packages # always use gcc to compile MPICH, there are unexplained issues with clang (e.g. MPI_Barrier aborts) export CC=/usr/bin/gcc-$GCC_VERSION export CXX=/usr/bin/g++-$GCC_VERSION export FC=/usr/bin/gfortran-$GCC_VERSION # Print compiler information $CC --version $CXX --version $FC --version # log the CMake version (need 3+) cmake --version # Install MPICH unless previous install is cached ... must manually wipe cache on version bump or toolchain update export INSTALL_DIR=${INSTALL_PREFIX}/mpich if [ ! -d "${INSTALL_DIR}" ]; then cd ${BUILD_PREFIX} export MPICH_VERSION=3.3 wget --no-check-certificate -q http://www.mpich.org/static/downloads/${MPICH_VERSION}/mpich-${MPICH_VERSION}.tar.gz tar -xzf mpich-${MPICH_VERSION}.tar.gz cd mpich-${MPICH_VERSION} ./configure FC=$FC CC=$CC CXX=$CXX --prefix=${INSTALL_DIR} make -j2 make install ${INSTALL_DIR}/bin/mpichversion ${INSTALL_DIR}/bin/mpicc -show ${INSTALL_DIR}/bin/mpicxx -show ${INSTALL_DIR}/bin/mpifort -show else echo "MPICH installed..." find ${INSTALL_DIR} -name mpiexec find ${INSTALL_DIR} -name mpicc find ${INSTALL_DIR} -name mpicxx find ${INSTALL_DIR} -name mpifort fi tiledarray-1.0.0/bin/build-scalapack-mpich-linux.sh000077500000000000000000000027701375455224000222460ustar00rootroot00000000000000#! /bin/sh # Exit on error set -ev # always use gcc, just like mpich ... ? export CC=/usr/bin/gcc-$GCC_VERSION export CXX=/usr/bin/g++-$GCC_VERSION export FC=/usr/bin/gfortran-$GCC_VERSION # Print compiler information $CC --version $CXX --version $FC --version # log the CMake version (need 3+) cmake --version # Install MPICH unless previous install is cached ... must manually wipe cache on version bump or toolchain update export INSTALL_DIR=${INSTALL_PREFIX}/scalapack if [ ! -d "${INSTALL_DIR}" ]; then # Make sure MPI is built ${INSTALL_PREFIX}/mpich/bin/mpichversion ${INSTALL_PREFIX}/mpich/bin/mpicc -show ${INSTALL_PREFIX}/mpich/bin/mpicxx -show ${INSTALL_PREFIX}/mpich/bin/mpif90 -show cd ${BUILD_PREFIX} git clone https://github.com/Reference-ScaLAPACK/scalapack.git cd scalapack git checkout 0efeeb6d2ec9faf0f2fd6108de5eda60773cdcf9 # checked revision cmake -H. -Bbuild_scalapack \ -DCMAKE_C_COMPILER=$CC \ -DCMAKE_Fortran_COMPILER=$FC \ -DMPI_C_COMPILER=${INSTALL_PREFIX}/mpich/bin/mpicc \ -DMPI_Fortran_COMPILER=${INSTALL_PREFIX}/mpich/bin/mpif90 \ -DCMAKE_TOOLCHAIN_FILE="${TRAVIS_BUILD_DIR}/cmake/toolchains/travis.cmake" \ -DCMAKE_PREFIX_PATH=${INSTALL_DIR} \ -DCMAKE_INSTALL_PREFIX=${INSTALL_DIR} cmake --build build_scalapack -j2 cmake --build build_scalapack --target install find ${INSTALL_DIR} -name libscalapack.so else echo "ScaLAPACK installed..." find ${INSTALL_DIR} -name libscalapack.so fi tiledarray-1.0.0/bin/deploy-linux.sh000077500000000000000000000037511375455224000174250ustar00rootroot00000000000000#! /bin/sh # Exit on error set -ev git config --global user.email "travis@travis-ci.org" git config --global user.name "Travis CI" # only non-cron job deploys RUN=1 if [ "$TRAVIS_EVENT_TYPE" = "cron" ] || [ "$TRAVIS_BRANCH" != "master" ]; then RUN=0 fi if [ "$RUN" = "0" ]; then echo "Deployment skipped" exit 0 fi # deploy from the build area cd ${BUILD_PREFIX}/TA ### deploy docs # see https://gist.github.com/willprice/e07efd73fb7f13f917ea # build docs export VERBOSE=1 cmake --build . --target html if [ ! -f "${BUILD_PREFIX}/TA/doc/dox/html/index.html" ]; then echo "Target html built successfully but did not produce index.html" exit 1 fi # check out current docs + template git clone --depth=1 https://github.com/ValeevGroup/tiledarray.git --branch gh-pages --single-branch tiledarray-docs-current git clone --depth=1 https://github.com/ValeevGroup/tiledarray.git --branch gh-pages-template --single-branch tiledarray-docs-template mkdir tiledarray-docs cp -rp tiledarray-docs-current/* tiledarray-docs rm -rf tiledarray-docs-current cp -rp tiledarray-docs-template/* tiledarray-docs rm -rf tiledarray-docs-template cd tiledarray-docs # copy TA's README.md into index.md cp ${TRAVIS_BUILD_DIR}/README.md index.md # update dox if [ -d dox-master ]; then rm -rf dox-master fi mv ${BUILD_PREFIX}/TA/doc/dox/html dox-master # Jekyll does not allow files with "special" names, e.g. whose names start with underscore # must "include" such files explicitly # re: how file names must be formatted: see https://github.com/jekyll/jekyll/issues/1352 echo "include:" >> _config.yml find dox-master -name "_*" | sed "s/dox-master\// \- /g" >> _config.yml # make empty repo to ensure gh-pages contains no history git init git add * git commit -a -q -m "rebuilt TA master docs via Travis build: $TRAVIS_BUILD_NUMBER" git checkout -b gh-pages git remote add origin https://${GH_TILEDARRAY_TOKEN}@github.com/ValeevGroup/tiledarray.git > /dev/null 2>&1 git push origin +gh-pages --force cd .. rm -rf tiledarray-docs tiledarray-1.0.0/bin/docker-build.sh000077500000000000000000000052261375455224000173370ustar00rootroot00000000000000#!/bin/sh # this script builds a TiledArray docker image # to run bash in the image: docker run --privileged -i -t tiledarray-dev:latest /sbin/my_init -- bash -l # see docker.md for further instructions # locations: # - source dir: /usr/local/src/tiledarray # - build dir: /usr/local/src/tiledarray/build # - installed headers dir: /usr/local/include/tiledarray # - installed libraries dir: /usr/local/lib, e.g. /usr/local/lib/libtiledarray.a export CMAKE_VERSION=3.17.0 ############################################################## # make Dockerfile, if missing cat > Dockerfile << END # Use phusion/baseimage as base image. To make your builds # reproducible, make sure you lock down to a specific version, not # to 'latest'! See # https://github.com/phusion/baseimage-docker/blob/master/Changelog.md # for a list of version numbers. FROM phusion/baseimage:0.11 # Use baseimage-docker's init system. CMD ["/sbin/my_init"] # update the OS RUN apt-get update && apt-get upgrade -y -o Dpkg::Options::="--force-confold" # build TiledArray # 1. basic prereqs RUN apt-get update && apt-get install -y python3 ninja-build liblapacke-dev liblapack-dev mpich libboost-dev libeigen3-dev git wget libboost-serialization-dev libunwind-dev clang-8 libc++-8-dev libc++abi-8-dev python3 python3-pip python3-test python3-numpy && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* # 2. recent cmake RUN CMAKE_URL="https://cmake.org/files/v${CMAKE_VERSION%.[0-9]}/cmake-${CMAKE_VERSION}-Linux-x86_64.tar.gz" && wget --no-check-certificate -O - \$CMAKE_URL | tar --strip-components=1 -xz -C /usr/local ENV CMAKE=/usr/local/bin/cmake # 3. download and build TiledArray RUN cd /usr/local/src && git clone --depth=1 https://github.com/ValeevGroup/tiledarray.git && cd /usr/local/src/tiledarray && mkdir build && cd build && \$CMAKE .. -G Ninja -DCMAKE_CXX_COMPILER=clang++-8 -DCMAKE_C_COMPILER=clang-8 -DTA_BUILD_UNITTEST=ON -DCMAKE_INSTALL_PREFIX=/usr/local -DCMAKE_BUILD_TYPE=RelWithDebInfo && \$CMAKE --build . --target tiledarray && \$CMAKE --build . --target check && $CMAKE --build . --target examples && \$CMAKE --build . --target install # Clean up APT when done. RUN apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* END function clean_up { rm -f Dockerfile exit } trap clean_up SIGHUP SIGINT SIGTERM ############################################################## # build a dev image docker build -t tiledarray-dev . ############################################################## # extra admin tasks, uncomment as needed # docker save tiledarray-dev | bzip2 > tiledarray-dev.docker.tar.bz2 ############################################################## # done clean_up tiledarray-1.0.0/bin/docker-cuda-build.sh000077500000000000000000000045111375455224000202450ustar00rootroot00000000000000#!/bin/sh # this script builds a TiledArray/CUDA docker image # to run bash in the image: docker run --privileged -i -t tiledarray-cuda-dev:latest -- bash -l # see docker.md for further instructions # locations: # - source dir: /usr/local/src/tiledarray # - build dir: /usr/local/src/tiledarray/build # - installed headers dir: /usr/local/include/tiledarray # - installed libraries dir: /usr/local/lib, e.g. /usr/local/lib/libtiledarray.a export CMAKE_VERSION=3.17.0 ############################################################## # make Dockerfile, if missing cat > Dockerfile << END FROM nvidia/cuda:latest # Use baseimage-docker's init system. CMD ["/sbin/my_init"] # update the OS RUN apt-get update && apt-get upgrade -y -o Dpkg::Options::="--force-confold" # build TiledArray # 1. basic prereqs RUN apt-get update && apt-get install -y python3 python3-pip python3-test python3-numpy ninja-build liblapacke-dev liblapack-dev mpich libboost-dev libeigen3-dev git wget libboost-serialization-dev libunwind-dev && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* # 2. recent cmake RUN CMAKE_URL="https://cmake.org/files/v${CMAKE_VERSION%.[0-9]}/cmake-${CMAKE_VERSION}-Linux-x86_64.tar.gz" && wget --no-check-certificate -O - \$CMAKE_URL | tar --strip-components=1 -xz -C /usr/local ENV CMAKE=/usr/local/bin/cmake # 3. download and build TiledArray RUN cd /usr/local/src && git clone --depth=1 https://github.com/ValeevGroup/tiledarray.git && cd /usr/local/src/tiledarray && mkdir build && cd build && \$CMAKE .. -G Ninja -DCMAKE_CXX_COMPILER=g++ -DCMAKE_C_COMPILER=gcc -DCMAKE_INSTALL_PREFIX=/usr/local -DENABLE_CUDA=ON -DCMAKE_BUILD_TYPE=RelWithDebInfo && \$CMAKE --build . --target tiledarray && \$CMAKE --build . --target examples && \$CMAKE --build . --target install # Clean up APT when done. RUN apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* END function clean_up { rm -f Dockerfile exit } trap clean_up SIGHUP SIGINT SIGTERM ############################################################## # build a cuda-dev image docker build -t tiledarray-cuda-dev . ############################################################## # extra admin tasks, uncomment as needed # docker save tiledarray-cuda-dev | bzip2 > tiledarray-cuda-dev.docker.tar.bz2 ############################################################## # done clean_up tiledarray-1.0.0/bin/docker-cuda.md000066400000000000000000000017031375455224000171330ustar00rootroot00000000000000# Intro These notes describe how to build TiledArray with CUDA support enabled within the latest nvidia/cuda Docker image (https://hub.docker.com/r/nvidia/cuda/). This is useful for experimentation and/or provisioning computational results (e.g. for creating supplementary info for a journal article). If you want to use Docker to run/debug Travis-CI jobs, see [docker-travis.md](docker-travis.md) # Using These notes assume that Docker 19.03 and NVIDIA Container Toolkit (https://github.com/NVIDIA/nvidia-docker) are installed on your machine and that you start at the top of the TiledArray source tree. ## Create/build Docker TA/CUDA image 1. Create a Docker image: `bin/docker-cuda-build.sh` 2. Run a container using the newly created image: `docker run --privileged -i -t --rm tiledarray-cuda-dev:latest bash -l` ## Notes - Important locations: - source: `/usr/local/src/tiledarray` - build: `/usr/local/src/tiledarray/build` - install: `/usr/local` tiledarray-1.0.0/bin/docker-travis-build.sh000077500000000000000000000061261375455224000206450ustar00rootroot00000000000000#!/bin/sh # this script builds a 'Bionic' env docker image used by Travis-CI for TiledArray project # # to run bash in the image: docker run -it tiledarray-travis-debug bash -l # see docker-travis.md for further instructions # N.B. relevant locations: # - source dir: /home/travis/build/ValeevGroup/tiledarray (TRAVIS_BUILD_DIR env in Travis jobs) # - build dir: /home/travis/_build # - install dir: /home/travis/_install # this is where in the container file system Travis-CI "starts" export TRAVIS_BUILD_TOPDIR=/home/travis/build export DIRNAME=`dirname $0` export ABSDIRNAME=`pwd $DIRNAME` ############################################################## # make a script to download all prereqs and clone TiledArray repo setup=setup.sh cat > $setup << END #!/bin/sh curl -sSL "http://apt.llvm.org/llvm-snapshot.gpg.key" | apt-key add - echo "deb http://apt.llvm.org/bionic/ llvm-toolchain-bionic-9 main" | tee -a /etc/apt/sources.list > /dev/null apt-add-repository -y "ppa:ubuntu-toolchain-r/test" apt-get -yq update >> ~/apt-get-update.log apt-get -yq --no-install-suggests --no-install-recommends --force-yes install g++-7 g++-8 gfortran-7 gfortran-8 libboost-all-dev libblas-dev liblapack-dev liblapacke-dev libtbb-dev clang-8 clang-9 cmake cmake-data doxygen graphviz fonts-liberation \ python3 python3-pip python3-pytest python3-numpy mkdir -p ${TRAVIS_BUILD_TOPDIR} cd ${TRAVIS_BUILD_TOPDIR} git clone https://github.com/ValeevGroup/tiledarray.git ${TRAVIS_BUILD_TOPDIR}/ValeevGroup/tiledarray END chmod +x $setup ############################################################## # make a script to build all extra prereqs once in the container build=build.sh cat > $build << END #!/bin/sh cd /home/travis/_build export BUILD_PREFIX=/home/travis/_build export INSTALL_PREFIX=/home/travis/_install export TRAVIS_BUILD_DIR=${TRAVIS_BUILD_TOPDIR}/ValeevGroup/tiledarray export TRAVIS_EVENT_TYPE=cron export TRAVIS_OS_NAME=linux \${TRAVIS_BUILD_DIR}/bin/build-\$TRAVIS_OS_NAME.sh END chmod +x $build ############################################################## # make Dockerfile cat > Dockerfile << END # Travis default 'Bionic' image FROM travisci/ci-ubuntu-1804:packer-1582574251-a9b1ae58 # Use baseimage-docker's init system. CMD ["/sbin/my_init"] # create source, build, and install dirs RUN mkdir -p /home/travis/_build RUN mkdir -p /home/travis/_install # install prereqs ADD $setup /home/travis/_build/$setup RUN /home/travis/_build/$setup # Clean up APT when done. RUN apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* # copy travis scripts ADD $build /home/travis/_build/$build # for further info ... RUN echo "\e[92mDone! For info on how to use the image refer to $ABSDIRNAME/docker-travis.md\e[0m" END function clean_up { rm -f $setup $build Dockerfile exit } trap clean_up SIGHUP SIGINT SIGTERM ############################################################## # build a dev image docker build -t tiledarray-travis-debug . ############################################################## # extra admin tasks, uncomment as needed ############################################################## # done clean_up tiledarray-1.0.0/bin/docker-travis.md000066400000000000000000000065151375455224000175350ustar00rootroot00000000000000# Intro These notes describe how to build TiledArray within the latest Travis-CI Docker image. This is useful for debugging Travis-CI jobs on your local machine. # Using These notes assume that Docker is installed on your machine and that you start at the top of the TiledArray source tree. ## Create/build Docker Travis image 1. Create a Travis-CI docker image: `cd bin; ./docker-travis-build.sh` 2. Run a container using the newly created image: `docker run -it tiledarray-travis-debug bash -l` 3. `cd /home/travis/_build` 4. Configure the job to use the appropriate compiler, compiler version, and debug/release build type: * `export BUILD_TYPE=B`, where `B` is `Debug` or `Release`. * If want to use GNU C++ compiler (gcc): * `export GCC_VERSION=VVV` where `VVV` should be the GCC version to be used. The currently valid values are `7`, `8` and `9`. * `export CXX=g++` * If want to use Clang C++ compiler (clang++): * `export GCC_VERSION=8` * `export CLANG_VERSION=VVV` where `VVV` should be the Clang version to be used. The currently valid values are `8` and `9`. * `export CXX=clang++` * `apt-get update && apt-get install libc++-${CLANG_VERSION}-dev libc++abi-${CLANG_VERSION}-dev` 5. Build prerequisites (MPICH, MADNESS, ScaLAPACK), TiledArray, and run tests: `./build.sh` ## Notes * According to [Travis-CI docs](https://docs.travis-ci.com/user/reference/overview/) you want to configure your Docker to run containers with 2 cores and 7.5 GB of RAM to best match the production environment. * If you plan to use this container multiple times it might make sense to take a snapshot at this point to avoid having to recompile the prerequisites each and every time. Store it as a separate image, e.g. `docker commit container_id tiledarray-travis-debug:clang-debug`, where `container_id` can be found in the output of `docker ps`. Next time to start debugging you will need to pull updates to the TiledArray source (do `cd /home/travis/build/ValeevGroup/tiledarray && git pull`), then execute step 2 with the new image name, execute step 3, and go directly to step 6. * To install `gdb` execute `apt-get update && apt-get install gdb`. Also, it appears that to be able to attach `gdb` or any other debugger to a running process you must run the Docker container in privileged mode as `docker run --privileged -it tiledarray-travis-debug:clang-debug bash -l`. * To debug parallel jobs you want to launch jobs in a gdb in an xterm. To run xterm you need to ssh into the container. To start an ssh server in the container do this: * Connect sshd's port of the container (22) to an unprivileged port (say, 2222) of the host: `docker run -p 127.0.0.1:2222:22 --privileged -it tiledarray-travis-debug:clang-debug bash -l` * Generate host keys: `ssh-keygen -A` * Create a root password: `passwd` and follow prompts. No need to be fancy: security is not a concern here, but `passwd` will not accept an empty password. N.B. This is easier than setting up a pubkey login, so don't bother with that. * Edit `/etc/ssh/sshd_config` and allow root to log in by ensuring that `PermitRootLogin` and `PasswordAuthentication` are set to `yes`. * Start ssh server: `/etc/init.d/ssh start` * (optional) To launch gdb in xterm windows: `apt-get update && apt-get install xterm` * You should be able to log in from an xterm on the host side: `ssh -Y -p 2222 root@localhost` tiledarray-1.0.0/bin/docker.md000066400000000000000000000015371375455224000162260ustar00rootroot00000000000000# Intro These notes describe how to build TiledArray within the latest phusion (https://github.com/phusion/baseimage-docker) Docker image. This is useful for experimentation and/or provisioning computational results (e.g. for creating supplementary info for a journal article). If you want to use Docker to run/debug Travis-CI jobs, see [docker-travis.md](docker-travis.md) # Using These notes assume that Docker is installed on your machine and that you start at the top of the TiledArray source tree. ## Create/build Docker TA image 1. Create a Docker image: `bin/docker-build.sh` 2. Run a container using the newly created image: `docker run --privileged -i -t --rm tiledarray-dev:latest /sbin/my_init -- bash -l` ## Notes - Important locations: - source: `/usr/local/src/tiledarray` - build: `/usr/local/src/tiledarray/build` - install: `/usr/local` tiledarray-1.0.0/cmake/000077500000000000000000000000001375455224000147375ustar00rootroot00000000000000tiledarray-1.0.0/cmake/modules/000077500000000000000000000000001375455224000164075ustar00rootroot00000000000000tiledarray-1.0.0/cmake/modules/AddCustomTargetSubproject.cmake000066400000000000000000000035521375455224000245110ustar00rootroot00000000000000# Copyright 2020 Eduard F Valeyev # Distributed under the OSI-approved BSD 3-Clause License. # See https://opensource.org/licenses/BSD-3-Clause for details. # copy of https://github.com/BTAS/BTAS/blob/master/cmake/modules/AddCustomTargetSubproject.cmake # # add_custom_target_subproject(proj X ...) defines custom target X-proj and # - if target X already exists, makes it depend on X-proj # - else creates target X depending on X-proj # # use case: if custom target names (e.g. "check", "doc", etc.) clash # with other project's target when used as a subproject # # example: add_custom_target_subproject(myproject check USES_TERMINAL COMMAND ${CMAKE_CTEST_COMMAND} -V) # macro(add_custom_target_subproject _subproj _name) set(extra_args "${ARGN}") add_custom_target(${_name}-${_subproj} ${extra_args}) # does the newly-created target get compiled by default? list(FIND extra_args "ALL" extra_args_has_all) if (NOT (extra_args_has_all EQUAL -1)) set (target_built_by_default ON) endif() if (TARGET ${_name}) # is existing target ${_name} also compiled by default? # warn if not, but this project's target is since that # may indicate inconsistent creation of generic targets get_target_property(supertarget_not_built_by_default ${_name} EXCLUDE_FROM_ALL) if (target_built_by_default AND supertarget_not_built_by_default) message(WARNING "Created target ${_name}-${_subproj} is built by default but \"super\"-target ${_name} is not; perhaps it should be?") endif() add_dependencies(${_name} ${_name}-${_subproj}) else (TARGET ${_name}) # use ALL if given if (target_built_by_default) add_custom_target(${_name} ALL DEPENDS ${_name}-${_subproj}) else (target_built_by_default) add_custom_target(${_name} DEPENDS ${_name}-${_subproj}) endif(target_built_by_default) endif (TARGET ${_name}) endmacro() tiledarray-1.0.0/cmake/modules/AddTAExecutable.cmake000066400000000000000000000002641375455224000223320ustar00rootroot00000000000000macro(add_ta_executable _name _source_files _libs) add_executable(${_name} EXCLUDE_FROM_ALL "${_source_files}") target_link_libraries(${_name} PRIVATE "${_libs}") endmacro() tiledarray-1.0.0/cmake/modules/AppendFlags.cmake000066400000000000000000000002761375455224000216020ustar00rootroot00000000000000macro(append_flags _flags _append_flag) string(STRIP "${_append_flag}" _append_flag ) set(${_flags} "${${_flags}} ${_append_flag}") string(STRIP "${${_flags}}" ${_flags}) endmacro() tiledarray-1.0.0/cmake/modules/CheckCFortranFunctionExists.cmake000066400000000000000000000007521375455224000247770ustar00rootroot00000000000000include(CheckFunctionExists) macro(check_c_fortran_function_exists _func_base _result) string(TOLOWER "${_func_base}" _func_base_lower) string(TOUPPER "${_func_base}" _func_base_upper) set(${_result} FALSE) foreach(_func ${_func_base_lower}_;${_func_base_lower};${_func_base_lower}__;${_func_base_upper};${_func_base_upper}_) check_function_exists(${_func} _${_func}_found) if(_${_func}_found) set(${_result} TRUE) break() endif() endforeach() endmacro() tiledarray-1.0.0/cmake/modules/ConvertIncludesListToCompilerArgs.cmake000066400000000000000000000023331375455224000261700ustar00rootroot00000000000000# # This file is a part of TiledArray. # Copyright (C) 2013 Virginia Tech # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . # # Justus Calvin # Department of Chemistry, Virginia Tech # # ConvertIncludesListToCompileArgs.cmake # Sep 4, 2013 # # # converts a list of include paths (second argument, don't forget to enclose the # list in quotes) into a list of command-line parameters to the compiler/. # macro(convert_incs_to_compargs _args _inc_paths ) # transform library list into compiler args # Add include paths to _args foreach(_inc_path ${_inc_paths}) set(${_args} "${${_args}} -I${_inc_path}") endforeach() endmacro() tiledarray-1.0.0/cmake/modules/ConvertLibrariesListToCompilerArgs.cmake000066400000000000000000000032561375455224000263430ustar00rootroot00000000000000# # This file is a part of TiledArray. # Copyright (C) 2013 Virginia Tech # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . # # Justus Calvin # Department of Chemistry, Virginia Tech # # ConvertLibrariesListToCompilerArgs.cmake # Jul 19, 2013 # # # Converts a list of libraries (second argument, don't forget to enclose the # list in quotes) into a list of command-line parameters to the compiler/linker. # macro(convert_libs_to_compargs _args _libs ) # transform library list into compiler args foreach (_lib ${_libs}) get_filename_component(_ext ${_lib} EXT) get_filename_component(_libname ${_lib} NAME_WE) if(APPLE AND "${_ext}" STREQUAL ".framework") # Handle Apple Frameworks get_filename_component(_path ${_lib} PATH) if(${_path} STREQUAL "/System/Library/Frameworks") set(MAD_LIBS "${${_args}} -F${_path} -framework ${_libname}") else() set(MAD_LIBS "${${_args}} -framework ${_libname}") endif() else() # Handle the general case set(MAD_LIBS "${${_args}} ${_lib}") endif() endforeach() endmacro() tiledarray-1.0.0/cmake/modules/DetectMADNESSConfig.cmake000066400000000000000000000051121375455224000227610ustar00rootroot00000000000000include(CheckCXXSourceCompiles) include(CMakePushCheckState) macro (detect_MADNESS_configuration) cmake_push_check_state() set(CMAKE_REQUIRED_QUIET) # only extract include dirs, don't use MADworld target directly since it may have not been built yet # unfortunately this is not easy to check since the target is defined but not ready get_property(_MADNESS_INCLUDE_DIRS TARGET MADworld PROPERTY INTERFACE_INCLUDE_DIRECTORIES) # some targets don't even exist in the build tree (El) so filter them out and cache the result if (TARGET El) set(MADNESS_INTERNAL_INCLUDE_DIRS ) foreach(_inc ${_MADNESS_INCLUDE_DIRS}) if (NOT (${_inc} MATCHES "El")) list(APPEND MADNESS_INTERNAL_INCLUDE_DIRS ${_inc}) endif() endforeach() else() set(MADNESS_INTERNAL_INCLUDE_DIRS ${_MADNESS_INCLUDE_DIRS}) endif() set(MADNESS_INTERNAL_INCLUDE_DIRS "${MADNESS_INTERNAL_INCLUDE_DIRS}" CACHE STRING "Sanitized list of MADNESS include directories usable in build tree") list(APPEND CMAKE_REQUIRED_INCLUDES ${MADNESS_INTERNAL_INCLUDE_DIRS}) if (NOT DEFINED MADNESS_HAS_MKL) CHECK_CXX_SOURCE_COMPILES( " #include #ifndef HAVE_INTEL_MKL # error \"MADNESS does not have MKL\" #endif int main(int argc, char** argv) { return 0; } " MADNESS_HAS_MKL) endif() if (MADNESS_HAS_MKL) unset(MADNESS_HAS_MKL) set(MADNESS_HAS_MKL ON CACHE BOOL "MADNESS detected usable Intel MKL" FORCE) endif() if (NOT DEFINED MADNESS_HAS_TBB) CHECK_CXX_SOURCE_COMPILES( " #include #ifndef HAVE_INTEL_TBB # error \"MADNESS does not have TBB\" #endif int main(int argc, char** argv) { return 0; } " MADNESS_HAS_TBB) endif() if (MADNESS_HAS_TBB) unset(MADNESS_HAS_TBB) set(MADNESS_HAS_TBB ON CACHE BOOL "MADNESS detected usable Intel TBB" FORCE) endif() if (NOT DEFINED MADNESS_FORTRAN_DEFAULT_INTEGER4) CHECK_CXX_SOURCE_COMPILES( " #include #if MADNESS_FORTRAN_DEFAULT_INTEGER_SIZE != 4 # error \"MADNESS does not assume integer*4 for Fortran BLAS/LAPACK interfaces\" #endif int main(int argc, char** argv) { return 0; } " MADNESS_FORTRAN_DEFAULT_INTEGER4) endif() if (MADNESS_FORTRAN_DEFAULT_INTEGER4) unset(MADNESS_FORTRAN_DEFAULT_INTEGER4) set(MADNESS_FORTRAN_DEFAULT_INTEGER4 ON CACHE BOOL "MADNESS assumes integer*4 for Fortran BLAS/LAPACK integers" FORCE) endif() unset(CMAKE_REQUIRED_QUIET) cmake_pop_check_state() endmacro (detect_MADNESS_configuration) tiledarray-1.0.0/cmake/modules/DownloadProject.CMakeLists.cmake.in000066400000000000000000000031231375455224000251110ustar00rootroot00000000000000# The MIT License (MIT) # # Copyright (c) 2015 Crascit # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in all # copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. cmake_minimum_required(VERSION 2.8.2) project(${DL_ARGS_PROJ}-download NONE) include(ExternalProject) ExternalProject_Add(${DL_ARGS_PROJ}-download ${DL_ARGS_UNPARSED_ARGUMENTS} SOURCE_DIR "${DL_ARGS_SOURCE_DIR}" BINARY_DIR "${DL_ARGS_BINARY_DIR}" CONFIGURE_COMMAND "" BUILD_COMMAND "" INSTALL_COMMAND "" TEST_COMMAND "" ) tiledarray-1.0.0/cmake/modules/DownloadProject.cmake000066400000000000000000000214721375455224000225150ustar00rootroot00000000000000# The MIT License (MIT) # # Copyright (c) 2015 Crascit # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in all # copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. # # MODULE: DownloadProject # # PROVIDES: # download_project( PROJ projectName # [PREFIX prefixDir] # [DOWNLOAD_DIR downloadDir] # [SOURCE_DIR srcDir] # [BINARY_DIR binDir] # [QUIET] # ... # ) # # Provides the ability to download and unpack a tarball, zip file, git repository, # etc. at configure time (i.e. when the cmake command is run). How the downloaded # and unpacked contents are used is up to the caller, but the motivating case is # to download source code which can then be included directly in the build with # add_subdirectory() after the call to download_project(). Source and build # directories are set up with this in mind. # # The PROJ argument is required. The projectName value will be used to construct # the following variables upon exit (obviously replace projectName with its actual # value): # # projectName_SOURCE_DIR # projectName_BINARY_DIR # # The SOURCE_DIR and BINARY_DIR arguments are optional and would not typically # need to be provided. They can be specified if you want the downloaded source # and build directories to be located in a specific place. The contents of # projectName_SOURCE_DIR and projectName_BINARY_DIR will be populated with the # locations used whether you provide SOURCE_DIR/BINARY_DIR or not. # # The DOWNLOAD_DIR argument does not normally need to be set. It controls the # location of the temporary CMake build used to perform the download. # # The PREFIX argument can be provided to change the base location of the default # values of DOWNLOAD_DIR, SOURCE_DIR and BINARY_DIR. If all of those three arguments # are provided, then PREFIX will have no effect. The default value for PREFIX is # CMAKE_BINARY_DIR. # # The QUIET option can be given if you do not want to show the output associated # with downloading the specified project. # # In addition to the above, any other options are passed through unmodified to # ExternalProject_Add() to perform the actual download, patch and update steps. # The following ExternalProject_Add() options are explicitly prohibited (they # are reserved for use by the download_project() command): # # CONFIGURE_COMMAND # BUILD_COMMAND # INSTALL_COMMAND # TEST_COMMAND # # Only those ExternalProject_Add() arguments which relate to downloading, patching # and updating of the project sources are intended to be used. Also note that at # least one set of download-related arguments are required. # # If using CMake 3.2 or later, the UPDATE_DISCONNECTED option can be used to # prevent a check at the remote end for changes every time CMake is run # after the first successful download. See the documentation of the ExternalProject # module for more information. It is likely you will want to use this option if it # is available to you. Note, however, that the ExternalProject implementation contains # bugs which result in incorrect handling of the UPDATE_DISCONNECTED option when # using the URL download method or when specifying a SOURCE_DIR with no download # method. Fixes for these have been created, the last of which is scheduled for # inclusion in CMake 3.8.0. Details can be found here: # # https://gitlab.kitware.com/cmake/cmake/commit/bdca68388bd57f8302d3c1d83d691034b7ffa70c # https://gitlab.kitware.com/cmake/cmake/issues/16428 # # If you experience build errors related to the update step, consider avoiding # the use of UPDATE_DISCONNECTED. # # EXAMPLE USAGE: # # include(DownloadProject) # download_project(PROJ googletest # GIT_REPOSITORY https://github.com/google/googletest.git # GIT_TAG master # UPDATE_DISCONNECTED 1 # QUIET # ) # # add_subdirectory(${googletest_SOURCE_DIR} ${googletest_BINARY_DIR}) # #======================================================================================== set(_DownloadProjectDir "${CMAKE_CURRENT_LIST_DIR}") include(CMakeParseArguments) function(download_project) set(options QUIET) set(oneValueArgs PROJ PREFIX DOWNLOAD_DIR SOURCE_DIR BINARY_DIR # Prevent the following from being passed through CONFIGURE_COMMAND BUILD_COMMAND INSTALL_COMMAND TEST_COMMAND ) set(multiValueArgs "") cmake_parse_arguments(DL_ARGS "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) # Hide output if requested if (DL_ARGS_QUIET) set(OUTPUT_QUIET "OUTPUT_QUIET") else() unset(OUTPUT_QUIET) message(STATUS "Downloading/updating ${DL_ARGS_PROJ}") endif() # Set up where we will put our temporary CMakeLists.txt file and also # the base point below which the default source and binary dirs will be. # The prefix must always be an absolute path. if (NOT DL_ARGS_PREFIX) set(DL_ARGS_PREFIX "${CMAKE_BINARY_DIR}") else() get_filename_component(DL_ARGS_PREFIX "${DL_ARGS_PREFIX}" ABSOLUTE BASE_DIR "${CMAKE_CURRENT_BINARY_DIR}") endif() if (NOT DL_ARGS_DOWNLOAD_DIR) set(DL_ARGS_DOWNLOAD_DIR "${DL_ARGS_PREFIX}/${DL_ARGS_PROJ}-download") endif() # Ensure the caller can know where to find the source and build directories if (NOT DL_ARGS_SOURCE_DIR) set(DL_ARGS_SOURCE_DIR "${DL_ARGS_PREFIX}/${DL_ARGS_PROJ}-src") endif() if (NOT DL_ARGS_BINARY_DIR) set(DL_ARGS_BINARY_DIR "${DL_ARGS_PREFIX}/${DL_ARGS_PROJ}-build") endif() set(${DL_ARGS_PROJ}_SOURCE_DIR "${DL_ARGS_SOURCE_DIR}" PARENT_SCOPE) set(${DL_ARGS_PROJ}_BINARY_DIR "${DL_ARGS_BINARY_DIR}" PARENT_SCOPE) # The way that CLion manages multiple configurations, it causes a copy of # the CMakeCache.txt to be copied across due to it not expecting there to # be a project within a project. This causes the hard-coded paths in the # cache to be copied and builds to fail. To mitigate this, we simply # remove the cache if it exists before we configure the new project. It # is safe to do so because it will be re-generated. Since this is only # executed at the configure step, it should not cause additional builds or # downloads. file(REMOVE "${DL_ARGS_DOWNLOAD_DIR}/CMakeCache.txt") # Create and build a separate CMake project to carry out the download. # If we've already previously done these steps, they will not cause # anything to be updated, so extra rebuilds of the project won't occur. # Make sure to pass through CMAKE_MAKE_PROGRAM in case the main project # has this set to something not findable on the PATH. configure_file("${_DownloadProjectDir}/DownloadProject.CMakeLists.cmake.in" "${DL_ARGS_DOWNLOAD_DIR}/CMakeLists.txt") execute_process(COMMAND ${CMAKE_COMMAND} -G "${CMAKE_GENERATOR}" -D "CMAKE_MAKE_PROGRAM:FILE=${CMAKE_MAKE_PROGRAM}" . RESULT_VARIABLE result ${OUTPUT_QUIET} WORKING_DIRECTORY "${DL_ARGS_DOWNLOAD_DIR}" ) if(result) message(FATAL_ERROR "CMake step for ${DL_ARGS_PROJ} failed: ${result}") endif() execute_process(COMMAND ${CMAKE_COMMAND} --build . RESULT_VARIABLE result ${OUTPUT_QUIET} WORKING_DIRECTORY "${DL_ARGS_DOWNLOAD_DIR}" ) if(result) message(FATAL_ERROR "Build step for ${DL_ARGS_PROJ} failed: ${result}") endif() endfunction() tiledarray-1.0.0/cmake/modules/EchoTargetProperty.cmake000066400000000000000000000241231375455224000232050ustar00rootroot00000000000000function(echo_target_property tgt prop) # v for value, d for defined, s for set get_property(s TARGET ${tgt} PROPERTY ${prop} SET) # only produce output for values that are set if(s) get_property(v TARGET ${tgt} PROPERTY ${prop}) get_property(d TARGET ${tgt} PROPERTY ${prop} DEFINED) message("tgt='${tgt}' prop='${prop}'") message(" value='${v}'") message(" defined='${d}'") message(" set='${s}'") message("") endif() endfunction() function(echo_target tgt) if(NOT TARGET ${tgt}) message("There is no target named '${tgt}'") return() endif() set(props ADDITIONAL_CLEAN_FILES AIX_EXPORT_ALL_SYMBOLS ALIASED_TARGET ANDROID_ANT_ADDITIONAL_OPTIONS ANDROID_API ANDROID_API_MIN ANDROID_ARCH ANDROID_ASSETS_DIRECTORIES ANDROID_GUI ANDROID_JAR_DEPENDENCIES ANDROID_JAR_DIRECTORIES ANDROID_JAVA_SOURCE_DIR ANDROID_NATIVE_LIB_DEPENDENCIES ANDROID_NATIVE_LIB_DIRECTORIES ANDROID_PROCESS_MAX ANDROID_PROGUARD ANDROID_PROGUARD_CONFIG_PATH ANDROID_SECURE_PROPS_PATH ANDROID_SKIP_ANT_STEP ANDROID_STL_TYPE ARCHIVE_OUTPUT_DIRECTORY_ ARCHIVE_OUTPUT_DIRECTORY ARCHIVE_OUTPUT_NAME_ ARCHIVE_OUTPUT_NAME AUTOGEN_BUILD_DIR AUTOGEN_ORIGIN_DEPENDS AUTOGEN_PARALLEL AUTOGEN_TARGET_DEPENDS AUTOMOC AUTOMOC_COMPILER_PREDEFINES AUTOMOC_DEPEND_FILTERS AUTOMOC_EXECUTABLE AUTOMOC_MACRO_NAMES AUTOMOC_MOC_OPTIONS AUTOMOC_PATH_PREFIX AUTORCC AUTORCC_EXECUTABLE AUTORCC_OPTIONS AUTOUIC AUTOUIC_EXECUTABLE AUTOUIC_OPTIONS AUTOUIC_SEARCH_PATHS BINARY_DIR BUILD_RPATH BUILD_RPATH_USE_ORIGIN BUILD_WITH_INSTALL_NAME_DIR BUILD_WITH_INSTALL_RPATH BUNDLE_EXTENSION BUNDLE C_EXTENSIONS C_STANDARD C_STANDARD_REQUIRED COMMON_LANGUAGE_RUNTIME COMPATIBLE_INTERFACE_BOOL COMPATIBLE_INTERFACE_NUMBER_MAX COMPATIBLE_INTERFACE_NUMBER_MIN COMPATIBLE_INTERFACE_STRING COMPILE_DEFINITIONS COMPILE_FEATURES COMPILE_FLAGS COMPILE_OPTIONS COMPILE_PDB_NAME COMPILE_PDB_NAME_ COMPILE_PDB_OUTPUT_DIRECTORY COMPILE_PDB_OUTPUT_DIRECTORY_ _OUTPUT_NAME _POSTFIX CROSSCOMPILING_EMULATOR CUDA_PTX_COMPILATION CUDA_SEPARABLE_COMPILATION CUDA_RESOLVE_DEVICE_SYMBOLS CUDA_RUNTIME_LIBRARY CUDA_EXTENSIONS CUDA_STANDARD CUDA_STANDARD_REQUIRED CXX_EXTENSIONS CXX_STANDARD CXX_STANDARD_REQUIRED DEBUG_POSTFIX DEFINE_SYMBOL DEPLOYMENT_REMOTE_DIRECTORY DEPLOYMENT_ADDITIONAL_FILES DEPRECATION DISABLE_PRECOMPILE_HEADERS DOTNET_TARGET_FRAMEWORK DOTNET_TARGET_FRAMEWORK_VERSION EchoString ENABLE_EXPORTS EXCLUDE_FROM_ALL EXCLUDE_FROM_DEFAULT_BUILD_ EXCLUDE_FROM_DEFAULT_BUILD EXPORT_NAME EXPORT_PROPERTIES FOLDER Fortran_FORMAT Fortran_MODULE_DIRECTORY FRAMEWORK FRAMEWORK_VERSION GENERATOR_FILE_NAME GHS_INTEGRITY_APP GHS_NO_SOURCE_GROUP_FILE GNUtoMS HAS_CXX IMPLICIT_DEPENDS_INCLUDE_TRANSFORM IMPORTED_COMMON_LANGUAGE_RUNTIME IMPORTED_CONFIGURATIONS IMPORTED_GLOBAL IMPORTED_IMPLIB_ IMPORTED_IMPLIB IMPORTED_LIBNAME_ IMPORTED_LIBNAME IMPORTED_LINK_DEPENDENT_LIBRARIES_ IMPORTED_LINK_DEPENDENT_LIBRARIES IMPORTED_LINK_INTERFACE_LANGUAGES_ IMPORTED_LINK_INTERFACE_LANGUAGES IMPORTED_LINK_INTERFACE_LIBRARIES_ IMPORTED_LINK_INTERFACE_LIBRARIES IMPORTED_LINK_INTERFACE_MULTIPLICITY_ IMPORTED_LINK_INTERFACE_MULTIPLICITY IMPORTED_LOCATION_ IMPORTED_LOCATION IMPORTED_NO_SONAME_ IMPORTED_NO_SONAME IMPORTED_OBJECTS_ IMPORTED_OBJECTS IMPORTED IMPORTED_SONAME_ IMPORTED_SONAME IMPORT_PREFIX IMPORT_SUFFIX INCLUDE_DIRECTORIES INSTALL_NAME_DIR INSTALL_REMOVE_ENVIRONMENT_RPATH INSTALL_RPATH INSTALL_RPATH_USE_LINK_PATH INTERFACE_AUTOUIC_OPTIONS INTERFACE_COMPILE_DEFINITIONS INTERFACE_COMPILE_FEATURES INTERFACE_COMPILE_OPTIONS INTERFACE_INCLUDE_DIRECTORIES INTERFACE_LINK_DEPENDS INTERFACE_LINK_DIRECTORIES INTERFACE_LINK_LIBRARIES INTERFACE_LINK_OPTIONS INTERFACE_PRECOMPILE_HEADERS INTERFACE_POSITION_INDEPENDENT_CODE INTERFACE_SOURCES INTERFACE_SYSTEM_INCLUDE_DIRECTORIES INTERPROCEDURAL_OPTIMIZATION_ INTERPROCEDURAL_OPTIMIZATION IOS_INSTALL_COMBINED JOB_POOL_COMPILE JOB_POOL_LINK JOB_POOL_PRECOMPILE_HEADER LABELS _CLANG_TIDY _COMPILER_LAUNCHER _CPPCHECK _CPPLINT _INCLUDE_WHAT_YOU_USE _VISIBILITY_PRESET LIBRARY_OUTPUT_DIRECTORY_ LIBRARY_OUTPUT_DIRECTORY LIBRARY_OUTPUT_NAME_ LIBRARY_OUTPUT_NAME LINK_DEPENDS_NO_SHARED LINK_DEPENDS LINKER_LANGUAGE LINK_DIRECTORIES LINK_FLAGS_ LINK_FLAGS LINK_INTERFACE_LIBRARIES_ LINK_INTERFACE_LIBRARIES LINK_INTERFACE_MULTIPLICITY_ LINK_INTERFACE_MULTIPLICITY LINK_LIBRARIES LINK_OPTIONS LINK_SEARCH_END_STATIC LINK_SEARCH_START_STATIC LINK_WHAT_YOU_USE LOCATION_ LOCATION MACHO_COMPATIBILITY_VERSION MACHO_CURRENT_VERSION MACOSX_BUNDLE_INFO_PLIST MACOSX_BUNDLE MACOSX_FRAMEWORK_INFO_PLIST MACOSX_RPATH MANUALLY_ADDED_DEPENDENCIES MAP_IMPORTED_CONFIG_ MSVC_RUNTIME_LIBRARY NAME NO_SONAME NO_SYSTEM_FROM_IMPORTED OBJC_EXTENSIONS OBJC_STANDARD OBJC_STANDARD_REQUIRED OBJCXX_EXTENSIONS OBJCXX_STANDARD OBJCXX_STANDARD_REQUIRED OSX_ARCHITECTURES_ OSX_ARCHITECTURES OUTPUT_NAME_ OUTPUT_NAME PDB_NAME_ PDB_NAME PDB_OUTPUT_DIRECTORY_ PDB_OUTPUT_DIRECTORY POSITION_INDEPENDENT_CODE PRECOMPILE_HEADERS PRECOMPILE_HEADERS_REUSE_FROM PREFIX PRIVATE_HEADER PROJECT_LABEL PUBLIC_HEADER RESOURCE RULE_LAUNCH_COMPILE RULE_LAUNCH_CUSTOM RULE_LAUNCH_LINK RUNTIME_OUTPUT_DIRECTORY_ RUNTIME_OUTPUT_DIRECTORY RUNTIME_OUTPUT_NAME_ RUNTIME_OUTPUT_NAME SKIP_BUILD_RPATH SOURCE_DIR SOURCES SOVERSION STATIC_LIBRARY_FLAGS_ STATIC_LIBRARY_FLAGS STATIC_LIBRARY_OPTIONS SUFFIX Swift_DEPENDENCIES_FILE Swift_LANGUAGE_VERSION Swift_MODULE_DIRECTORY Swift_MODULE_NAME TYPE UNITY_BUILD UNITY_BUILD_BATCH_SIZE UNITY_BUILD_CODE_AFTER_INCLUDE UNITY_BUILD_CODE_BEFORE_INCLUDE VERSION VISIBILITY_INLINES_HIDDEN VS_CONFIGURATION_TYPE VS_DEBUGGER_COMMAND VS_DEBUGGER_COMMAND_ARGUMENTS VS_DEBUGGER_ENVIRONMENT VS_DEBUGGER_WORKING_DIRECTORY VS_DESKTOP_EXTENSIONS_VERSION VS_DOTNET_REFERENCE_ VS_DOTNET_REFERENCEPROP__TAG_ VS_DOTNET_REFERENCES VS_DOTNET_REFERENCES_COPY_LOCAL VS_DOTNET_TARGET_FRAMEWORK_VERSION VS_DOTNET_DOCUMENTATION_FILE VS_DPI_AWARE VS_GLOBAL_KEYWORD VS_GLOBAL_PROJECT_TYPES VS_GLOBAL_ROOTNAMESPACE VS_GLOBAL_ VS_IOT_EXTENSIONS_VERSION VS_IOT_STARTUP_TASK VS_JUST_MY_CODE_DEBUGGING VS_KEYWORD VS_MOBILE_EXTENSIONS_VERSION VS_NO_SOLUTION_DEPLOY VS_PACKAGE_REFERENCES VS_PROJECT_IMPORT VS_SCC_AUXPATH VS_SCC_LOCALPATH VS_SCC_PROJECTNAME VS_SCC_PROVIDER VS_SDK_REFERENCES VS_USER_PROPS VS_WINDOWS_TARGET_PLATFORM_MIN_VERSION VS_WINRT_COMPONENT VS_WINRT_EXTENSIONS VS_WINRT_REFERENCES WIN32_EXECUTABLE WINDOWS_EXPORT_ALL_SYMBOLS XCODE_ATTRIBUTE_ XCODE_EXPLICIT_FILE_TYPE XCODE_GENERATE_SCHEME XCODE_PRODUCT_TYPE XCODE_SCHEME_ADDRESS_SANITIZER XCODE_SCHEME_ADDRESS_SANITIZER_USE_AFTER_RETURN XCODE_SCHEME_ARGUMENTS XCODE_SCHEME_DEBUG_AS_ROOT XCODE_SCHEME_DEBUG_DOCUMENT_VERSIONING XCODE_SCHEME_DISABLE_MAIN_THREAD_CHECKER XCODE_SCHEME_DYNAMIC_LIBRARY_LOADS XCODE_SCHEME_DYNAMIC_LINKER_API_USAGE XCODE_SCHEME_ENVIRONMENT XCODE_SCHEME_EXECUTABLE XCODE_SCHEME_GUARD_MALLOC XCODE_SCHEME_MAIN_THREAD_CHECKER_STOP XCODE_SCHEME_MALLOC_GUARD_EDGES XCODE_SCHEME_MALLOC_SCRIBBLE XCODE_SCHEME_MALLOC_STACK XCODE_SCHEME_THREAD_SANITIZER XCODE_SCHEME_THREAD_SANITIZER_STOP XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER XCODE_SCHEME_UNDEFINED_BEHAVIOUR_SANITIZER_STOP XCODE_SCHEME_WORKING_DIRECTORY XCODE_SCHEME_ZOMBIE_OBJECTS XCTEST ) # build whitelist by filtering down from CMAKE_PROPERTY_LIST in case cmake is # a different version, and one of our hardcoded whitelisted properties # doesn't exist! unset(whitelisted_props) foreach(prop ${props}) if(prop MATCHES "^(INTERFACE|[_a-z]|IMPORTED_LIBNAME_|MAP_IMPORTED_CONFIG_)|^(COMPATIBLE_INTERFACE_(BOOL|NUMBER_MAX|NUMBER_MIN|STRING)|EXPORT_NAME|IMPORTED(_GLOBAL|_CONFIGURATIONS|_LIBNAME)?|NAME|TYPE|NO_SYSTEM_FROM_IMPORTED)$") list(APPEND whitelisted_props ${prop}) endif() endforeach(prop) message("======================== ${tgt} ========================") get_target_property(tgt_type ${tgt} TYPE) if (tgt_type STREQUAL "INTERFACE_LIBRARY") set(tgt_props_list "${whitelisted_props}") else() set(tgt_props_list "${props}") endif() foreach(p ${tgt_props_list}) echo_target_property("${tgt}" "${p}") endforeach() message("") endfunction() function(echo_targets) set(tgts ${ARGV}) foreach(t ${tgts}) echo_target("${t}") endforeach() endfunction() tiledarray-1.0.0/cmake/modules/FetchBLT.cmake000066400000000000000000000003411375455224000210020ustar00rootroot00000000000000FetchContent_Declare( BLT GIT_REPOSITORY https://github.com/evaleev/blt.git GIT_TAG origin/develop ) FetchContent_MakeAvailable(BLT) FetchContent_GetProperties(BLT SOURCE_DIR BLT_SOURCE_DIR ) tiledarray-1.0.0/cmake/modules/FindEigen3.cmake000066400000000000000000000060551375455224000213320ustar00rootroot00000000000000# - Try to find Eigen3 lib # # This module supports requiring a minimum version, e.g. you can do # find_package(Eigen3 3.1.2) # to require version 3.1.2 or newer of Eigen3. # # Once done this will define # # EIGEN3_FOUND - system has eigen lib with correct version # EIGEN3_INCLUDE_DIR - the eigen include directory # EIGEN3_VERSION - eigen version # Copyright (c) 2006, 2007 Montel Laurent, # Copyright (c) 2008, 2009 Gael Guennebaud, # Copyright (c) 2009 Benoit Jacob # Redistribution and use is allowed according to the terms of the 2-clause BSD license. if(NOT Eigen3_FIND_VERSION) if(NOT Eigen3_FIND_VERSION_MAJOR) set(Eigen3_FIND_VERSION_MAJOR 2) endif(NOT Eigen3_FIND_VERSION_MAJOR) if(NOT Eigen3_FIND_VERSION_MINOR) set(Eigen3_FIND_VERSION_MINOR 91) endif(NOT Eigen3_FIND_VERSION_MINOR) if(NOT Eigen3_FIND_VERSION_PATCH) set(Eigen3_FIND_VERSION_PATCH 0) endif(NOT Eigen3_FIND_VERSION_PATCH) set(Eigen3_FIND_VERSION "${Eigen3_FIND_VERSION_MAJOR}.${Eigen3_FIND_VERSION_MINOR}.${Eigen3_FIND_VERSION_PATCH}") endif(NOT Eigen3_FIND_VERSION) macro(_eigen3_check_version) file(READ "${EIGEN3_INCLUDE_DIR}/Eigen/src/Core/util/Macros.h" _eigen3_version_header) string(REGEX MATCH "define[ \t]+EIGEN_WORLD_VERSION[ \t]+([0-9]+)" _eigen3_world_version_match "${_eigen3_version_header}") set(EIGEN3_WORLD_VERSION "${CMAKE_MATCH_1}") string(REGEX MATCH "define[ \t]+EIGEN_MAJOR_VERSION[ \t]+([0-9]+)" _eigen3_major_version_match "${_eigen3_version_header}") set(EIGEN3_MAJOR_VERSION "${CMAKE_MATCH_1}") string(REGEX MATCH "define[ \t]+EIGEN_MINOR_VERSION[ \t]+([0-9]+)" _eigen3_minor_version_match "${_eigen3_version_header}") set(EIGEN3_MINOR_VERSION "${CMAKE_MATCH_1}") set(EIGEN3_VERSION ${EIGEN3_WORLD_VERSION}.${EIGEN3_MAJOR_VERSION}.${EIGEN3_MINOR_VERSION}) if(${EIGEN3_VERSION} VERSION_LESS ${Eigen3_FIND_VERSION}) set(EIGEN3_VERSION_OK FALSE) else(${EIGEN3_VERSION} VERSION_LESS ${Eigen3_FIND_VERSION}) set(EIGEN3_VERSION_OK TRUE) endif(${EIGEN3_VERSION} VERSION_LESS ${Eigen3_FIND_VERSION}) if(NOT EIGEN3_VERSION_OK) message(STATUS "Eigen3 version ${EIGEN3_VERSION} found in ${EIGEN3_INCLUDE_DIR}, " "but at least version ${Eigen3_FIND_VERSION} is required") endif(NOT EIGEN3_VERSION_OK) # Eigen3 config defines version in Eigen3_VERSION, so define that as well here set(Eigen3_VERSION ${EIGEN3_VERSION}) endmacro(_eigen3_check_version) if (EIGEN3_INCLUDE_DIR) # in cache already _eigen3_check_version() set(EIGEN3_FOUND ${EIGEN3_VERSION_OK}) else (EIGEN3_INCLUDE_DIR) find_path(EIGEN3_INCLUDE_DIR NAMES signature_of_eigen3_matrix_library PATHS ${CMAKE_INSTALL_PREFIX}/include ${KDE4_INCLUDE_DIR} PATH_SUFFIXES eigen3 eigen ) if(EIGEN3_INCLUDE_DIR) _eigen3_check_version() endif(EIGEN3_INCLUDE_DIR) include(FindPackageHandleStandardArgs) find_package_handle_standard_args(Eigen3 DEFAULT_MSG EIGEN3_INCLUDE_DIR EIGEN3_VERSION_OK) mark_as_advanced(EIGEN3_INCLUDE_DIR) endif(EIGEN3_INCLUDE_DIR) tiledarray-1.0.0/cmake/modules/FindOrFetchBTAS.cmake000066400000000000000000000025521375455224000222220ustar00rootroot00000000000000find_package(BTAS 1.0.0 QUIET CONFIG) if (NOT TARGET BTAS::BTAS) set(BTAS_ENABLE_MKL ${ENABLE_MKL} CACHE BOOL "Whether BTAS should seek MKL") if (MADNESS_FORTRAN_DEFAULT_INTEGER4) set(mkl_pref_ilp64 OFF) else(MADNESS_FORTRAN_DEFAULT_INTEGER4) set(mkl_pref_ilp64 ON) endif(MADNESS_FORTRAN_DEFAULT_INTEGER4) set(MKL_PREFER_ILP64 ${mkl_pref_ilp64} CACHE BOOL "MKL preference: ILP64 (yes) or {LP64,LP32} (no)") if (MADNESS_HAS_TBB) set(MKL_THREADING "TBB" CACHE STRING "MKL flavor: SEQ, TBB or OMP (default)") endif() FetchContent_Declare( BTAS GIT_REPOSITORY https://github.com/BTAS/btas.git GIT_TAG ${TA_TRACKED_BTAS_TAG} ) FetchContent_MakeAvailable(BTAS) FetchContent_GetProperties(BTAS SOURCE_DIR BTAS_SOURCE_DIR BINARY_DIR BTAS_BINARY_DIR ) # use subproject targets as if they were in exported namespace ... if (TARGET BTAS AND NOT TARGET BTAS::BTAS) add_library(BTAS::BTAS ALIAS BTAS) endif(TARGET BTAS AND NOT TARGET BTAS::BTAS) # set BTAS_CONFIG to the install location so that we know where to find it set(BTAS_CONFIG ${CMAKE_INSTALL_PREFIX}/${BTAS_INSTALL_CMAKEDIR}/btas-config.cmake) endif(NOT TARGET BTAS::BTAS) # postcond check if (NOT TARGET BTAS::BTAS) message(FATAL_ERROR "FindOrFetchBTAS could not make BTAS::BTAS target available") endif(NOT TARGET BTAS::BTAS) tiledarray-1.0.0/cmake/modules/FindOrFetchRangeV3.cmake000066400000000000000000000016001375455224000227270ustar00rootroot00000000000000find_package(range-v3 QUIET CONFIG) if (TARGET range-v3::range-v3) message(STATUS "Found Range-V3 CONFIG at ${range-v3_CONFIG}") else (TARGET range-v3::range-v3) include(FetchContent) FetchContent_Declare( RangeV3 GIT_REPOSITORY https://github.com/ericniebler/range-v3.git GIT_TAG ${TA_TRACKED_RANGEV3_TAG} ) FetchContent_MakeAvailable(RangeV3) FetchContent_GetProperties(RangeV3 SOURCE_DIR RANGEV3_SOURCE_DIR BINARY_DIR RANGEV3_BINARY_DIR ) # set BTAS_CONFIG to the install location so that we know where to find it set(range-v3_CONFIG ${CMAKE_INSTALL_PREFIX}/lib/cmake/range-v3/range-v3-config.cmake) endif(TARGET range-v3::range-v3) # postcond check if (NOT TARGET range-v3::range-v3) message(FATAL_ERROR "FindOrFetchRangeV3 could not make range-v3::range-v3 target available") endif(NOT TARGET range-v3::range-v3) tiledarray-1.0.0/cmake/modules/FindPackageRegimport.cmake000066400000000000000000000012151375455224000234350ustar00rootroot00000000000000# find_package and register for re-import in a superproject macro(find_package_regimport _package) find_package(${_package} ${ARGN}) if (${_package}_FOUND) set(_str_ARGN) foreach (_arg IN ITEMS ${ARGN}) set(_str_ARGN "${_str_ARGN} \"${_arg}\"") endforeach () file(APPEND "${PROJECT_BINARY_DIR}/cmake/modules/ReimportTargets.cmake" "find_package(${_package} ${_str_ARGN})\n") endif (${_package}_FOUND) endmacro() macro(init_package_regimport) file(WRITE "${PROJECT_BINARY_DIR}/cmake/modules/ReimportTargets.cmake" "# load this in superproject of TiledArray to re-import the targets imported during its build\n") endmacro() tiledarray-1.0.0/cmake/modules/LibFindMacros.cmake000066400000000000000000000145541375455224000220760ustar00rootroot00000000000000# Version 1.0 (2013-04-12) # Public Domain, originally written by Lasse Karkkainen # Published at http://www.cmake.org/Wiki/CMake:How_To_Find_Libraries # If you improve the script, please modify the forementioned wiki page because # I no longer maintain my scripts (hosted as static files at zi.fi). Feel free # to remove this entire header if you use real version control instead. # Changelog: # 2013-04-12 Added version number (1.0) and this header, no other changes # 2009-10-08 Originally published # Works the same as find_package, but forwards the "REQUIRED" and "QUIET" arguments # used for the current package. For this to work, the first parameter must be the # prefix of the current package, then the prefix of the new package etc, which are # passed to find_package. macro (libfind_package PREFIX) set (LIBFIND_PACKAGE_ARGS ${ARGN}) if (${PREFIX}_FIND_QUIETLY) set (LIBFIND_PACKAGE_ARGS ${LIBFIND_PACKAGE_ARGS} QUIET) endif (${PREFIX}_FIND_QUIETLY) if (${PREFIX}_FIND_REQUIRED) set (LIBFIND_PACKAGE_ARGS ${LIBFIND_PACKAGE_ARGS} REQUIRED) endif (${PREFIX}_FIND_REQUIRED) find_package(${LIBFIND_PACKAGE_ARGS}) endmacro (libfind_package) # CMake developers made the UsePkgConfig system deprecated in the same release (2.6) # where they added pkg_check_modules. Consequently I need to support both in my scripts # to avoid those deprecated warnings. Here's a helper that does just that. # Works identically to pkg_check_modules, except that no checks are needed prior to use. macro (libfind_pkg_check_modules PREFIX PKGNAME) if (${CMAKE_MAJOR_VERSION} EQUAL 2 AND ${CMAKE_MINOR_VERSION} EQUAL 4) include(UsePkgConfig) pkgconfig(${PKGNAME} ${PREFIX}_INCLUDE_DIRS ${PREFIX}_LIBRARY_DIRS ${PREFIX}_LDFLAGS ${PREFIX}_CFLAGS) else (${CMAKE_MAJOR_VERSION} EQUAL 2 AND ${CMAKE_MINOR_VERSION} EQUAL 4) find_package(PkgConfig) if (PKG_CONFIG_FOUND) pkg_check_modules(${PREFIX} ${PKGNAME}) endif (PKG_CONFIG_FOUND) endif (${CMAKE_MAJOR_VERSION} EQUAL 2 AND ${CMAKE_MINOR_VERSION} EQUAL 4) endmacro (libfind_pkg_check_modules) # This macro searchs the _lib_list list for _lib, and, if found, adds any # missing dependencies in the _deps list. Also, the ${PREFIX}_FIND_REQUIRED_${_dep} # variable is set to true if the ${PREFIX}_FIND_REQUIRED_${_lib} is true macro(libfind_add_dep PREFIX _lib_list _lib _deps) list(FIND ${_lib_list} ${_lib} _lib_find) if(NOT _lib_find EQUAL -1) foreach(_dep ${_deps}) # Add missing dependencies to the list. list(FIND ${_lib_list} ${_dep} _dep_find) if(_dep_find EQUAL -1) list(APPEND ${_lib_list} ${_dep}) endif() # Set the find required flag for the dependency if(${PREFIX}_FIND_REQUIRED_${_lib}) set(${PREFIX}_FIND_REQUIRED_${_dep} TRUE) else() set(${PREFIX}_FIND_REQUIRED_${_dep} FALSE) endif() endforeach() endif() endmacro() # Do the final processing once the paths have been detected. # If include dirs are needed, ${PREFIX}_PROCESS_INCLUDES should be set to contain # all the variables, each of which contain one include directory. # Ditto for ${PREFIX}_PROCESS_LIBS and library files. # Will set ${PREFIX}_FOUND, ${PREFIX}_INCLUDE_DIRS and ${PREFIX}_LIBRARIES. # Also handles errors in case library detection was required, etc. macro (libfind_process PREFIX) # Skip processing if already processed during this run if (NOT ${PREFIX}_FOUND) # Start with the assumption that the library was found set (${PREFIX}_FOUND TRUE) # Process all includes and set _FOUND to false if any are missing foreach (i ${${PREFIX}_PROCESS_INCLUDES}) if (${i}) set (${PREFIX}_INCLUDE_DIRS ${${PREFIX}_INCLUDE_DIRS} ${${i}}) mark_as_advanced(${i}) else (${i}) set (${PREFIX}_FOUND FALSE) endif (${i}) endforeach (i) # Process all libraries and set _FOUND to false if any are missing foreach (i ${${PREFIX}_PROCESS_LIBS}) if (${i}) set (${PREFIX}_LIBRARIES ${${PREFIX}_LIBRARIES} ${${i}}) mark_as_advanced(${i}) else (${i}) set (${PREFIX}_FOUND FALSE) endif (${i}) endforeach (i) # Print message and/or exit on fatal error if (${PREFIX}_FOUND) if (NOT ${PREFIX}_FIND_QUIETLY) message (STATUS "Found ${PREFIX} ${${PREFIX}_VERSION}") endif (NOT ${PREFIX}_FIND_QUIETLY) else (${PREFIX}_FOUND) if (${PREFIX}_FIND_REQUIRED) foreach (i ${${PREFIX}_PROCESS_INCLUDES} ${${PREFIX}_PROCESS_LIBS}) message("${i}=${${i}}") endforeach (i) message (FATAL_ERROR "Required library ${PREFIX} NOT FOUND.\n" "Install the library (dev version) and try again. " "If the library is already installed, " "use ccmake to set the missing variables manually.") endif (${PREFIX}_FIND_REQUIRED) endif (${PREFIX}_FOUND) endif (NOT ${PREFIX}_FOUND) endmacro (libfind_process) macro(libfind_header PREFIX _var _header) set(${PREFIX}_INCLUDE_SEARCH_DIR) if(${PREFIX}_ROOT_DIR) set(${PREFIX}_INCLUDE_SEARCH_DIR "${${PREFIX}_ROOT_DIR}/include") endif() find_path(${_var} ${_header} HINTS ${${PREFIX}_INCLUDE_DIR} ${${PREFIX}_INCLUDE_SEARCH_DIR} NO_CMAKE_SYSTEM_PATH) endmacro() macro(libfind_library PREFIX _name) if(NOT ${PREFIX}_${_name}_LIBRARY) if(${PREFIX}_LIBRARY) # Search the user provided libraries for _name foreach(_lib ${${PREFIX}_LIBRARY}) get_filename_component(_lib_name ${_lib} NAME) string(FIND ${_lib_name} ${_name} _lib_found) if(NOT _lib_found EQUAL -1) # Set the component library list set(${PREFIX}_${_name}_LIBRARY ${_lib}) break() endif() endforeach() else() set(${PREFIX}_LIB_SERACH_DIRS) if(${PREFIX}_ROOT_DIR) set(${PREFIX}_LIB_SERACH_DIRS "${${PREFIX}_ROOT_DIR}/lib") endif() # Search for the library find_library(${PREFIX}_${_name}_LIBRARY ${_name} HINTS ${${PREFIX}_PKGCONF_LIBRARY_DIRS} ${${PREFIX}_LIB_SERACH_DIRS} NO_CMAKE_SYSTEM_PATH) endif() endif() # Check that it exists and set the found variable if(${PREFIX}_${_name}_LIBRARY AND EXISTS ${${PREFIX}_${_name}_LIBRARY}) set(${PREFIX}_${_name}_FOUND TRUE) else() set(${PREFIX}_${_name}_FOUND FALSE) endif() mark_as_advanced(${PREFIX}_${_name}_LIBRARY) endmacro() tiledarray-1.0.0/cmake/modules/LoadFetchContent.cmake000066400000000000000000000005641375455224000226020ustar00rootroot00000000000000# Copyright 2020 Eduard F Valeyev # Distributed under the OSI-approved BSD 3-Clause License. # See https://opensource.org/licenses/BSD-3-Clause for details. set(FETCHCONTENT_UPDATES_DISCONNECTED OFF CACHE BOOL "Enables UPDATE_DISCONNECTED behavior for all content population") include(FetchContent) cmake_minimum_required(VERSION 3.14) # neet FetchContent_MakeAvailable tiledarray-1.0.0/cmake/modules/RedefaultableOption.cmake000066400000000000000000000006021375455224000233370ustar00rootroot00000000000000# if local variable is defined, use its value as the default, otherwise use _default # this is consistent with cmake 3.13 and later (see policy CMP0077) macro(redefaultable_option _name _descr _default) if (DEFINED ${_name}) set(${_name}_DEFAULT ${${_name}}) else() set(${_name}_DEFAULT ${_default}) endif() option(${_name} "${_descr}" ${${_name}_DEFAULT}) endmacro() tiledarray-1.0.0/cmake/modules/SanitizeCUDAImplicitDirectories.cmake000066400000000000000000000025161375455224000255300ustar00rootroot00000000000000# # This file is a part of TiledArray. # Copyright (C) 2019 Virginia Tech # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . # # Edward Valeev # Department of Chemistry, Virginia Tech # # SanitizeCUDAImplicitDirectories.cmake # Oct 7, 2019 # # # Filter out directories specific to the host compiler from CMAKE_CUDA_IMPLICIT_{INCLUDE,LINK}_DIRECTORIES # macro(sanitize_cuda_implicit_directories) foreach (_type INCLUDE LINK) set(_var CMAKE_CUDA_IMPLICIT_${_type}_DIRECTORIES) set(_sanitized_var ) foreach (_component ${${_var}}) if (NOT ${_component} MATCHES "/gcc/(.*/|)[0-9]\.[0-9]\.[0-9]") list(APPEND _sanitized_var ${_component}) endif() endforeach() set(${_var} ${_sanitized_var}) endforeach() endmacro() tiledarray-1.0.0/cmake/tiledarray-config.cmake.in000066400000000000000000000075271375455224000217640ustar00rootroot00000000000000# - CMAKE Config file for the TiledArray package # The following variables are defined: # TILEDARRAY_FOUND - System has the TiledArray package # TILEDARRAY_INCLUDE_DIRS - The TiledArray include directory # TILEDARRAY_LIBRARIES - The TiledArray libraries and their dependencies # TILEDARRAY_VERSION - The TiledArray (core) version; see semver.org # TILEDARRAY_EXT_VERSION - The TiledArray version, includes prerelease id; see semver.org # Set package version set(TILEDARRAY_VERSION "@TILEDARRAY_VERSION@") set(TILEDARRAY_EXT_VERSION "@TILEDARRAY_EXT_VERSION@") @PACKAGE_INIT@ # Include library IMPORT targets if (NOT TARGET BTAS::BTAS) get_filename_component(BTAS_DIR "@BTAS_CONFIG@" DIRECTORY) find_package(BTAS 1.0.0 QUIET CONFIG REQUIRED HINTS "${BTAS_DIR}") endif() if(NOT TARGET MADworld) # if madness installed separately, use the madness install discovered when configuring TA set(MADNESS_CONFIG_DIR "@MADNESS_CONFIG_DIR@") # otherwise assume TA built madness if (MADNESS_CONFIG_DIR STREQUAL "") set(MADNESS_CONFIG_DIR "${CMAKE_CURRENT_LIST_DIR}/../madness") endif() include( CMakeFindDependencyMacro ) find_dependency(MADNESS 0.10.1 CONFIG REQUIRED COMPONENTS world PATHS "${MADNESS_CONFIG_DIR}" NO_DEFAULT_PATH) endif() if(NOT TARGET tiledarray) include("${CMAKE_CURRENT_LIST_DIR}/tiledarray-targets.cmake") endif() # if TA is a CUDA-dependent library it needs CUDA to link properly ... unfortunately CMake is not able to do this correctly # see https://gitlab.kitware.com/cmake/cmake/issues/18614 # so try workarounds set(TILEDARRAY_HAS_CUDA "@CUDA_FOUND@") if(TILEDARRAY_HAS_CUDA) cmake_minimum_required(VERSION 3.17) if (NOT TARGET CUDA::cublas) find_package(CUDAToolkit REQUIRED COMPONENTS cublas nvToolsExt) endif(NOT TARGET CUDA::cublas) set(CMAKE_CUDA_HOST_COMPILER "@CMAKE_CUDA_HOST_COMPILER@") # workaround from https://gitlab.kitware.com/cmake/cmake/issues/18614#note_485631 set(CUDA_LIBRARIES "@CUDA_LIBRARIES@") get_target_property(_ta_interface_libs tiledarray INTERFACE_LINK_LIBRARIES) if(_ta_interface_libs) list(APPEND _ta_interface_libs ${CUDA_LIBRARIES}) else() set(_ta_interface_libs ${CUDA_LIBRARIES}) endif() string(TOUPPER ${CMAKE_BUILD_TYPE} TA_BUILD_TYPE) set_target_properties(tiledarray PROPERTIES IMPORTED_LINK_INTERFACE_LANGUAGES_${TA_BUILD_TYPE} CXX INTERFACE_LINK_LIBRARIES "${_ta_interface_libs}") endif() set(TILEDARRAY_HAS_SCALAPACK "@ENABLE_SCALAPACK@" ) if(TILEDARRAY_HAS_SCALAPACK) include( CMakeFindDependencyMacro ) get_filename_component(blacspp_DIR "@blacspp_CONFIG@" DIRECTORY) find_dependency( blacspp CONFIG REQUIRED HINTS "${blacspp_DIR}" ) get_filename_component(scalapackpp_DIR "@scalapackpp_CONFIG@" DIRECTORY) find_dependency( scalapackpp CONFIG REQUIRED HINTS "${scalapackpp_DIR}" ) endif() # Set the tiledarray compiled library target set(TILEDARRAY_LIBRARIES tiledarray) set(TILEDARRAY_SOURCE_DIR "@TILEDARRAY_SOURCE_DIR@") set(TILEDARRAY_BINARY_DIR "@TILEDARRAY_BINARY_DIR@") set(TILEDARRAY_BUILD_INCLUDE_DIRS "${TILEDARRAY_SOURCE_DIR}/src" "${TILEDARRAY_BINARY_DIR}/src") set(TILEDARRAY_INSTALL_INCLUDE_DIRS "@PACKAGE_TILEDARRAY_INSTALL_INCLUDEDIR@" "@PACKAGE_TILEDARRAY_INSTALL_INCLUDEDIR@/TiledArray/external") # define TILEDARRAY_INCLUDE_DIRS according to where we are compiling: TA build tree or outside # external packages should use TILEDARRAY_BUILD_INCLUDE_DIRS and TILEDARRAY_INSTALL_INCLUDE_DIRS directly if(CMAKE_CURRENT_LIST_DIR EQUAL TILEDARRAY_BINARY_DIR) set(TILEDARRAY_INCLUDE_DIRS "${TILEDARRAY_BUILD_INCLUDE_DIRS}") else() set(TILEDARRAY_INCLUDE_DIRS "${TILEDARRAY_INSTALL_INCLUDE_DIRS}") endif() set(TILEDARRAY_CMAKE_TOOLCHAIN_FILE "@CMAKE_TOOLCHAIN_FILE@") # whether TA assumes ASLR to be disabled set(TA_ASSUMES_ASLR_DISABLED "@TA_ASSUMES_ASLR_DISABLED@") set(TILEDARRAY_FOUND TRUE) tiledarray-1.0.0/cmake/toolchains/000077500000000000000000000000001375455224000171025ustar00rootroot00000000000000tiledarray-1.0.0/cmake/toolchains/README.md000066400000000000000000000041341375455224000203630ustar00rootroot00000000000000# Summary TiledArray in general is recommended to use the toolchains distributed via [the Valeev Group CMake kit](https://github.com/ValeevGroup/kit-cmake/tree/master/toolchains). TiledArray by default downloads (via [the FetchContent CMake module](https://cmake.org/cmake/help/latest/module/FetchContent.html)) the VG CMake toolkit which makes the toolchains available without having to download the toolchain files manually. E.g., to use toolchain `x` from the VG CMake kit repository provide `-DCMAKE_TOOLCHAIN_FILE=cmake/vg/toolchains/x.cmake` to CMake when configuring TiledArray. This directory contains compilation notes for specific high-end platform instances. # Specific Platforms ## OLCF Summit recommended configure script (tested 04/20/2020): ``` module purge module load DefApps module load cuda/10.1.243 module load essl/6.2.0-20190419 module load gcc/9.1.0 module load lsf-tools/2.0 module load netlib-lapack/3.8.0 module load spectrum-mpi/10.3.1.2-20200121 module load boost/1.66.0 export CUDA_GCC_DIR=/sw/summit/gcc/7.4.0 # clean out previous build and install artifacts ... minimally should do this: # `rm -rf CMakeFiles/ CMakeCache.txt external cmake _deps` cmake ../../tiledarray \ -DCMAKE_TOOLCHAIN_FILE=cmake/vg/toolchains/olcf-summit-gcc-essl.cmake \ -DENABLE_CUDA=ON \ -DCMAKE_CUDA_HOST_COMPILER=${CUDA_GCC_DIR}/bin/g++ \ -DCUDAToolkit_ROOT=/sw/summit/cuda/10.1.243 \ -DENABLE_TBB=OFF \ -DCMAKE_PREFIX_PATH="${EIGEN3_DIR};${CMAKE_PREFIX_PATH}" \ -DBUILD_SHARED_LIBS=OFF \ ``` Note that this assumes: - CMake 3.17.0 or later is in `PATH`; as of 4/20/2020 Summit default environment does not provide most recent CMake, hence you must install it yourself; - Eigen3 was CMake-configured and installed into `${EIGEN3_DIR}` (set the variable appropriately). Omit the `EIGEN3` entry in `CMAKE_PREFIX_PATH` if don't have Eigen pre-installed. ## ALCF Theta See instructions in the toolchain file `alcf-theta-mkl-tbb.cmake` (contributed by @victor-anisimov ). This should work for other generic x86-based platforms with Cray compiler wrappers. tiledarray-1.0.0/cmake/toolchains/travis.cmake000066400000000000000000000037421375455224000214220ustar00rootroot00000000000000#set(CMAKE_SYSTEM_NAME Linux) # Set compile flags set(CMAKE_C_FLAGS_INIT "-std=c99 -m64 -I/usr/include" CACHE STRING "Inital C compile flags") set(CMAKE_C_FLAGS_DEBUG "-g -Wall" CACHE STRING "Inital C debug compile flags") set(CMAKE_C_FLAGS_MINSIZEREL "-Os -march=native -DNDEBUG" CACHE STRING "Inital C minimum size release compile flags") set(CMAKE_C_FLAGS_RELEASE "-O3 -march=native -DNDEBUG" CACHE STRING "Inital C release compile flags") set(CMAKE_C_FLAGS_RELWITHDEBINFO "-O2 -g -Wall" CACHE STRING "Inital C release with debug info compile flags") set(CMAKE_CXX_FLAGS_INIT "" CACHE STRING "Inital C++ compile flags") set(CMAKE_CXX_FLAGS_DEBUG "-g -Wall" CACHE STRING "Inital C++ debug compile flags") set(CMAKE_CXX_FLAGS_MINSIZEREL "-Os -march=native -DNDEBUG" CACHE STRING "Inital C++ minimum size release compile flags") # clang issue with mismatched alloc/free in Eigen goes away if NDEBUG is not defined ... just a workaround set(CMAKE_CXX_FLAGS_RELEASE "-O3 -march=native" CACHE STRING "Inital C++ release compile flags") set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "-O2 -g -Wall" CACHE STRING "Inital C++ release with debug info compile flags") # Libraries set(BLAS_LINKER_FLAGS "-L/usr/lib/libblas" "-lblas" "-L/usr/lib/lapack" "-llapack" "-L/usr/lib" "-llapacke" CACHE STRING "BLAS linker flags") set(LAPACK_LIBRARIES ${BLAS_LINKER_FLAGS} CACHE STRING "LAPACK linker flags") set(LAPACK_INCLUDE_DIRS "/usr/include" CACHE STRING "LAPACK include directories") set( LAPACK_COMPILE_DEFINITIONS MADNESS_LINALG_USE_LAPACKE TILEDARRAY_EIGEN_USE_LAPACKE CACHE STRING "LAPACK preprocessor definitions" ) set(INTEGER4 TRUE CACHE BOOL "Set Fortran integer size to 4 bytes") set(BUILD_SHARED_LIBS OFF CACHE BOOL "Build shared libraries") set( lapack_LIBRARIES ${BLAS_LINKER_FLAGS} ) set( blacs_LIBRARIES "-L$ENV{INSTALL_PREFIX}/scalapack/lib;-lscalapack;${lapack_LIBRARIES};-lgfortran" ) set( scalapack_LIBRARIES "${blacs_LIBRARIES}" ) tiledarray-1.0.0/doc/000077500000000000000000000000001375455224000144245ustar00rootroot00000000000000tiledarray-1.0.0/doc/CMakeLists.txt000066400000000000000000000016311375455224000171650ustar00rootroot00000000000000# # This file is a part of TiledArray. # Copyright (C) 2013 Virginia Tech # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . # # Justus Calvin # Department of Chemistry, Virginia Tech # # CMakeLists.txt # Jul 19, 2013 # #-- include doxygen code add_subdirectory(dox) #-- include devsamp code add_subdirectory(devsamp) tiledarray-1.0.0/doc/README.md000066400000000000000000000001171375455224000157020ustar00rootroot00000000000000# Building Documentation * doxygen: `cmake --build --target html` tiledarray-1.0.0/doc/devsamp/000077500000000000000000000000001375455224000160635ustar00rootroot00000000000000tiledarray-1.0.0/doc/devsamp/CMakeLists.txt000066400000000000000000000015501375455224000206240ustar00rootroot00000000000000# # This file is a part of TiledArray. # Copyright (C) 2018 Virginia Tech # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . # # Justus Calvin # Department of Chemistry, Virginia Tech # # CMakeLists.txt # Jul 19, 2013 # #-- include wiki examples add_subdirectory(wiki) tiledarray-1.0.0/doc/devsamp/wiki/000077500000000000000000000000001375455224000170265ustar00rootroot00000000000000tiledarray-1.0.0/doc/devsamp/wiki/CMakeLists.txt000066400000000000000000000021531375455224000215670ustar00rootroot00000000000000# # This file is a part of TiledArray. # Copyright (C) 2018 Virginia Tech # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . # # List of all complete examples set(wikiexamples user-guide-1;user-guide-1a;user-guide-2) # if target examples-tiledarray does not exist yet, create it if (NOT TARGET examples-tiledarray) add_custom_target_subproject(tiledarray examples) endif() foreach(example ${wikiexamples}) add_ta_executable(${example} ${example}.cpp tiledarray) add_dependencies(examples-tiledarray ${example}) endforeach() tiledarray-1.0.0/doc/devsamp/wiki/user-guide-1.cpp000066400000000000000000000003531375455224000217420ustar00rootroot00000000000000#include // imports most TiledArray features int main(int argc, char* argv[]) { // Initialize TA auto& world = TA::initialize(argc, argv); // Do some work here. // Finalize TA TA::finalize(); return 0; } tiledarray-1.0.0/doc/devsamp/wiki/user-guide-1a.cpp000066400000000000000000000013001375455224000220740ustar00rootroot00000000000000#include int main(int argc, char* argv[]) { // Initialize MPI int thread_level_provided; MPI_Init_thread(&argc, &argv, MPI_THREAD_MULTIPLE, &thread_level_provided); assert(MPI_THREAD_MULTIPLE == thread_level_provided); // create a communicator spanning even ranks only int me; MPI_Comm_rank(MPI_COMM_WORLD, &me); MPI_Comm comm_evens; MPI_Comm_split(MPI_COMM_WORLD, (me % 2 ? MPI_UNDEFINED : 0), 0, &comm_evens); // Initialize TA on even ranks only if (comm_evens != MPI_COMM_NULL) { auto& world = TA::initialize(argc, argv, comm_evens); // Do some work here. // Finalize TA TA::finalize(); } // Finalize MPI MPI_Finalize(); return 0; } tiledarray-1.0.0/doc/devsamp/wiki/user-guide-2.cpp000066400000000000000000000054641375455224000217530ustar00rootroot00000000000000#include #include // Construct a Tensor filled with v template TA::Tensor make_tile(const TA::Range& range, const double v) { // Allocate and fill a tile TA::Tensor tile(range); std::fill(tile.begin(), tile.end(), v); return tile; } // Construct a 2-dimensional Tensor filled with v // tests explicit iteration over elements template TA::Tensor make_tile2(const TA::Range& range, const double v) { assert(range.rank() == 2); // Allocate a tile TA::Tensor tile(range); // Store a reference to the start and finish array of the tile const auto& lobound = tile.range().lobound(); const auto& upbound = tile.range().upbound(); // Fill the tile std::size_t i[] = {0, 0}; // or, std::vector i = {0,0}; // or, std::array i = {0,0}; for (i[0] = lobound[0]; i[0] != upbound[0]; ++i[0]) for (i[1] = lobound[1]; i[1] != upbound[1]; ++i[1]) tile[i] = v; return tile; } // Fill array x with value v void init_array(TA::TArrayD& x, const double v) { // Add local tiles to a for (auto it = begin(x); it != end(x); ++it) { // Construct a tile using a MADNESS task. auto tile = x.world().taskq.add(make_tile, x.trange().make_tile_range(it.index()), v); // Insert the tile into the array *it = tile; } } int main(int argc, char* argv[]) { // Initialize runtime auto& world = TA::initialize(argc, argv); // N.B. uncomment to launch via LLDB: // using TiledArray::Debugger; // auto debugger = std::make_shared("user-guide-2"); // Debugger::set_default_debugger(debugger); // debugger->set_prefix(world.rank()); // debugger->set_cmd("lldb_xterm"); // //debugger->set_cmd("gdb_xterm"); // debugger->debug("ready to run"); // Construct tile boundary vector std::vector tile_boundaries; for (std::size_t i = 0; i <= 16; i += 4) tile_boundaries.push_back(i); // Construct a set of TiledRange1's std::vector ranges( 2, TA::TiledRange1(tile_boundaries.begin(), tile_boundaries.end())); // Construct the 2D TiledRange TA::TiledRange trange(ranges.begin(), ranges.end()); // Construct array objects. TA::TArrayD a(world, trange); TA::TArrayD b(world, trange); TA::TArrayD c(world, trange); // Initialize a and b. init_array(a, 3.0); init_array(b, 2.0); // Print the content of input tensors, a and b. std::cout << "a = \n" << a << "\n"; std::cout << "b = \n" << b << "\n"; // Compute the contraction c(m,n) = sum_k a(m,k) * b(k,n) c("m,n") = a("m,k") * b("k,n"); // Print the result tensor, c. std::cout << "c = \n" << c << "\n"; // Wait for all the computation to complete before exiting world.gop.fence(); TA::finalize(); return 0; } tiledarray-1.0.0/doc/dox/000077500000000000000000000000001375455224000152165ustar00rootroot00000000000000tiledarray-1.0.0/doc/dox/CMakeLists.txt000066400000000000000000000025221375455224000177570ustar00rootroot00000000000000# # This file is a part of TiledArray. # Copyright (C) 2013 Virginia Tech # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . # # Justus Calvin # Department of Chemistry, Virginia Tech # # CMakeLists.txt # Jul 19, 2013 # #-- Add an Option to toggle the generation of the API documentation find_package(Doxygen 1.8.12) if(DOXYGEN_FOUND) configure_file(config/Doxyfile.in config/Doxyfile @ONLY IMMEDIATE) # uses standard GNU target name for building html documentation, "html" add_custom_target_subproject (tiledarray html USES_TERMINAL COMMAND ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/doc/dox/config/Doxyfile SOURCES ${PROJECT_BINARY_DIR}/doc/dox/config/Doxyfile) add_custom_target_subproject(tiledarray doc DEPENDS html-tiledarray) endif() tiledarray-1.0.0/doc/dox/README.md000066400000000000000000000003571375455224000165020ustar00rootroot00000000000000# Build * `cmake --build --target html` # Maintainer notes Bootstrap extensions for Doxygen courtesy of https://github.com/Velron/doxygen-bootstrapped/tree/feature/support-doxygen-1.1.12+ . Requires Doxygen 1.8.12 or later. tiledarray-1.0.0/doc/dox/config/000077500000000000000000000000001375455224000164635ustar00rootroot00000000000000tiledarray-1.0.0/doc/dox/config/Doxyfile.in000066400000000000000000003320141375455224000206010ustar00rootroot00000000000000# Doxyfile 1.8.17 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the configuration # file that follow. The default is UTF-8 which is also the encoding used for all # text before the first occurrence of this tag. Doxygen uses libiconv (or the # iconv built into libc) for the transcoding. See # https://www.gnu.org/software/libiconv/ for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = @PROJECT_NAME@ # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. PROJECT_NUMBER = @TILEDARRAY_EXT_VERSION@ # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. PROJECT_LOGO = @PROJECT_SOURCE_DIR@/doc/dox/images/ta_logo_med.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = @PROJECT_BINARY_DIR@/doc/dox # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. # The default value is: NO. CREATE_SUBDIRS = NO # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all generated output in the proper direction. # Possible values are: None, LTR, RTL and Context. # The default value is: None. OUTPUT_TEXT_DIRECTION = None # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. # The default value is: YES. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found # as the leading text of the brief description, will be stripped from the text # and the result, after processing the whole list, is used as the annotated # text. Otherwise, the brief description is used as-is. If left blank, the # following values are used ($name is automatically replaced with the name of # the entity):The $name class, The $name widget, The $name file, is, provides, # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = "The $name class" \ "The $name widget" \ "The $name file" \ is \ provides \ specifies \ contains \ represents \ a \ an \ the # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. # The default value is: NO. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. FULL_PATH_NAMES = YES # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = @PROJECT_SOURCE_DIR@/src # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which # header file to include in order to use a class. If left blank only the name of # the header file containing the class definition is used. Otherwise one should # specify the list of include paths that are normally passed to the compiler # using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the # first line (until the first dot) of a Javadoc-style comment as the brief # description. If set to NO, the Javadoc-style will behave just like regular Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. JAVADOC_AUTOBRIEF = NO # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line # such as # /*************** # as being the beginning of a Javadoc-style comment "banner". If set to NO, the # Javadoc-style will behave just like regular comments and it will not be # interpreted by doxygen. # The default value is: NO. JAVADOC_BANNER = NO # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as # a brief description. This used to be the default behavior. The new default is # to treat a multi-line C++ comment block as a detailed description. Set this # tag to YES if you prefer the old behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new # page for each member. If set to NO, the documentation of a member will be part # of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 2 # This tag can be used to specify a number of aliases that act as commands in # the documentation. An alias has the form: # name=value # For example adding # "sideeffect=@par Side Effects:\n" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines (in the resulting output). You can put ^^ in the value part of an # alias to insert a newline as if a physical newline was in the original file. # When you need a literal { or } or , in the value part of an alias you have to # escape them by means of a backslash (\), this can lead to conflicts with the # commands \{ and \} for these it is advised to use the version @{ and @} or use # a double escape (\\{ and \\}) ALIASES = # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all # members will be omitted, etc. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for VHDL. # The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice # sources only. Doxygen will then generate output that is more tailored for that # language. For instance, namespaces will be presented as modules, types will be # separated into more groups, etc. # The default value is: NO. OPTIMIZE_OUTPUT_SLICE = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser # tries to guess whether the code is fixed or free formatted code, this is the # default for Fortran type files), VHDL, tcl. For instance to make doxygen treat # .inc files as Fortran files (default is PHP), and .f files as C (default is # Fortran), use: inc=Fortran f=C. # # Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See https://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up # to that level are automatically included in the table of contents, even if # they do not have an id attribute. # Note: This feature currently applies only to Markdown headings. # Minimum value: 0, maximum value: 99, default value: 5. # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. TOC_INCLUDE_HEADINGS = 0 # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or # globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this # tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = YES # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make # doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. # The default value is: YES. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = YES # If one adds a struct or class to a group and this option is enabled, then also # any nested class or struct is added to the same group. By default this option # is disabled and one has to add nested compounds explicitly via \ingroup. # The default value is: NO. GROUP_NESTED_COMPOUNDS = YES # Set the SUBGROUPING tag to YES to allow class member groups of the same type # (for instance a group of public functions) to be put as a subgroup of that # type (e.g. under the Public Functions section). Set it to NO to prevent # subgrouping. Alternatively, this can be done per class using the # \nosubgrouping command. # The default value is: YES. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions # are shown inside the group in which they are included (e.g. using \ingroup) # instead of on a separate page (for HTML and Man pages) or section (for LaTeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If set # to NO, structs, classes, and unions are shown on a separate page (for HTML and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or # enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically be # useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual # methods of a class will be included in the documentation. # The default value is: NO. EXTRACT_PRIV_VIRTUAL = NO # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = NO # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. If set to YES, local methods, # which are defined in the implementation section but not in the interface are # included in the documentation. If set to NO, only methods in the interface are # included. # The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base name of # the file that contains the anonymous namespace. By default anonymous namespace # are hidden. # The default value is: NO. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option # has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # declarations. If set to NO, these declarations will be included in the # documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation that is typed after a # \internal command is included. If the tag is set to NO then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file # names in lower-case letters. If set to YES, upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # (including Cygwin) ands Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. HIDE_COMPOUND_REFERENCE= NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = YES # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical # list. # The default value is: NO. SORT_BY_SCOPE_NAME = YES # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo # list. This list is created by putting \todo commands in the documentation. # The default value is: YES. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = @PROJECT_SOURCE_DIR@/doc/dox/config/layout.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = YES # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters # in a documented function, or documenting parameters that don't exist or using # markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO, doxygen will only warn about wrong or incomplete # parameter documentation, but not about the absence of documentation. If # EXTRACT_ALL is set to YES then this flag will automatically be disabled. # The default value is: NO. WARN_NO_PARAMDOC = NO # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. # The default value is: NO. WARN_AS_ERROR = NO # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard # error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. INPUT = @PROJECT_SOURCE_DIR@/src \ @PROJECT_SOURCE_DIR@/doc/dox/user \ @PROJECT_SOURCE_DIR@/doc/dox/dev \ @PROJECT_SOURCE_DIR@/doc/dox/contrib \ @PROJECT_SOURCE_DIR@/README.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: https://www.gnu.org/software/libiconv/) for the list of # possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # read by doxygen. # # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), # *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen # C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd, # *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = *.c \ *.cc \ *.cxx \ *.cpp \ *.c++ \ *.d \ *.java \ *.ii \ *.ixx \ *.ipp \ *.i++ \ *.inl \ *.h \ *.hh \ *.hxx \ *.hpp \ *.h++ \ *.idl \ *.odl \ *.cs \ *.php \ *.php3 \ *.inc \ *.m \ *.mm \ *.dox \ *.py \ *.f90 \ *.f \ *.vhd \ *.vhdl \ *.md # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank all # files are included. EXAMPLE_PATTERNS = * # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands # irrespective of the value of the RECURSIVE tag. # The default value is: NO. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the # \image command). IMAGE_PATH = @PROJECT_SOURCE_DIR@/doc/dox/images # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # # # # where is the value of the INPUT_FILTER tag, and is the # name of an input file. Doxygen will then use the output that the filter # program writes to standard output. If FILTER_PATTERNS is specified, this tag # will be ignored. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: pattern=filter # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = README.md #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will be # generated. Documented entities will be cross-referenced with these sources. # # Note: To get rid of all source code in the generated output, make sure that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = YES # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # entity all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see https://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. # The default value is: YES. VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all # compounds will be generated. Enable this if the project contains a lot of # classes, structs, unions or interfaces. # The default value is: YES. ALPHABETICAL_INDEX = YES # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = @PROJECT_SOURCE_DIR@/doc/dox/config/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = @PROJECT_SOURCE_DIR@/doc/dox/config/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of # the HTML output. If left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = @PROJECT_SOURCE_DIR@/doc/dox/config/customdoxygen.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = @PROJECT_SOURCE_DIR@/doc/dox/config/doxy-boot.js \ @PROJECT_SOURCE_DIR@/doc/dox/config/jquery.smartmenus.js \ @PROJECT_SOURCE_DIR@/doc/dox/config/addons/bootstrap/jquery.smartmenus.bootstrap.js \ @PROJECT_SOURCE_DIR@/doc/dox/config/addons/bootstrap/jquery.smartmenus.bootstrap.css \ @PROJECT_SOURCE_DIR@/doc/dox/config/addons/keyboard/jquery.smartmenus.keyboard.js # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # https://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to YES can help to show when doxygen was last run and thus if the # documentation is up to date. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = YES # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that # are dynamically created via JavaScript. If disabled, the navigation index will # consists of multiple levels of tabs that are statically embedded in every HTML # page. Disable this option to support browsers that do not have JavaScript, # like the Qt help browser. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_MENUS = NO # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to # such a level that at most the specified number of entries are visible (unless # a fully collapsed tree already exceeds this amount). So setting the number of # entries 1 will produce a full collapsed tree by default. 0 is a special value # representing an infinite number of entries and will result in a full expanded # tree by default. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: https://developer.apple.com/xcode/), introduced with OSX # 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy # genXcode/_index.html for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider # (such as a company or product suite) can be grouped. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated # (YES) or that it should be included in the master .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help # (.qch) of the generated HTML documentation. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag # value is set to YES, a side panel will be generated containing a tree-like # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = NO # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANSPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands # to create new LaTeX commands to be used in formulas as building blocks. See # the section "Including formulas" for details. FORMULA_MACROFILE = # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # https://www.mathjax.org) which uses client side JavaScript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: # http://docs.mathjax.org/en/latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from https://www.mathjax.org before deployment. # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically # , /