summaryrefslogtreecommitdiff
path: root/lib/spack/docs/getting_started.rst
diff options
context:
space:
mode:
authorJohn Parent <john.parent@kitware.com>2022-01-24 14:35:44 -0500
committerPeter Scheibel <scheibel1@llnl.gov>2022-03-17 09:01:01 -0700
commitcf1349ba35a958e776759db7b69f54089d2638c6 (patch)
treea169c786aac015f9388ea31deb8884cdf58eb49e /lib/spack/docs/getting_started.rst
parente4d4a5193ff4ac2a19a7ae77d66df1cd085a979d (diff)
downloadspack-cf1349ba35a958e776759db7b69f54089d2638c6.tar.gz
spack-cf1349ba35a958e776759db7b69f54089d2638c6.tar.bz2
spack-cf1349ba35a958e776759db7b69f54089d2638c6.tar.xz
spack-cf1349ba35a958e776759db7b69f54089d2638c6.zip
"spack commands --update-completion"
Diffstat (limited to 'lib/spack/docs/getting_started.rst')
-rw-r--r--lib/spack/docs/getting_started.rst49
1 files changed, 34 insertions, 15 deletions
diff --git a/lib/spack/docs/getting_started.rst b/lib/spack/docs/getting_started.rst
index 2d44af9a5d..d4121750db 100644
--- a/lib/spack/docs/getting_started.rst
+++ b/lib/spack/docs/getting_started.rst
@@ -1541,14 +1541,15 @@ Required:
Optional:
* Intel Fortran (needed for some packages)
-Note:
-Currently MSVC is the only compiler tested for C/C++ projects. Intel OneAPI provides Fortran support.
+.. note::
+
+ Currently MSVC is the only compiler tested for C/C++ projects. Intel OneAPI provides Fortran support.
"""""""""""""""""""""""
Microsoft Visual Studio
"""""""""""""""""""""""
-Microsoft Visual Studio provides the Windows C/C++ compiler that is currently supported by Spack.
+Microsoft Visual Studio provides the only Windows C/C++ compiler that is currently supported by Spack.
We require several specific components to be included in the Visual Studio installation.
One is the C/C++ toolset, which can be selected as "Desktop development with C++" or "C++ build tools,"
@@ -1578,6 +1579,9 @@ As Spack is a Python-based package, an installation of Python will be needed to
Python 3 can be downloaded and installed from the Windows Store, and will be automatically added
to your ``PATH`` in this case.
+.. note::
+
+ Spack currently supports Python versions later than 3.2 inclusive.
"""
Git
"""
@@ -1590,6 +1594,12 @@ When given the option of adjusting your ``PATH``, choose the ``Git from the
command line and also from 3rd-party software`` option. This will automatically
update your ``PATH`` variable to include the ``git`` command.
+.. note::
+
+ Spack support on Windows is currently dependent on installing the Git for Windows project
+ as the project providing Git support on Windows. This is additionally the recommended method
+ for installing Git on Windows, a link to which can be found above. Spack requires the
+ utilities vendored by this project.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Step 2: Install and setup Spack
@@ -1617,12 +1627,14 @@ with
git checkout -b features/windows-support --track <spack_upstream>/features/windows-support
-Note:
-If you chose to install spack into a directory on Windows that is set up to require Administrative
-Privleges (either by default like `C:\Program Files`, or by administrative settings), or have administrative
-restrictions on a directory spack install files to such as `C:\Users\`, Spack will require elevated privleges
-to run.
+.. note::
+
+ If you chose to install Spack into a directory on Windows that is set up to require Administrative
+ Privleges*, Spack will require elevated privleges to run.
+ *Administrative Privleges can be denoted either by default such as
+ `C:\Program Files`, or aministrator applied administrative restrictions
+ on a directory that spack installs files to such as `C:\Users\`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Step 3: Run and configure Spack
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -1695,6 +1707,11 @@ obtain it by running the Visual Studio Installer and following the instructions
at the start of this section. Also note that .yaml files use spaces for indentation
and not tabs, so ensure that this is the case when editing one directly.
+
+.. note:: Cygwin
+ The use of Cygwin is not officially supported by Spack and is not tested.
+ However Spack will not throw an error, so use if choosing to use Spack
+ with Cygwin, know that no functionality is garunteed.
^^^^^^^^^^^^^^^^^
Step 4: Use Spack
^^^^^^^^^^^^^^^^^
@@ -1717,20 +1734,22 @@ dependencies or incompatible build tools like autoconf. Here are several
packages known to work on Windows:
* abseil-cpp
+* clingo
* cpuinfo
+* cmake
* glm
+* nasm
* netlib-lapack (requires Intel Fortran)
+* ninja
* openssl
-* zlib
* perl
-* ruby
* python
-* cmake
-* ninja
-* nasm
-* clingo
+* ruby
+* wrf
+* zlib
-Note: this is not a comprehensive list
+.. note::
+ This is by no means a comprehensive list
^^^^^^^^^^^^^^
For developers