From e6858650e61ad40e8fe38a10007e0f89ac32bef9 Mon Sep 17 00:00:00 2001 From: Ben Preston <144227999+ben-l-p@users.noreply.github.com> Date: Mon, 10 Jun 2024 10:00:27 +0100 Subject: [PATCH] Updated docs to address issue with conda install failing --- docs/source/content/installation.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/source/content/installation.md b/docs/source/content/installation.md index 14bd61c4f..3a8341be0 100644 --- a/docs/source/content/installation.md +++ b/docs/source/content/installation.md @@ -1,5 +1,5 @@ # SHARPy v2.3 Installation Guide -__Last revision 10 May 2024__ +__Last revision 10 June 2024__ The following step by step tutorial will guide you through the installation process of SHARPy. This is the updated process valid from v2.3. @@ -113,7 +113,17 @@ These are specified in an Anaconda environment that shall be activated prior to ``` This should take approximately 5 minutes to complete (Tested on Ubuntu 22.04.1). For installation on Apple Silicon, use ```environment_arm64.yml```; this requires GCC and GFortran to be installed prior. -5. Activate the `sharpy` conda environment: + Installation using Conda can be memory intensive, and will give the message ```Collecting package metadata (repodata.json): - Killed``` if all the available RAM is filled. From testing, 16GB of total system RAM is reliable for Conda install, whereas 8GB may have issues. Three solutions are available: + * Increase available RAM (if running on a compute cluster etc) + * Use [Mamba](https://mamba.readthedocs.io/en/latest/), a more efficient drop-in replacement for Conda + * Create a blank conda environment and install the required packages: + ```bash + conda create --name sharpy python=3.10 + conda config –add channels conda-forge + conda install eigen libopenblas libblas libcblas liblapack libgfortran libgcc libgfortran-ng + ``` + +6. Activate the `sharpy` conda environment: ```bash conda activate sharpy ```