Skip to content

Commit

Permalink
Updated docs to address issue with conda install failing
Browse files Browse the repository at this point in the history
  • Loading branch information
ben-l-p authored Jun 10, 2024
1 parent 9b42785 commit e685865
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/source/content/installation.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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
```
Expand Down

0 comments on commit e685865

Please sign in to comment.