Merge pull request #254 from ImperialCollegeLondon/dev_arm64

Added environment for Apple Silicon (ARM64)

.github/workflows/sharpy_tests.yaml

@@ -51,7 +51,7 @@ jobs:
           hash -r
           export QT_QPA_PLATFORM='offscreen'
           sudo apt install libeigen3-dev
-          conda env create -f utils/environment_new.yml
+          conda env create -f utils/environment.yml
           conda init bash
           source activate sharpy
           git submodule init

Dockerfile

@@ -31,7 +31,8 @@ RUN conda init bash && \
     conda config --set always_yes yes --set changeps1 no && \
     conda update -q conda && \
     conda config --set auto_activate_base false && \
-    conda env create -f /sharpy_dir/utils/environment_new.yml && conda clean -afy && \
+    conda env create -f /sharpy_dir/utils/environment.yml && conda clean -afy && \
+
     find /miniconda3/ -follow -type f -name '*.a' -delete && \
     find /miniconda3/ -follow -type f -name '*.pyc' -delete && \
     find /miniconda3/ -follow -type f -name '*.js.map' -delete

docs/source/content/contributing.md

@@ -11,7 +11,7 @@ If you are submitting a bug report:
 same branch.
 
 2. Double check that your python distribution is updated by comparing with 
-the `utils/environment_*.yml` file.
+the `utils/environment.yml` file.
 
 3. Try to assemble a minimal working example that can be run quickly and easily.
 

docs/source/content/installation.md

@@ -1,5 +1,5 @@
 # SHARPy v2.0 Installation Guide
-__Last revision 27 June 2023__
+__Last revision 9 October 2023__
 
 The following step by step tutorial will guide you through the installation process of SHARPy. This is the updated process valid from v2.0.
 
@@ -11,7 +11,8 @@ SHARPy is being developed and tested on the following operating systems:
 * CentOS 7 and CentOS 8
 * Ubuntu 18.04 LTS
 * Debian 10
-* MacOS Mojave and Catalina
+* MacOS Mojave and Catalina (Intel)
+* MacOS Sonoma (Apple Silicon M2)
 
 Windows users can also run it by first installing the Windows Subsystem for Linux (https://learn.microsoft.com/en-us/windows/wsl/install) and a XServer such as GWSL, which can be installed through the Microsoft Store. SHARPy is also available to the vast majority of operating systems that are supported by Docker
 
@@ -71,16 +72,13 @@ or running any SHARPy cases.
     conda install python=3.10
     ```
 
-4. Create the conda environment that SHARPy will use. Change `environment_new.yml` to read `environment_macos.yml`
-   if you are installing SHARPy on Mac OS X.
+4. Create the conda environment that SHARPy will use:
     ```bash
     cd sharpy/utils
-    conda env create -f environment_new.yml
+    conda env create -f environment.yml
     cd ../..
     ```
-    This should take approximately 15 minutes to complete (Tested on Ubuntu 22.04.1). We also provide a 
-    lightweight environment with the minimum required dependencies. If you'd like to use it, create the 
-    conda environment using `environment_minimal.yml`.
+    This should take approximately 15 minutes to complete (Tested on Ubuntu 22.04.1). 
 
 5. Activate the `sharpy` conda environment:
     ```bash
@@ -155,11 +153,10 @@ to your taste.
     ```
     This command will check out the `develop` branch and set it to track the remote origin. It will also set the submodules (xbeam and UVLM) to the right commit.
 
-2. Create the conda environment that SHARPy will use. Change `environment_new.yml` to read `environment_macos.yml`
-   if you are installing SHARPy on Mac OS X.
+2. Create the conda environment that SHARPy will use:
     ```bash
     cd sharpy/utils
-    conda env create -f environment_new.yml
+    conda env create -f environment.yml
     cd ../..
     ```
 

utils/environment_new.yml → utils/environment.yml

@@ -23,4 +23,4 @@ dependencies:
   - xlrd>=1.2.0            
   - python=3.10
   - openpyxl>=3.0.10
-  - cmake=3.14.0
+  - cmake>=3.19.0