From 140cff1d58eea54a9873c8582a3804e21693985f Mon Sep 17 00:00:00 2001 From: Ewout ter Hoeven Date: Sun, 9 Feb 2025 09:57:18 +0100 Subject: [PATCH 1/2] docs: Clarify recommended dependencies in installation guide Add explanation of what the [rec] optional dependencies provide, including visualization (SolaraViz), Matplotlib plotting, and network modeling capabilities. This helps users understand when they need to install these additional packages. --- docs/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 69db76e57fa..64193bab42d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -43,10 +43,11 @@ To also install our recommended dependencies: pip install -U mesa[rec] ``` +The `[rec]` option installs additional recommended dependencies needed for visualization (SolaraViz), Matplotlib plotting, and network modeling capabilities. + On a Mac, this command might cause an error stating `zsh: no matches found: mesa[all]`. In that case, change the command to `pip install -U "mesa[rec]"`. - ### Resources For help getting started with Mesa, check out these resources: From 55767e943e9979d4f77978a8660baea43b08da59 Mon Sep 17 00:00:00 2001 From: Ewout ter Hoeven Date: Sun, 9 Feb 2025 16:10:39 +0100 Subject: [PATCH 2/2] index: remove specific libraries --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 64193bab42d..1874c184143 100644 --- a/docs/index.md +++ b/docs/index.md @@ -43,7 +43,7 @@ To also install our recommended dependencies: pip install -U mesa[rec] ``` -The `[rec]` option installs additional recommended dependencies needed for visualization (SolaraViz), Matplotlib plotting, and network modeling capabilities. +The `[rec]` option installs additional recommended dependencies needed for visualization, plotting, and network modeling capabilities. On a Mac, this command might cause an error stating `zsh: no matches found: mesa[all]`. In that case, change the command to `pip install -U "mesa[rec]"`.