Use all caps for FLORIS and FOXES

Also increase the font and line weight sizes in the plots
rafmudaf · Apr 5, 2024 · 1a78bb9 · 1a78bb9
1 parent 4fd4e06
commit 1a78bb9
Show file tree

Hide file tree

Showing 8 changed files with 162 additions and 173 deletions.
diff --git a/README.md b/README.md
@@ -69,7 +69,7 @@ The `windIO` package is used both to define the comparison cases and to load the
 ```mermaid
 graph TD
     L["FLORIS"]
-    M["foxes"]
+    M["FOXES"]
     N["PyWake"]
 
     A["windIO"]

diff --git a/docs/architecture.md b/docs/architecture.md
@@ -45,8 +45,8 @@ API documentation for their respective interface files, for reference.
 
 | Wake Model | Interface File |
 |------------|----------------|
-| [Floris](https://github.com/NREL/floris) | {py:class}`wcomp.floris_interface` |
-| [foxes](https://github.com/FraunhoferIWES/foxes) | {py:class}`wcomp.foxes_interface` |
+| [FLORIS](https://github.com/NREL/floris) | {py:class}`wcomp.floris_interface` |
+| [FOXES](https://github.com/FraunhoferIWES/foxes) | {py:class}`wcomp.foxes_interface` |
 | [PyWake](https://gitlab.windenergy.dtu.dk/TOPFARM/PyWake) | {py:class}`wcomp.pywake_interface` |
 
 <!-- ```{autoclasstree} wcomp.base_interface

diff --git a/docs/index.md b/docs/index.md
@@ -21,8 +21,8 @@ Any wind farm wake modeling software that implements the `wcomp` interface can b
 in the comparison directly.
 
 The wake modeling software currently integrated to `wcomp` are:
-- [Floris](https://github.com/NREL/floris)
-- [foxes](https://github.com/FraunhoferIWES/foxes)
+- [FLORIS](https://github.com/NREL/floris)
+- [FOXES](https://github.com/FraunhoferIWES/foxes)
 - [PyWake](https://gitlab.windenergy.dtu.dk/TOPFARM/PyWake)
 
 The package diagram below shows the modules within `wcomp` and how each relates to the

diff --git a/examples/torque2024_1turbine.ipynb b/examples/torque2024_1turbine.ipynb
diff --git a/examples/torque2024_4turbine.ipynb b/examples/torque2024_4turbine.ipynb
diff --git a/examples/wesc2023_demo.ipynb b/examples/wesc2023_demo.ipynb
diff --git a/wcomp/floris_interface.py b/wcomp/floris_interface.py
@@ -129,12 +129,29 @@ class WCompFloris(WCompBase):
 
     """
     `WCompFloris` implements the wcomp interface to the FLORIS software.
+    The connection points to FLORIS are shown in the diagram below.
+
+    .. mermaid::
+
+        classDiagram
+            class FlorisInterface
+            class WCompFloris {
+                fi : FlorisInterface
+                floris_dict : dict
+                hub_height
+                rotor_diameter
+                yaw_angles : ndarray
+                AEP()
+                _create_floris_dict(windIO_wes_dict: dict)
+            }
+
+            WCompFloris --* FlorisInterface
     """
     LINE_PLOT_COLOR = "green"
     LINE_PLOT_MARKER = ""
     LINE_PLOT_LINESTYLE = "--"
     LINE_PLOT_LINEWIDTH = 2
-    LEGEND = "Floris"
+    LEGEND = "FLORIS"
 
     def __init__(self, input_file: str | Path):
 

diff --git a/wcomp/foxes_interface.py b/wcomp/foxes_interface.py
@@ -93,7 +93,7 @@ class WCompFoxes(WCompBase):
     LINE_PLOT_MARKER = ""
     LINE_PLOT_LINESTYLE = "--"
     LINE_PLOT_LINEWIDTH = 2
-    LEGEND = "foxes"
+    LEGEND = "FOXES"
 
     def __init__(self, input_file: str | Path):
         input_dictionary = load_yaml(input_file)