Merge branch 'develop' into jtencer/issue103

Author: John Tencer

.github/workflows/deploy_docs.yaml

@@ -4,7 +4,7 @@ name: deploy-docs
 on:
   push:
     branches:
-      - main
+      - develop
     # Alternative: only build for tags.
     # tags:
     #   - '*'

.github/workflows/docs.yaml

@@ -2,9 +2,11 @@ name: Install and test romtools
 
 on:
   push:
-    branches: [main, develop]
+    branches:
+      - develop
   pull_request:
-    branches: [main, develop]
+    branches:
+      - develop
 
 concurrency:
   group: ${{ github.event.repository.name }}-${{ github.ref }}-${{ github.workflow }}

.github/workflows/install-and-test.yaml

@@ -9,8 +9,9 @@ requires-python = ">=3.8"
 dependencies = [
     'docutils', 'importlib-metadata',
     'numpy', 'scipy', 'matplotlib', 'pdoc',
-    'pytest', 'pytest-mpi>=0.6', 'pytest-timeout'
+    'pytest==7.4.4', 'pytest-mpi>=0.6', 'pytest-timeout'
 ]
+# using pytest>=8.0.0 causes CI failures (likely compatibility issues with pytest-mpi)
 
 [tool.setuptools.dynamic]
 version = {file = "version.txt"}

pyproject.toml

@@ -44,60 +44,34 @@
 #
 
 '''
-# Scope and Motivation
+# Scope, Design and Philosophy
 
 The ROM tools and workflows Python library comprises a set of algorithms for
 constructing and exploiting ROMs.
-
-# Design and Philosophy
-
 The library is designed internally in terms of *abstract base classes* that encapsulate
 all the information needed to run a given algorithm.
 The philosophy is that, for any given application, the user "simply" needs to create
 a class that meets the required API of the abstract base class.
 Once this class is complete, the user gains access to all of our existing algorithms.
 
-# What does this library contain?
+# Content
 
 The Python library, called `romtools`, contains abstract interfaces and functions required for, e.g.,
 
 - Constructing parameter spaces
-- Constructing trial spaces
-- Constructing and exploiting ROMs via outer loop workflows
 
-## Algorithms
-
-- Trial space computation:
+- Constructing trial spaces
   - Reduced-basis methods
   - Proper orthogonal decomposition
     - Algorithms are all compatible with basis scaling, basis splitting for multistate problems, and orthogonalization
       in different inner products
-- Workflows for ROM construction and ROM exploitation:
+
+- Constructing and exploiting ROMs via outer loop workflows
+
   - ROM construction via reduced-basis greedy (RB-Greedy)
   - ROM/FOM exploitation via sampling
   - ROM/FOM exploitation via Dakota-driven sampling
 
-
-## Representative abstract base classes
-
-- `TrialSpace`
-  - This class defines the minimum API requirements for a trial space
-
-  - Constructing a trial space relies on utilities like truncaters, orthogonalizers, etc. Abstract classes, and
-    concrete implementations, exist for:
-
-      - orthogonalizers
-      - scalers
-      - shifters
-      - splitters
-      - truncaters
-
-- `ParameterSpace`
-  - This class defines the minimum API of a parameter space. These parameter spaces are used in workflows for
-    running/building ROMs
-
-- Abstract couplers for greedy sampling, sampling, and coupling to Dakota.
-
 # Demos/HOWTOs
 
 In this section, we present some demos/examples showing how to use `romtools` in practice.
@@ -110,7 +84,7 @@
 ```
 '''
 
-__all__ = ['trial_space', 'trial_space_utils', 'workflows', 'hyper_reduction']
+__all__ = ['trial_space', 'workflows', 'hyper_reduction']
 
 __docformat__ = "restructuredtext" # required to generate the license