Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update doc on using HPC clusters #25

Merged
merged 1 commit into from
Jan 28, 2025
+408 −95
Merged

Update doc on using HPC clusters #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 90 additions & 90 deletions CMakePresets.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,105 +1,105 @@
{
"version": 6,
"cmakeMinimumRequired": {
"major": 3,
"minor": 24,
"patch": 0
"version": 6,
"cmakeMinimumRequired": {
"major": 3,
"minor": 24,
"patch": 0
},
"configurePresets": [
{
"name": "simple",
"displayName": "Simple config for R3BRoot without conan",
"description": "Simple build with conan package manager",
"binaryDir": "${sourceDir}/build",
"cacheVariables": {
"CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
"BUILD_GEOMETRY": "OFF",
"USE_DIFFERENT_COMPILER": "ON",
"CMAKE_BUILD_TYPE": "RelWithDebInfo",
"FETCH_GTEST": "ON",
"CONAN_ENABLED": "OFF"
}
},
"configurePresets": [
{
"name": "simple",
"displayName": "Simple config for R3BRoot without conan",
"description": "Simple build with conan package manager",
"binaryDir": "${sourceDir}/build",
"cacheVariables": {
"CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
"BUILD_GEOMETRY": "OFF",
"USE_DIFFERENT_COMPILER": "ON",
"CMAKE_BUILD_TYPE": "RelWithDebInfo",
"FETCH_GTEST": "ON",
"CONAN_ENABLED": "OFF"
}
},
{
"name": "default",
"displayName": "Default Config for R3BRoot",
"description": "Default build with conan package manager",
"binaryDir": "${sourceDir}/build",
"cacheVariables": {
"CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
"BUILD_GEOMETRY": "OFF",
"CMAKE_BUILD_TYPE": "RelWithDebInfo",
"CMAKE_PROJECT_TOP_LEVEL_INCLUDES": "util/cmake-conan/conan_provider.cmake",
"CONAN_ENABLED": "ON",
"CONAN_INSTALL_ARGS": "--build=missing;--settings:build=compiler.cppstd=gnu17"
}
},
{
"name": "doxygen",
"displayName": "Config for doxygen build of R3BRoot",
"description": "Only build the doxygen documentation",
"binaryDir": "${sourceDir}/build",
"cacheVariables": {
"CMAKE_BUILD_TYPE": "RelWithDebInfo",
"WITH_DOX": "ON",
"NO_BUILD": "ON"
}
}
],
"buildPresets": [
{
"name": "default",
"configurePreset": "default"
},
{
"name": "doxygen",
"configurePreset": "doxygen",
"targets": "doxygen"
},
{
"name": "simple",
"configurePreset": "simple"
}
],
"workflowPresets": [
{
"name": "default",
"steps": [
{
"name": "default",
"displayName": "Default Config for R3BRoot",
"description": "Default build with conan package manager",
"binaryDir": "${sourceDir}/build",
"cacheVariables": {
"CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
"BUILD_GEOMETRY": "OFF",
"CMAKE_BUILD_TYPE": "RelWithDebInfo",
"CMAKE_PROJECT_TOP_LEVEL_INCLUDES": "util/cmake-conan/conan_provider.cmake",
"CONAN_ENABLED": "ON",
"CONAN_INSTALL_ARGS": "--build=missing;--settings:build=compiler.cppstd=gnu17"
}
"type": "configure",
"name": "default"
},
{
"name": "doxygen",
"displayName": "Config for doxygen build of R3BRoot",
"description": "Only build the doxygen documentation",
"binaryDir": "${sourceDir}/build",
"cacheVariables": {
"CMAKE_BUILD_TYPE": "RelWithDebInfo",
"WITH_DOX": "ON",
"NO_BUILD": "ON"
}
"type": "build",
"name": "default"
}
],
"buildPresets": [
{
"name": "default",
"configurePreset": "default"
},
]
},
{
"name": "simple",
"steps": [
{
"name": "doxygen",
"configurePreset": "doxygen",
"targets": "doxygen"
"type": "configure",
"name": "simple"
},
{
"name": "simple",
"configurePreset": "simple"
"type": "build",
"name": "simple"
}
],
"workflowPresets": [
{
"name": "default",
"steps": [
{
"type": "configure",
"name": "default"
},
{
"type": "build",
"name": "default"
}
]
},
]
},
{
"name": "doxygen",
"steps": [
{
"name": "simple",
"steps": [
{
"type": "configure",
"name": "simple"
},
{
"type": "build",
"name": "simple"
}
]
"type": "configure",
"name": "doxygen"
},
{
"name": "doxygen",
"steps": [
{
"type": "configure",
"name": "doxygen"
},
{
"type": "build",
"name": "doxygen"
}
]
"type": "build",
"name": "doxygen"
}
]
]
}
]
}
84 changes: 84 additions & 0 deletions config/dox_header.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
<!-- HTML header for doxygen 1.13.2-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="$langISO">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen $doxygenversion"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
<!--BEGIN PROJECT_ICON-->
<link rel="icon" href="$relpath^$projecticon" type="image/x-icon" />
<!--END PROJECT_ICON-->
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
<!--BEGIN DISABLE_INDEX-->
<!--BEGIN FULL_SIDEBAR-->
<script type="text/javascript">var page_layout=1;</script>
<!--END FULL_SIDEBAR-->
<!--END DISABLE_INDEX-->
<script type="text/javascript" src="$relpath^jquery.js"></script>
<script type="text/javascript" src="$relpath^dynsections.js"></script>
<!--BEGIN COPY_CLIPBOARD-->
<script type="text/javascript" src="$relpath^clipboard.js"></script>
<!--END COPY_CLIPBOARD-->
$treeview
$search
$mathjax
$darkmode
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
$extrastylesheet
<script type="text/javascript" src="$relpath^doxygen-awesome-interactive-toc.js"></script>
<script type="text/javascript">
DoxygenAwesomeInteractiveToc.init()
</script>
</head>
<body>
<!--BEGIN DISABLE_INDEX-->
<!--BEGIN FULL_SIDEBAR-->
<div id="side-nav" class="ui-resizable side-nav-resizable"><!-- do not remove this div, it is closed by doxygen! -->
<!--END FULL_SIDEBAR-->
<!--END DISABLE_INDEX-->

<div id="top"><!-- do not remove this div, it is closed by doxygen! -->

<!--BEGIN TITLEAREA-->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<!--BEGIN PROJECT_LOGO-->
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"$logosize/></td>
<!--END PROJECT_LOGO-->
<!--BEGIN PROJECT_NAME-->
<td id="projectalign">
<div id="projectname">$projectname<!--BEGIN PROJECT_NUMBER--><span id="projectnumber">&#160;$projectnumber</span><!--END PROJECT_NUMBER-->
</div>
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
</td>
<!--END PROJECT_NAME-->
<!--BEGIN !PROJECT_NAME-->
<!--BEGIN PROJECT_BRIEF-->
<td>
<div id="projectbrief">$projectbrief</div>
</td>
<!--END PROJECT_BRIEF-->
<!--END !PROJECT_NAME-->
<!--BEGIN DISABLE_INDEX-->
<!--BEGIN SEARCHENGINE-->
<!--BEGIN !FULL_SIDEBAR-->
<td>$searchbox</td>
<!--END !FULL_SIDEBAR-->
<!--END SEARCHENGINE-->
<!--END DISABLE_INDEX-->
</tr>
<!--BEGIN SEARCHENGINE-->
<!--BEGIN FULL_SIDEBAR-->
<tr><td colspan="2">$searchbox</td></tr>
<!--END FULL_SIDEBAR-->
<!--END SEARCHENGINE-->
</tbody>
</table>
</div>
<!--END TITLEAREA-->
<!-- end header part -->
8 changes: 6 additions & 2 deletions doc/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,17 @@ set(DOXYGEN_USE_MATHJAX YES)
set(DOXYGEN_RECURSIVE YES)
set(DOXYGEN_IMPLICIT_DIR_DOCS NO)
set(DOXYGEN_MAX_DOT_GRAPH_DEPTH 2)
set(DOXYGEN_TOC_INCLUDE_HEADINGS 6)
set(DOXYGEN_MARKDOWN_SUPPORT YES)
# set(DOXYGEN_USE_MDFILE_AS_MAINPAGE "${PROJECT_SOURCE_DIR}/README.md")
set(DOXYGEN_IMAGE_PATH "${PROJECT_SOURCE_DIR}/doc/pics" "${PROJECT_SOURCE_DIR}/neuland/docs/figs"
"${PROJECT_SOURCE_DIR}/neuland/shared")

# For doxygen-awesome
set(DOXYGEN_HTML_EXTRA_STYLESHEET "${AWESOME_CSS_DIR}/doxygen-awesome.css"
"${AWESOME_CSS_DIR}/doxygen-awesome-sidebar-only.css")
set(DOXYGEN_HTML_EXTRA_STYLESHEET
"${AWESOME_CSS_DIR}/doxygen-awesome.css" "${AWESOME_CSS_DIR}/doxygen-awesome-sidebar-only.css"
"${AWESOME_CSS_DIR}/doxygen-awesome-interactive-toc.js")
set(DOXYGEN_HTML_HEADER "${PROJECT_SOURCE_DIR}/config/dox_header.html")
set(DOXYGEN_DISABLE_INDEX NO)
set(DOXYGEN_FULL_SIDEBAR NO)
set(DOXYGEN_GENERATE_TREEVIEW YES)
Expand Down
Empty file removed neuland/docs/neuland_container.dox
View file
Open in desktop
Empty file.
Loading