Consolidate duplicate docs

rafmudaf · Apr 23, 2024 · f492e8d · f492e8d
1 parent 1a78bb9
commit f492e8d
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 31 deletions.
diff --git a/docs/architecture.md b/docs/architecture.md
@@ -13,10 +13,21 @@ others as dependencies (which modules import which other modules).
 
 ```{mermaid}
 classDiagram
-  wcomp --> floris_interface
-  wcomp --> foxes_interface
-  wcomp --> pywake_interface
-  base_interface --> output_struct
+  class FLORIS
+  class FOXES
+  class PyWake
+  namespace wcomp {
+      class base_interface
+      class floris_interface
+      class foxes_interface
+      class pywake_interface
+      class plotting
+      class output_struct
+  }
+
+  FLORIS --> floris_interface
+  FOXES --> foxes_interface
+  PyWake --> pywake_interface
   floris_interface --> base_interface
   floris_interface --> output_struct
   floris_interface --> plotting

diff --git a/docs/index.md b/docs/index.md
@@ -20,38 +20,30 @@ wind farm wake model simulation and a set of plotting functions to inspect these
 Any wind farm wake modeling software that implements the `wcomp` interface can be included
 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)
-- [PyWake](https://gitlab.windenergy.dtu.dk/TOPFARM/PyWake)
-
-The package diagram below shows the modules within `wcomp` and how each relates to the
-others as dependencies (in other words, which modules import which other modules).
-
-```{mermaid}
-classDiagram
-  wcomp --> floris_interface
-  wcomp --> foxes_interface
-  wcomp --> pywake_interface
-  base_interface --> output_struct
-  floris_interface --> base_interface
-  floris_interface --> output_struct
-  floris_interface --> plotting
-  foxes_interface --> base_interface
-  foxes_interface --> output_struct
-  foxes_interface --> plotting
-  plotting --> output_struct
-  pywake_interface --> base_interface
-  pywake_interface --> output_struct
-  pywake_interface --> plotting
-```
+## Integrated software
+
+::::{grid}
+:gutter: 3
+
+:::{grid-item-card} [FLORIS](https://github.com/NREL/floris)
+Here's the first card.
+:::
+
+:::{grid-item-card} [FOXES](https://github.com/FraunhoferIWES/foxes)
+Here's the second card.
+:::
 
-# Installation
+:::{grid-item-card} [PyWake](https://gitlab.windenergy.dtu.dk/TOPFARM/PyWake)
+Here's the third card.
+:::
+::::
+
+## Installation
 
 Currently, `wcomp` must be installed manually with `pip`. The dependencies are:
 
 - windIO v1.0, can be installed directly from PyPI
-- FLORIS v3.6 (current develop branch), not yet released so must be installed from locally from https://github.com/nrel/floris
+- FLORIS v3.6, can be installed directly from PyPI
 - foxes v0.6.2, can be installed directly from PyPI
 - PyWake v2.5.0 plus three additional commits, must be installed from https://github.com/rafmudaf/PyWake at master branch
 
@@ -71,3 +63,7 @@ git clone https://github.com/rafmudaf/PyWake && pip install -e PyWake/
 ```bash
 pip install -e wcomp
 ```
+
+## Getting started
+
+See {ref}`wesc2023`, {ref}`torque1turbine`, and {ref}`torque4turbine`.
diff --git a/examples/torque2024_1turbine.ipynb b/examples/torque2024_1turbine.ipynb
@@ -4,6 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+    "(torque1turbine)=\n",
     "# Torque 2024 - 1 turbine cases\n",
     "\n",
     "The following analytical wake models are included in FLORIS, FOXES, and PyWake.\n",

diff --git a/examples/torque2024_4turbine.ipynb b/examples/torque2024_4turbine.ipynb
@@ -4,6 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+    "(torque4turbine)=\n",
     "# Torque 2024 - 4 turbine cases\n",
     "\n",
     "These cases place 4 turbines in a line with a spacing of 5 rotor diameters, and the turbine\n",

diff --git a/examples/wesc2023_demo.ipynb b/examples/wesc2023_demo.ipynb
@@ -4,6 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+    "(wesc2023)=\n",
     "# WESC 2023 - Simple Demo"
    ]
   },