From 8c2dbe92cc2ac881bf5506e8a6d1eb60ba50b083 Mon Sep 17 00:00:00 2001 From: Daniel Schwen Date: Thu, 18 Aug 2022 15:18:35 -0600 Subject: [PATCH] Fix docs (#21885) --- modules/optimization/doc/config.yml | 22 +++----- modules/optimization/doc/content/index.md | 52 +------------------ .../examples/forceInv_BodyLoad.md | 0 .../examples/forceInv_DirichletBC.md | 0 .../examples/forceInv_NeumannBC.md | 0 .../optimization}/examples/forceInv_main.md | 0 .../examples/forceInv_pointLoads.md | 0 .../optimization}/examples/index.md | 0 .../examples/materialInv_ConstK.md | 0 .../examples/materialInv_ConvectiveBC.md | 0 .../examples/materialInv_TDepK.md | 0 .../examples/materialInv_main.md | 0 .../getting_started/InvOptTheory.md | 0 .../OptimizationInputStructure.md | 0 .../getting_started/RunningOptimization.md | 0 .../doc/content/modules/optimization/index.md | 51 ++++++++++++++++++ modules/optimization/doc/moosedocs.py | 30 +---------- 17 files changed, 61 insertions(+), 94 deletions(-) rename modules/optimization/doc/content/{ => modules/optimization}/examples/forceInv_BodyLoad.md (100%) rename modules/optimization/doc/content/{ => modules/optimization}/examples/forceInv_DirichletBC.md (100%) rename modules/optimization/doc/content/{ => modules/optimization}/examples/forceInv_NeumannBC.md (100%) rename modules/optimization/doc/content/{ => modules/optimization}/examples/forceInv_main.md (100%) rename modules/optimization/doc/content/{ => modules/optimization}/examples/forceInv_pointLoads.md (100%) rename modules/optimization/doc/content/{ => modules/optimization}/examples/index.md (100%) rename modules/optimization/doc/content/{ => modules/optimization}/examples/materialInv_ConstK.md (100%) rename modules/optimization/doc/content/{ => modules/optimization}/examples/materialInv_ConvectiveBC.md (100%) rename modules/optimization/doc/content/{ => modules/optimization}/examples/materialInv_TDepK.md (100%) rename modules/optimization/doc/content/{ => modules/optimization}/examples/materialInv_main.md (100%) rename modules/optimization/doc/content/{ => modules/optimization}/getting_started/InvOptTheory.md (100%) rename modules/optimization/doc/content/{ => modules/optimization}/getting_started/OptimizationInputStructure.md (100%) rename modules/optimization/doc/content/{ => modules/optimization}/getting_started/RunningOptimization.md (100%) create mode 100644 modules/optimization/doc/content/modules/optimization/index.md mode change 100755 => 120000 modules/optimization/doc/moosedocs.py diff --git a/modules/optimization/doc/config.yml b/modules/optimization/doc/config.yml index f0e99ab85521..03917b90feb6 100644 --- a/modules/optimization/doc/config.yml +++ b/modules/optimization/doc/config.yml @@ -11,19 +11,13 @@ Extensions: name: MOOSE Optimization Module repo: https://github.com/idaholab/moose home: /modules/optimization/index.md - menu: - Getting Started: - Theory: getting_started/InvOptTheory.md - Running Optimization Problems: getting_started/RunningOptimization.md - Input Structure: getting_started/OptimizationInputStructure.md - Syntax: syntax/index.md - Examples: examples/index.md - Syntax: syntax/index.md MooseDocs.extensions.appsyntax: - executable: ${MOOSE_DIR}.modules/optimize + executable: ${MOOSE_DIR}/modules/optimization remove: - framework: !include ${MOOSE_DIR}/framework/doc/remove.yml + framework: !include framework/doc/remove.yml + unregister: + framework: !include framework/doc/unregister.yml includes: - framework/include - modules/optimization/include @@ -31,16 +25,16 @@ Extensions: - modules/stochastic_tools/include MooseDocs.extensions.common: - shortcuts: !include ${MOOSE_DIR}/framework/doc/globals.yml + shortcuts: !include framework/doc/globals.yml MooseDocs.extensions.acronym: - acronyms: !include ${MOOSE_DIR}/framework/doc/acronyms.yml + acronyms: !include framework/doc/acronyms.yml MooseDocs.extensions.template: active: True MooseDocs.extensions.sqa: active: False - reports: !include ${ROOT_DIR}/doc/sqa_reports.yml + reports: !include modules/optimization/doc/sqa_reports.yml categories: framework: !include framework/doc/sqa_framework.yml - optimization: !include modules/stochastic_tools/doc/sqa_optimization.yml + optimization: !include modules/optimization/doc/sqa_optimization.yml stochastic_tools: !include modules/stochastic_tools/doc/sqa_stochastic_tools.yml heat_conduction: !include modules/heat_conduction/doc/sqa_heat_conduction.yml diff --git a/modules/optimization/doc/content/index.md b/modules/optimization/doc/content/index.md index b19a52c8c453..e7131d8912da 100644 --- a/modules/optimization/doc/content/index.md +++ b/modules/optimization/doc/content/index.md @@ -1,51 +1 @@ -!config navigation breadcrumbs=False scrollspy=False - -# Isopod class=center style=font-weight:600;font-size:350%; - -### Inverse Optimization Code class=center style=font-weight:200;font-size:200% - - -Isopod is an application for solving inverse optimization problems in moose. It -is based on PDE constrained optimization using the PETSC TAO optimization solver. -Isopod is based on the MOOSE framework, and builds on the MOOSE framework and -modules for many of its core capabilities. - -!row! -!col! small=12 medium=4 large=4 icon=toys -### [Theory](getting_started/InvOptTheory.md) class=center style=font-weight:200; - -Learn the theory behind PDE constrained optimization as implemented in isopod. -!col-end! - -!col! small=12 medium=4 large=4 icon=settings -### [Syntax](syntax/index.md) class=center style=font-weight:200; - -Isopod provides capabilities that can be applied to a wide variety of problems. The syntax -provides detailed documentation of specific code features. -!col-end! - -!col! small=12 medium=4 large=4 icon=assessment -### [Example](examples/index.md) class=center style=font-weight:200; - -There are a number of inverse optimization example problems to demonstrate usage of Isopod. Details of those models are -provided here. -!col-end! -!row-end! - - -Isopod is based on [MOOSE](http://mooseframework.org). It is an extremely flexible environment that -permits the solution of coupled physics problems of varying size and dimensionality. These can be -solved using computer hardware appropriate for the model size, ranging from laptops and workstations -to large high performance computers. - -!media media/inl_blue.png style=float:right;width:30%;margin-left:30px; - -Code reliability is a central principle in code development, and this project employs a well defined -development and testing strategy. Code changes are only merged into the repository after both a -manual code review and the automated regression test system have been completed. The testing process -and status of Isopod is available at [www.moosebuild.inl.gov](https://moosebuild.inl.gov/repo/5/). - -Isopod and MOOSE are developed by the Idaho National Laboratory by a team of computer scientists -and engineers and is supported by various funding agencies including the -[United States Department of Energy](http://energy.gov). Development of these codes is ongoing at -INL and by collaborators throughout the world. +[modules/optimization/index.md] diff --git a/modules/optimization/doc/content/examples/forceInv_BodyLoad.md b/modules/optimization/doc/content/modules/optimization/examples/forceInv_BodyLoad.md similarity index 100% rename from modules/optimization/doc/content/examples/forceInv_BodyLoad.md rename to modules/optimization/doc/content/modules/optimization/examples/forceInv_BodyLoad.md diff --git a/modules/optimization/doc/content/examples/forceInv_DirichletBC.md b/modules/optimization/doc/content/modules/optimization/examples/forceInv_DirichletBC.md similarity index 100% rename from modules/optimization/doc/content/examples/forceInv_DirichletBC.md rename to modules/optimization/doc/content/modules/optimization/examples/forceInv_DirichletBC.md diff --git a/modules/optimization/doc/content/examples/forceInv_NeumannBC.md b/modules/optimization/doc/content/modules/optimization/examples/forceInv_NeumannBC.md similarity index 100% rename from modules/optimization/doc/content/examples/forceInv_NeumannBC.md rename to modules/optimization/doc/content/modules/optimization/examples/forceInv_NeumannBC.md diff --git a/modules/optimization/doc/content/examples/forceInv_main.md b/modules/optimization/doc/content/modules/optimization/examples/forceInv_main.md similarity index 100% rename from modules/optimization/doc/content/examples/forceInv_main.md rename to modules/optimization/doc/content/modules/optimization/examples/forceInv_main.md diff --git a/modules/optimization/doc/content/examples/forceInv_pointLoads.md b/modules/optimization/doc/content/modules/optimization/examples/forceInv_pointLoads.md similarity index 100% rename from modules/optimization/doc/content/examples/forceInv_pointLoads.md rename to modules/optimization/doc/content/modules/optimization/examples/forceInv_pointLoads.md diff --git a/modules/optimization/doc/content/examples/index.md b/modules/optimization/doc/content/modules/optimization/examples/index.md similarity index 100% rename from modules/optimization/doc/content/examples/index.md rename to modules/optimization/doc/content/modules/optimization/examples/index.md diff --git a/modules/optimization/doc/content/examples/materialInv_ConstK.md b/modules/optimization/doc/content/modules/optimization/examples/materialInv_ConstK.md similarity index 100% rename from modules/optimization/doc/content/examples/materialInv_ConstK.md rename to modules/optimization/doc/content/modules/optimization/examples/materialInv_ConstK.md diff --git a/modules/optimization/doc/content/examples/materialInv_ConvectiveBC.md b/modules/optimization/doc/content/modules/optimization/examples/materialInv_ConvectiveBC.md similarity index 100% rename from modules/optimization/doc/content/examples/materialInv_ConvectiveBC.md rename to modules/optimization/doc/content/modules/optimization/examples/materialInv_ConvectiveBC.md diff --git a/modules/optimization/doc/content/examples/materialInv_TDepK.md b/modules/optimization/doc/content/modules/optimization/examples/materialInv_TDepK.md similarity index 100% rename from modules/optimization/doc/content/examples/materialInv_TDepK.md rename to modules/optimization/doc/content/modules/optimization/examples/materialInv_TDepK.md diff --git a/modules/optimization/doc/content/examples/materialInv_main.md b/modules/optimization/doc/content/modules/optimization/examples/materialInv_main.md similarity index 100% rename from modules/optimization/doc/content/examples/materialInv_main.md rename to modules/optimization/doc/content/modules/optimization/examples/materialInv_main.md diff --git a/modules/optimization/doc/content/getting_started/InvOptTheory.md b/modules/optimization/doc/content/modules/optimization/getting_started/InvOptTheory.md similarity index 100% rename from modules/optimization/doc/content/getting_started/InvOptTheory.md rename to modules/optimization/doc/content/modules/optimization/getting_started/InvOptTheory.md diff --git a/modules/optimization/doc/content/getting_started/OptimizationInputStructure.md b/modules/optimization/doc/content/modules/optimization/getting_started/OptimizationInputStructure.md similarity index 100% rename from modules/optimization/doc/content/getting_started/OptimizationInputStructure.md rename to modules/optimization/doc/content/modules/optimization/getting_started/OptimizationInputStructure.md diff --git a/modules/optimization/doc/content/getting_started/RunningOptimization.md b/modules/optimization/doc/content/modules/optimization/getting_started/RunningOptimization.md similarity index 100% rename from modules/optimization/doc/content/getting_started/RunningOptimization.md rename to modules/optimization/doc/content/modules/optimization/getting_started/RunningOptimization.md diff --git a/modules/optimization/doc/content/modules/optimization/index.md b/modules/optimization/doc/content/modules/optimization/index.md new file mode 100644 index 000000000000..286729485eb2 --- /dev/null +++ b/modules/optimization/doc/content/modules/optimization/index.md @@ -0,0 +1,51 @@ +!config navigation breadcrumbs=False scrollspy=False + +# MOOSE Optimization Module + +## Inverse Optimization Code + +The MOOSE Optimization Module provides functionality for solving inverse optimization +problems in moose. It is based on PDE constrained optimization using the PETSC TAO optimization solver. + +!row! +!col! small=12 medium=4 large=4 icon=toys +### [Theory](getting_started/InvOptTheory.md) class=center style=font-weight:200; + +Learn the theory behind PDE constrained optimization as implemented in the MOOSE optimization module. +!col-end! + +!col! small=12 medium=4 large=4 icon=settings +### [Syntax](syntax/index.md) class=center style=font-weight:200; + +Isopod provides capabilities that can be applied to a wide variety of problems. The syntax +provides detailed documentation of specific code features. + +- [Input file structure](getting_started/OptimizationInputStructure.md) +- [Running optimization problems](getting_started/RunningOptimization.md) +!col-end! + +!col! small=12 medium=4 large=4 icon=assessment +### [Examples](examples/index.md) class=center style=font-weight:200; + +There are a number of inverse optimization example problems to demonstrate usage of Isopod. Details of those models are +provided here. +!col-end! +!row-end! + + +Isopod is based on [MOOSE](http://mooseframework.org). It is an extremely flexible environment that +permits the solution of coupled physics problems of varying size and dimensionality. These can be +solved using computer hardware appropriate for the model size, ranging from laptops and workstations +to large high performance computers. + +!media media/inl_blue.png style=float:right;width:30%;margin-left:30px; + +Code reliability is a central principle in code development, and this project employs a well defined +development and testing strategy. Code changes are only merged into the repository after both a +manual code review and the automated regression test system have been completed. The testing process +and status of Isopod is available at [www.moosebuild.inl.gov](https://moosebuild.inl.gov/repo/5/). + +Isopod and MOOSE are developed by the Idaho National Laboratory by a team of computer scientists +and engineers and is supported by various funding agencies including the +[United States Department of Energy](http://energy.gov). Development of these codes is ongoing at +INL and by collaborators throughout the world. diff --git a/modules/optimization/doc/moosedocs.py b/modules/optimization/doc/moosedocs.py deleted file mode 100755 index 3cb7f506ae7e..000000000000 --- a/modules/optimization/doc/moosedocs.py +++ /dev/null @@ -1,29 +0,0 @@ -#!/usr/bin/env python -#* This file is part of the MOOSE framework -#* https://www.mooseframework.org -#* -#* All rights reserved, see COPYRIGHT for full restrictions -#* https://github.com/idaholab/moose/blob/master/COPYRIGHT -#* -#* Licensed under LGPL 2.1, please see LICENSE for details -#* https://www.gnu.org/licenses/lgpl-2.1.html - -import sys -import os - -# Locate MOOSE directory -MOOSE_DIR = os.getenv('MOOSE_DIR', os.path.abspath(os.path.join(os.path.dirname(__name__), '..', 'moose'))) -if not os.path.exists(MOOSE_DIR): - MOOSE_DIR = os.path.abspath(os.path.join(os.path.dirname(__name__), '..', '..', 'moose')) -if not os.path.exists(MOOSE_DIR): - raise Exception('Failed to locate MOOSE, specify the MOOSE_DIR environment variable.') -os.environ['MOOSE_DIR'] = MOOSE_DIR - -# Append MOOSE python directory -MOOSE_PYTHON_DIR = os.path.join(MOOSE_DIR, 'python') -if MOOSE_PYTHON_DIR not in sys.path: - sys.path.append(MOOSE_PYTHON_DIR) - -from MooseDocs import main -if __name__ == '__main__': - sys.exit(main.run()) diff --git a/modules/optimization/doc/moosedocs.py b/modules/optimization/doc/moosedocs.py new file mode 120000 index 000000000000..afe861a9da56 --- /dev/null +++ b/modules/optimization/doc/moosedocs.py @@ -0,0 +1 @@ +../../doc/moosedocs.py \ No newline at end of file