Skip to content

Commit 91e4307

Browse files
corbett5corbett5
committed
Documentation changes.
1 parent 6342078 commit 91e4307

39 files changed

Lines changed: 3646 additions & 222 deletions

‎.readthedocs.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ version: 2
77

88
# Build documentation in the docs/ directory with Sphinx
99
sphinx:
10-
configuration: src/conf.py
10+
configuration: docs/sphinx/conf.py
1111
builder: html
1212

1313
# Build documentation with MkDocs

‎CMakeLists.txt‎

Lines changed: 39 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,34 @@
1-
cmake_minimum_required(VERSION 3.9)
1+
cmake_minimum_required( VERSION 3.9 )
22

33
# check if LvArray is build as a submodule or a separate project
4-
get_directory_property(parent_dir PARENT_DIRECTORY)
4+
get_directory_property( parent_dir PARENT_DIRECTORY )
55
if(parent_dir)
6-
set(is_submodule ON)
6+
set( is_submodule ON )
77
else()
8-
set(is_submodule OFF)
8+
set( is_submodule OFF )
99
endif()
1010

11-
if(NOT is_submodule)
11+
if( NOT is_submodule )
1212

13-
project(LvArray LANGUAGES C CXX)
13+
project( LvArray LANGUAGES C CXX )
1414

15-
set(BLT_CXX_STD "c++14" CACHE STRING "Version of C++ standard" FORCE)
16-
set(ENABLE_WARNINGS_AS_ERRORS "ON" CACHE PATH "")
15+
set( BLT_CXX_STD "c++14" CACHE STRING "Version of C++ standard" FORCE )
16+
set( ENABLE_WARNINGS_AS_ERRORS "ON" CACHE PATH "" )
1717

18-
option(ENABLE_BENCHMARKS "Enables benchmarks" ON)
19-
include(cmake/blt/SetupBLT.cmake)
20-
include(cmake/CMakeBasics.cmake)
21-
include(cmake/SetupTPL.cmake)
18+
option( ENABLE_TESTS "Builds tests" ON )
19+
option( ENABLE_EXAMPLES "Builds examples" ON )
20+
option( ENABLE_BENCHMARKS "Builds benchmarks" ON )
21+
option( ENABLE_DOCS "Builds documentation" ON )
2222

23+
option( ENABLE_CHAI "Build with CHAI" ON )
24+
option( ENABLE_MPI "Build with MPI" ON )
25+
option( ENABLE_CUDA "Build with CUDA" OFF )
26+
option( ENABLE_OPENMP "Build with OpenMP" ON )
27+
option( ENABLE_CALIPER "Build with Caliper" ON )
28+
29+
include( cmake/blt/SetupBLT.cmake )
30+
include( cmake/CMakeBasics.cmake )
31+
include( cmake/SetupTPL.cmake )
2332
endif()
2433

2534
include(cmake/Macros.cmake)
@@ -51,7 +60,22 @@ if( ENABLE_CALIPER )
5160
set( lvarray_dependencies ${lvarray_dependencies} caliper )
5261
endif()
5362

54-
add_subdirectory(unitTests)
55-
add_subdirectory(benchmarks)
56-
add_subdirectory(src)
63+
64+
if( ENABLE_TESTS )
65+
add_subdirectory( unitTests )
66+
endif()
67+
68+
if ( ENABLE_EXAMPLES )
69+
add_subdirectory( examples )
70+
endif()
71+
72+
if( ENABLE_BENCHMARKS )
73+
add_subdirectory( benchmarks )
74+
endif()
75+
76+
if( ENABLE_DOCS )
77+
add_subdirectory( docs )
78+
endif()
79+
80+
add_subdirectory( src )
5781

‎README.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,11 @@ The LvArray project is a collection of array classes for use in high-performance
55
simulation software.
66
LvArray provides:
77
1. Multi-dimensional arrays with permutable data layout.
8-
2. Sorted Arrays are similar to [std::set](https://en.cppreference.com/w/cpp/container/set) but are contigous in memory.
8+
2. Sorted Arrays are similar to [std::set](https://en.cppreference.com/w/cpp/container/set) but are contiguous in memory.
99
3. ArrayOfArrays provide a 2-dimensional array with variable sized second dimension.
1010
4. ArrayOfSets provide a 2-dimensional array with variable sized second dimension that are sorted.
1111
5. CRSMatrix for storage of sparse matricies.
12+
1213
All components of LvArray provide smart management of data motion between memory
1314
spaces on systems with hetergeneous memory (e.g. CPU/GPU) through lambda copy
1415
semantics in [RAJA](https://github.com/LLNL/RAJA), similar to the implementation of the [CHAI::ManagedArray](https://github.com/LLNL/CHAI)
@@ -21,7 +22,7 @@ Full documenation is hosted at [readthedocs](https://lvarray.readthedocs.io/en/l
2122

2223
Authors
2324
-------
24-
See [Github](https://github.com/GEOSX/cxx-utilities/graphs/contributors)
25+
See [Github](https://github.com/GEOSX/LvArray/graphs/contributors)
2526

2627
Release
2728
-------
@@ -38,4 +39,4 @@ It is also linked here:
3839
[LICENSE](./LICENSE)
3940
`LLNL-Code-746361` `OCEC-18-021`
4041

41-
Next release will be BSD.
42+
Next release will be BSD.

‎cmake/Config.cmake‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
#
22
set( PREPROCESSOR_DEFINES ARRAY_BOUNDS_CHECK
3-
ATK
43
CHAI
54
CUDA
65
MPI
7-
RAJA
86
TOTALVIEW_OUTPUT
97
OPENMP
10-
)
8+
CALIPER )
119

1210
set( USE_CONFIGFILE ON CACHE BOOL "" )
1311
foreach( DEP in ${PREPROCESSOR_DEFINES})
@@ -28,7 +26,7 @@ function( make_full_config_file
2826
endforeach()
2927

3028
configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/src/LvArrayConfig.hpp.in
31-
${CMAKE_CURRENT_SOURCE_DIR}/src/docs/doxygen/LvArrayConfig.hpp )
29+
${CMAKE_CURRENT_SOURCE_DIR}/docs/doxygen/LvArrayConfig.hpp )
3230
endfunction()
3331

3432

‎cmake/SetupTPL.cmake‎

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
set( thirdPartyLibs "")
22

3-
43
################################
54
# RAJA
65
################################
@@ -81,22 +80,6 @@ endif()
8180
# CALIPER and Adiak
8281
################################
8382
if(ENABLE_CALIPER)
84-
if(NOT EXISTS ${ADIAK_DIR})
85-
set(ADIAK_DIR ${GEOSX_TPL_DIR}/adiak)
86-
endif()
87-
88-
message(STATUS "Using adiak at ${ADIAK_DIR}")
89-
90-
find_package(adiak REQUIRED
91-
PATHS ${ADIAK_DIR}/lib/cmake/adiak)
92-
93-
blt_register_library(NAME adiak
94-
INCLUDES ${adiak_INCLUDE_DIRS}
95-
LIBRARIES ${adiak_LIBRARIES}
96-
TREAT_INCLUDES_AS_SYSTEM ON)
97-
98-
set(thirdPartyLibs ${thirdPartyLibs} adiak)
99-
10083
if(NOT EXISTS ${CALIPER_DIR})
10184
set(CALIPER_DIR ${GEOSX_TPL_DIR}/caliper)
10285
endif()

src/docs/CMakeLists.txt renamed to docs/CMakeLists.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22
# documentation targets
33
################################
44

5-
#add_subdirectory(sphinx)
6-
7-
if(DOXYGEN_FOUND)
5+
if( DOXYGEN_FOUND )
86
add_subdirectory(doxygen)
97
endif()
108

9+
if( SPHINX_FOUND )
10+
add_subdirectory(sphinx)
11+
endif()
1112

‎docs/doxygen/CMakeLists.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blt_add_doxygen_target( LvArray_doxygen )

src/docs/doxygen/Doxyfile.in renamed to docs/doxygen/Doxyfile.in

File renamed without changes.

‎docs/doxygen/LvArrayConfig.hpp‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
/*
2+
* Copyright (c) 2020, Lawrence Livermore National Security, LLC and LvArray contributors.
3+
* All rights reserved.
4+
* See the LICENSE file for details.
5+
* SPDX-License-Identifier: (BSD-3-Clause)
6+
*/
7+
8+
/**
9+
* @file LvArrayConfig.hpp
10+
* @brief Contains platform specific parameters defined by CMake.
11+
*/
12+
13+
#pragma once
14+
15+
#define USE_ARRAY_BOUNDS_CHECK
16+
17+
#ifndef USE_CHAI
18+
#define USE_CHAI
19+
#endif
20+
21+
#ifndef USE_CUDA
22+
#define USE_CUDA
23+
#endif
24+
25+
#ifndef USE_MPI
26+
#define USE_MPI
27+
#endif
28+
29+
#ifndef USE_TOTALVIEW_OUTPUT
30+
#define USE_TOTALVIEW_OUTPUT
31+
#endif
32+
33+
#ifndef USE_OPENMP
34+
#define USE_OPENMP
35+
#endif
36+
37+
#ifndef USE_CALIPER
38+
#define USE_CALIPER
39+
#endif

0 commit comments

Comments
 (0)