bugfix/openfoam_singularity_issues (#426)

* fix openfoam_singularity issues

* update requirements and descriptions for openfoam examples

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [unreleased]
 ### Fixed
 - A bug where the .orig, .partial, and .expanded file names were using the study name rather than the original file name
+- A bug where the openfoam_wf_singularity example was not being found
 - Some build warnings in the docs (unknown targets, duplicate targets, title underlines too short, etc.)
 
 ### Added
@@ -16,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - The ProvenanceYAMLFileHasRegex condition for integration tests now saves the study name and spec file name as attributes instead of just the study name
   - This lead to minor changes in 3 tests ("local override feature demo", "local pgen feature demo", and "remote feature demo") with what we pass to this specific condition
+- Updated scikit-learn requirement for the openfoam_wf_singularity example
 - Uncommented Latex support in the docs configuration to get pdf builds working
 
 ## [1.10.1]

merlin/examples/generator.py

@@ -83,6 +83,8 @@ def list_examples():
         directory = os.path.join(os.path.join(EXAMPLES_DIR, example_dir), "")
         specs = glob.glob(directory + "*.yaml")
         for spec in specs:
+            if "template" in spec:
+                continue
             with open(spec) as f:  # pylint: disable=C0103
                 try:
                     spec_metadata = yaml.safe_load(f)["description"]

merlin/examples/workflows/openfoam_wf/openfoam_wf.yaml

@@ -3,6 +3,7 @@ description:
     description: |
       A parameter study that includes initializing, running,
       post-processing, collecting, learning and visualizing OpenFOAM runs
+      using docker.
 
 
 env:

merlin/examples/workflows/openfoam_wf/openfoam_wf_template.yaml

@@ -3,6 +3,7 @@ description:
     description: |
       A parameter study that includes initializing, running,
       post-processing, collecting, learning and visualizing OpenFOAM runs
+      using docker.
 
 
 env:

merlin/examples/workflows/openfoam_wf/requirements.txt

@@ -1,3 +1,3 @@
 Ofpp==0.11
-scikit-learn==0.21.3
+scikit-learn>=1.0.2
 matplotlib==3.1.1

merlin/examples/workflows/openfoam_wf_no_docker/openfoam_wf_no_docker.yaml

@@ -3,6 +3,7 @@ description:
     description: |
       A parameter study that includes initializing, running,
       post-processing, collecting, learning and vizualizing OpenFOAM runs
+      without using docker.
 
 
 env:

merlin/examples/workflows/openfoam_wf_no_docker/openfoam_wf_no_docker_template.yaml

@@ -3,6 +3,7 @@ description:
     description: |
       A parameter study that includes initializing, running,
       post-processing, collecting, learning and vizualizing OpenFOAM runs
+      without using docker.
 
 
 env:

merlin/examples/workflows/openfoam_wf_no_docker/requirements.txt

@@ -1,3 +1,3 @@
 Ofpp==0.11
-scikit-learn==0.21.3
+scikit-learn>=1.0.2
 matplotlib==3.1.1

merlin/examples/workflows/openfoam_wf_singularity/openfoam_wf.yaml → merlin/examples/workflows/openfoam_wf_singularity/openfoam_wf_singularity.yaml

@@ -3,6 +3,7 @@ description:
     description: |
       A parameter study that includes initializing, running,
       post-processing, collecting, learning and visualizing OpenFOAM runs
+      using singularity.
 
 
 env:

merlin/examples/workflows/openfoam_wf_singularity/requirements.txt

@@ -1,3 +1,3 @@
 Ofpp==0.11
-scikit-learn==0.21.3
+scikit-learn>=1.0.2
 matplotlib==3.1.1