Merge pull request #678 from ImperialCollegeLondon/bugfix/add_windows…

…_getting_started

Windows specific getting started instructions

docs/source/conf.py

@@ -101,6 +101,7 @@
     "sphinx_external_toc",
     "sphinx_design",
     "hoverxref.extension",
+    "sphinx_tabs.tabs",
 ]
 autodoc_default_flags = ["members"]
 autosummary_generate = True

docs/source/using_the_ve/getting_started.md

@@ -28,8 +28,11 @@ language_info:
 ## Installing the Virtual Ecosystem model
 
 For most users the best way to get started with the Virtual Ecosystem package is to
-[install Python](https://www.python.org/downloads/) and then install the Virtual
-Ecosystem using the `pip` package installer.
+first [install Python](https://www.python.org/downloads/). To use the Virtual Ecosystem
+you will need Python 3.10, 3.11, or 3.12.
+
+Afer installing Python, open a terminal window and use the following command to install
+the Virtual Ecosystem using the `pip` package installer.
 
 ```sh
 pip install virtual-ecosystem
@@ -41,7 +44,7 @@ that the package is still being developed so these are currently early developme
 
 If you are more interested in playing around with the development of the model, then you
 will need to follow the [overview of the code contribution
-process]../development/contributing/overivew.md), which covers the installation of the
+process](../development/contributing/overview.md), which covers the installation of the
 tools required for code development, testing and building documentation.
 
 ## Running an example Virtual Ecosystem simulation
@@ -52,18 +55,36 @@ first need to install the data to a location of your choice. The command below w
 create the `ve_example` directory at the location you choose and install all of the
 configuration and data files to run a model.
 
-```shell
-ve_run --install-example /path/
+````{tabs}
+```{group-tab} macOS/Linux
+  ```shell
+    ve_run --install-example /path/
 ```
 
+```{group-tab} Windows
+  ```powershell
+    ve_run --install-example C:\path\
+
+````
+
 You can then run the model itself:
 
-```shell
-ve_run /path/ve_example/config \
-    --outpath /path/ve_example/config/out \
+````{tabs}
+```{group-tab} macOS/Linux
+  ```shell
+    ve_run /path/ve_example/config \
+    --outpath /path/ve_example/out \
     --logfile /path/ve_example/out/ve_example.log
 ```
 
+```{group-tab} Windows
+  ```powershell
+    ve_run C:\path\ve_example\config `
+    --outpath C:\path\ve_example\out `
+    --logfile C:\path\ve_example\out\ve_example.log
+```
+````
+
 The [Virtual Ecosystem in use](virtual_ecosystem_in_use.md) page provides a walkthrough
 of this process, showing the typical outputs of the model run process, and also provides
 some simple plots of model inputs and ouputs.

pyproject.toml

@@ -84,6 +84,7 @@ sphinx-rtd-theme = ">=2,<4"
 sphinxcontrib-bibtex = "^2.6.1"
 sphinxcontrib-mermaid = ">=0.9.2,<1.1.0"
 sphinx-hoverxref = "^1.4.1"
+sphinx-tabs = "^3.4.7"
 
 [build-system]
 build-backend = "poetry.core.masonry.api"