Docs: Getting Started Dependencies (#32480)

* Docs: Getting Started Dependencies

Finally document what one needs to install to use Spack on
Linux and Mac :-)

With <3 for minimal container users and my colleagues with
their fancy Macs.

* Debian Update Packages: GCC, Python

- build-essential: includes gcc, g++ (thx Cory)
- Python: add python3-venv, python3-distutils (thx Pradyun)

* Add RHEL8 Dependencies
This commit is contained in:
Axel Huebl 2022-10-10 16:25:37 -07:00 committed by GitHub
parent a05a34361a
commit 9d89dba292
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 33 additions and 2 deletions

View file

@ -127,6 +127,7 @@ def setup(sphinx):
"sphinx.ext.napoleon", "sphinx.ext.napoleon",
"sphinx.ext.todo", "sphinx.ext.todo",
"sphinx.ext.viewcode", "sphinx.ext.viewcode",
"sphinx_design",
"sphinxcontrib.programoutput", "sphinxcontrib.programoutput",
] ]

View file

@ -23,8 +23,36 @@ be present on the machine where Spack is run:
These requirements can be easily installed on most modern Linux systems; These requirements can be easily installed on most modern Linux systems;
on macOS, XCode is required. Spack is designed to run on HPC on macOS, XCode is required. Spack is designed to run on HPC
platforms like Cray. Not all packages should be expected platforms like Cray. Not all packages should be expected
to work on all platforms. A build matrix showing which packages are to work on all platforms.
working on which systems is planned but not yet available.
A build matrix showing which packages are working on which systems is shown below.
.. tab-set::
.. tab-item:: Debian/Ubuntu
.. code-block:: console
apt update
apt install build-essential ca-certificates coreutils curl environment-modules gfortran git gpg lsb-release python3 python3-distutils python3-venv unzip zip
.. tab-item:: RHEL
.. note::
yum update -y
yum install -y epel-release
yum update -y
yum --enablerepo epel groupinstall -y "Development Tools"
yum --enablerepo epel install -y curl findutils gcc-c++ gcc gcc-gfortran git gnupg2 hostname iproute make patch python3 python3-pip python3-setuptools unzip
python3 -m pip install boto3
.. tab-item:: macOS Brew
.. code-block:: console
brew update
brew install curl gcc git gnupg zip
------------ ------------
Installation Installation

View file

@ -3,6 +3,7 @@
sphinx>=3.4,!=4.1.2,!=5.1.0 sphinx>=3.4,!=4.1.2,!=5.1.0
sphinxcontrib-programoutput sphinxcontrib-programoutput
sphinx-design
sphinx-rtd-theme sphinx-rtd-theme
python-levenshtein python-levenshtein
# Restrict to docutils <0.17 to workaround a list rendering issue in sphinx. # Restrict to docutils <0.17 to workaround a list rendering issue in sphinx.

View file

@ -18,6 +18,7 @@ spack:
- "py-sphinx@3.4:4.1.1,4.1.3:" - "py-sphinx@3.4:4.1.1,4.1.3:"
- py-sphinxcontrib-programoutput - py-sphinxcontrib-programoutput
- py-docutils@:0.16 - py-docutils@:0.16
- py-sphinx-design
- py-sphinx-rtd-theme - py-sphinx-rtd-theme
# VCS # VCS
- git - git