Skip to content

Commit

Permalink
Fix docs (idaholab#21885)
Browse files Browse the repository at this point in the history
  • Loading branch information
dschwen committed Aug 18, 2022
1 parent 9eb76a6 commit 8c2dbe9
Show file tree
Hide file tree
Showing 17 changed files with 61 additions and 94 deletions.
22 changes: 8 additions & 14 deletions modules/optimization/doc/config.yml
Expand Up @@ -11,36 +11,30 @@ 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
- modules/heat_conduction/include
- 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
52 changes: 1 addition & 51 deletions 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]
51 changes: 51 additions & 0 deletions 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.
29 changes: 0 additions & 29 deletions modules/optimization/doc/moosedocs.py

This file was deleted.

1 change: 1 addition & 0 deletions modules/optimization/doc/moosedocs.py

0 comments on commit 8c2dbe9

Please sign in to comment.