Skip to content

Commit 59b0da4

Browse files
committed
simplify landing page
1 parent 5f8e5e8 commit 59b0da4

File tree

1 file changed

+6
-32
lines changed

1 file changed

+6
-32
lines changed

romtools/__init__.py

+6-32
Original file line numberDiff line numberDiff line change
@@ -44,60 +44,34 @@
4444
#
4545

4646
'''
47-
# Scope and Motivation
47+
# Scope, Design and Philosophy
4848
4949
The ROM tools and workflows Python library comprises a set of algorithms for
5050
constructing and exploiting ROMs.
51-
52-
# Design and Philosophy
53-
5451
The library is designed internally in terms of *abstract base classes* that encapsulate
5552
all the information needed to run a given algorithm.
5653
The philosophy is that, for any given application, the user "simply" needs to create
5754
a class that meets the required API of the abstract base class.
5855
Once this class is complete, the user gains access to all of our existing algorithms.
5956
60-
# What does this library contain?
57+
# Content
6158
6259
The Python library, called `romtools`, contains abstract interfaces and functions required for, e.g.,
6360
6461
- Constructing parameter spaces
65-
- Constructing trial spaces
66-
- Constructing and exploiting ROMs via outer loop workflows
6762
68-
## Algorithms
69-
70-
- Trial space computation:
63+
- Constructing trial spaces
7164
- Reduced-basis methods
7265
- Proper orthogonal decomposition
7366
- Algorithms are all compatible with basis scaling, basis splitting for multistate problems, and orthogonalization
7467
in different inner products
75-
- Workflows for ROM construction and ROM exploitation:
68+
69+
- Constructing and exploiting ROMs via outer loop workflows
70+
7671
- ROM construction via reduced-basis greedy (RB-Greedy)
7772
- ROM/FOM exploitation via sampling
7873
- ROM/FOM exploitation via Dakota-driven sampling
7974
80-
81-
## Representative abstract base classes
82-
83-
- `TrialSpace`
84-
- This class defines the minimum API requirements for a trial space
85-
86-
- Constructing a trial space relies on utilities like truncaters, orthogonalizers, etc. Abstract classes, and
87-
concrete implementations, exist for:
88-
89-
- orthogonalizers
90-
- scalers
91-
- shifters
92-
- splitters
93-
- truncaters
94-
95-
- `ParameterSpace`
96-
- This class defines the minimum API of a parameter space. These parameter spaces are used in workflows for
97-
running/building ROMs
98-
99-
- Abstract couplers for greedy sampling, sampling, and coupling to Dakota.
100-
10175
# Demos/HOWTOs
10276
10377
In this section, we present some demos/examples showing how to use `romtools` in practice.

0 commit comments

Comments
 (0)