search

NOAA-EMC / hpc-stack

Create a software stack for HPC's
GNU Lesser General Public License v2.1
29 stars 35 forks source link

Documentation updates for MacOS and Linux #507

Closed natalie-perlin closed 1 year ago

natalie-perlin commented 1 year ago

DESCRIPTION OF CHANGES:

  1. Documentation updates for building the hpc-stack on MacOS and Linux, from the latest NOAA-EMC:develop branch. Updated README file with the instructions to build the documentation.
  2. Updated stack/yaml files. Set building a compiler to "NO" as a default. Removed a duplicate that followed earlier naming convention (mac_gnu), and left the version with macos naming convention.

Files changed: ./docs/mac-install.rst ./docs/hpc-install.rst ./docs/hpc-prereqs.rst README

Type of change

CONTRIBUTORS:

README instructions: credit to @gspetro-NOAA

natalie-perlin commented 1 year ago

@AlexanderRichert-NOAA - Updated a description of the changes. As to yaml files the changes were the following: a) Set building a compiler to "NO" as a default. b) Removed a duplicate that followed earlier naming convention (mac_gnu), and left the version with macos naming convention.

AlexanderRichert-NOAA commented 1 year ago

@natalie-perlin Got it, thanks for your patience on this one. Is the idea of setting the compiler build to NO by default to save time, or is there a deeper reason?

natalie-perlin commented 1 year ago

@AlexanderRichert-NOAA - yes, there is a need to turn off the compiler build, as per our documentation, it is installed using Homebrew on MacOS systems, and using "sudo apt install " on Linux.