summaryrefslogtreecommitdiff
path: root/lib/spack/docs/getting_started.rst
AgeCommit message (Collapse)AuthorFilesLines
2024-01-02Update copyright year to 2024 (#41919)Todd Gamblin1-1/+1
It was time to run `spack license update-copyright-year` again.
2023-05-28modules: improve default naming scheme (#37808)Xavier Delaruelle1-1/+1
Change default naming scheme for tcl modules for a more user-friendly experience. Change from flat projection to "per software name" projection. Flat naming scheme restrains module selection capabilities. The `{name}/{version}...` scheme make possible to use user-friendly mechanisms: * implicit defaults (`module load git`) * extended default (`module load git/2`) * advanced version specifiers (`module load git@2:`)
2023-05-03docs: update RHEL/CentOS system prerequisites (#36720)Bryce Torcello1-6/+3
2023-04-18editing: add higher-precedence `SPACK_EDITOR` environment variableTodd Gamblin1-1/+2
Other tools like git support `GIT_EDITOR` which takes higher precedence than the standard `VISUAL` or `EDITOR` variables. This adds similar support for Spack, in the `SPACK_EDITOR` env var. - [x] consolidate editor code from hooks into `spack.util.editor` - [x] add more editor tests - [x] add support for `SPACK_EDITOR` - [x] add a documentation section for controlling the editor and reference it
2023-04-18Revert addition of SPACK_EDITOR pending review.Todd Gamblin1-2/+1
This reverts commit d8a26905ee0fc9e72a05a87bf7ced7e7fc2d4900. This reverts commit 1ee049ccc3d4d4bf1e8dafad0247f3cef01dda58. These were spuriously pushed to `develop`.
2023-04-18editing: add higher-precedence `SPACK_EDITOR` environment variableTodd Gamblin1-1/+2
Other tools like git support `GIT_EDITOR` which takes higher precedence than the standard `VISUAL` or `EDITOR` variables. This adds similar support for Spack, in the `SPACK_EDITOR` env var. - [x] consolidate editor code from hooks into `spack.util.editor` - [x] add more editor tests - [x] add support for `SPACK_EDITOR` - [x] add a documentation section for controlling the editor and reference it
2023-03-19Fix case spelling for Lmod and Tcl (#36215)Xavier Delaruelle1-3/+3
2023-02-20Fix broken links in docs (#35582)Adam J. Stewart1-5/+5
2023-01-20Identify Windows support with tags (#35027)John W. Parent1-21/+8
All packages with explicit Windows support can be found with `spack list --tags=windows`. This also removes the documentation which explicitly lists supported packages on Windows (which is currently out of date and is now unnecessary with the added tags). Note that if a package does not appear in this list, it *may* still build on Windows, but it likely means that no explicit attempt has been made to support it.
2023-01-18license year bump (#34921)Harmen Stoppels1-1/+1
* license bump year * fix black issues of modified files * mypy * fix 2021 -> 2023
2022-11-24docs: update info on XCode requirements (#34097)Valentin Volkl1-2/+3
2022-11-17Hdf5 package: build on Windows (#31141)Jared Popelar1-0/+2
* Enable hdf5 build (including +mpi) on Windows * This includes updates to hdf5 dependencies openssl (minor edit) and bzip2 (more-extensive edits) * Add binary-based installation of msmpi (this is currently the only supported MPI implementation in Spack for Windows). Note that this does not install to the Spack-specified prefix. This implementation will be replaced with a source-based implementation Co-authored-by: John Parent <john.parent@kitware.com>
2022-11-07Doc: `lsb-release` (#32479)Axel Huebl1-1/+1
Without the `lsb-release` tool installed, Spack cannot identify the Ubuntu/Debian version.
2022-11-03Update metadata for bootstrapping (#33665)Massimiliano Culpo1-44/+17
2022-10-29Deprecate spack bootstrap trust/untrust (#33600)Massimiliano Culpo1-25/+3
* Deprecate spack bootstrap trust/untrust * Update CI * Update tests
2022-10-12Fix typo in docs (#33182)Massimiliano Culpo1-1/+1
2022-10-10Docs: Getting Started Dependencies (#32480)Axel Huebl1-2/+30
* 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
2022-04-13Add support for Python 3.10 (#29581)Massimiliano Culpo1-6/+7
* Add support for Python 3.10 * Update unit-tests to use 3.10 * Update Getting started section of the docs * Update bootstrap action
2022-03-17Remove references to `features/windows-support` branch (#29565)Zack Galbreath1-1/+1
2022-03-17Windows Support: Testing Suite integrationJohn Parent1-25/+15
Broaden support for execution of the test suite on Windows. General bug and review fixups
2022-03-17"spack commands --update-completion"John Parent1-15/+34
2022-03-17Expand external find for Windows (#27588)John Parent1-35/+56
* Incorporate new search location * Add external user option * proper doc string * Explicit commands in getting started * raise during chgrp on Win recover installer changes Notate admin privleges Windows phase install hooks Find external python and install ninja (#23496) Allow external find python to find windows python and spack install ninja Co-authored-by: Adam J. Stewart <ajstewart426@gmail.com> Co-authored-by: Betsy McPhail <betsy.mcphail@kitware.com>
2022-03-17Spack on Windows package portsJohn Parent1-8/+0
CMake - Windows Bootstrap (#25825) Remove hardcoded cmake compiler (#26410) Revert breaking cmake changes Ensure no autotools on Windows Perl on Windows (#26612) Python source build windows (#26313) Reconfigure sysconf for Windows Python2.6 compatibility Fxixup new sbang tests for windows Ruby support (#28287) Add NASM support (#28319) Add mock Ninja package for testing
2022-03-17Relocate spack_cmd and scripts from installer to root bin (#24651)John W. Parent1-28/+10
Relocate spack_cmd and scripts from installer to root bin Refactor documentation, installer, and launcher to facilitate that change
2022-03-17Packaging of netlib-lapack for windows (#24993)Jared Popelar1-66/+79
MSVC's internal CMake and Ninja now detected by spack external find and added to packages.yaml Saving progress on packaging zlib for Windows Fixing the shared CMake flag * Loading Intel's ifx Fortran compiler into MSVC; if there are multiple versions of MSVC installed and detected, ifx will only be placed into the first block written in compilers.yaml. The version number of ifx can be detected using MSVC's version flag (instead of /QV) by using ignore_version_errors. This commit also provides support for detection of Intel compilers in their own compiler block by adding ifx.exe to the fc/f77_name blocks inside intel.py * Giving CMake a Fortran compiler argument * Adding patch file for removing duplicated mangling header for versions 3.9.1 and older; static and shared now successfully building on Windows * Have netlib-lapack depend on ninja@1.10 Co-authored-by: John R. Cary <cary@txcorp.com> Co-authored-by: Jared Popelar <jpopelar@txcorp.com> Making a default config.yaml for Windows Small path length for build_stage Provide more prerequisite details, mention default config.yaml Killing an unnecessary setvars call Replacing some lost changes, proofreading, updating windows-supported package list Co-authored-by: John Parent <john.parent@kitware.com>
2022-03-17Windows: Create installer and environmentlou.lawrence@kitware.com1-0/+218
* Add 'make-installer' command for Windows * Add '--bat' arg to env activate, env deactivate and unload commands * An equivalent script to setup-env on linux: spack_cmd.bat. This script has a wrapper to evaluate cd, load/unload, env activate/deactivate.(#21734) * Add spacktivate and config editor (#22049) * spack_cmd: will find python and spack on its own. It preferentially tries to use python on your PATH (#22414) * Ignore Windows python installer if found (#23134) * Bundle git in windows installer (#23597) * Add Windows section to Getting Started document (#23131), (#23295), (#24240) Co-authored-by: Stephen Crowell <stephen.crowell@kitware.com> Co-authored-by: lou.lawrence@kitware.com <lou.lawrence@kitware.com> Co-authored-by: Betsy McPhail <betsy.mcphail@kitware.com> Co-authored-by: Jared Popelar <jpopelar@txcorp.com> Co-authored-by: Ben Cowan <benc@txcorp.com> Update Installer CI Co-authored-by: John Parent <john.parent@kitware.com>
2022-01-14Update copyright year to 2022Todd Gamblin1-1/+1
2022-01-12Do not initialize config on spack compiler list (#28042)Harmen Stoppels1-7/+9
When `spack compiler list` is run without being restricted to a particular scope, and no compilers are found, say that none are available, and hint that the use should run spack compiler find to auto detect compilers. * Improve docs * Check if stdin is a tty * add a test
2021-10-05Isolate bootstrap configuration from user configuration (#26071)Massimiliano Culpo1-11/+0
* Isolate bootstrap configuration from user configuration * Search for build dependencies automatically if bootstrapping from sources The bootstrapping logic will search for build dependencies automatically if bootstrapping anything form sources. Any external spec, if found, is written in a scope that is specific to bootstrapping. * Don't clean the bootstrap store with "spack clean -a" * Copy bootstrap.yaml and config.yaml in the bootstrap area
2021-09-16Recommend Git's manyFiles feature (#25977)Michael Kuhn1-1/+1
Git 2.24 introduced a feature flag for repositories with many files, see: https://github.blog/2019-11-03-highlights-from-git-2-24/#feature-macros Since Spack's Git repository contains roughly 8,500 files, it can be worthwhile to enable this, especially on slow file systems such as NFS: ``` $ hyperfine --warmup 3 'cd spack-default; git status' 'cd spack-manyfiles; git status' Benchmark #1: cd spack-default; git status Time (mean ± σ): 3.388 s ± 0.095 s [User: 256.2 ms, System: 625.8 ms] Range (min … max): 3.168 s … 3.535 s 10 runs Benchmark #2: cd spack-manyfiles; git status Time (mean ± σ): 168.7 ms ± 10.9 ms [User: 98.6 ms, System: 126.1 ms] Range (min … max): 144.8 ms … 188.0 ms 19 runs Summary 'cd spack-manyfiles; git status' ran 20.09 ± 1.42 times faster than 'cd spack-default; git status' ```
2021-09-16Improve bootstrapping docs a hair (#25962)Harmen Stoppels1-50/+50
2021-09-10[docs] document official gfortran macOS precompiled binaries (#25818)Stephen McDowell1-3/+5
* document official gfortran macOS precompiled binaries * compile without -vvv ;) {squash this}
2021-08-30Add documentation on compiler `environment` (#25508)kwryankrattiger1-0/+28
2021-08-18Bootstrap clingo from binaries (#22720)Massimiliano Culpo1-47/+139
* Bootstrap clingo from binaries * Move information on clingo binaries to a JSON file * Add support to bootstrap on Cray Bootstrapping on Cray requires, at the moment, to swap the platform when looking for binaries - due to #22800. * Add SHA256 verification for bootstrapped software Use sha256 verification for binaries necessary to bootstrap the concretizer and gpg for signature verification * patchelf: use Spec._old_concretize() to bootstrap As noted in #24450 we may happen to need the concretizer when bootstrapping clingo. In that case only the old concretizer is available. * Add a schema for bootstrapping methods Two fields have been added to bootstrap.yaml: "sources" which lists the methods available for bootstrapping software "trusted" which records if a source is trusted or not A subcommand has been added to "spack bootstrap" to list the sources currently available. * Methods used for bootstrapping are configurable from bootstrap:sources The function that tries to ensure a given Python module is importable now tries bootstrapping methods in the same order as they are defined in `bootstrap.yaml` * Permit to trust/untrust bootstrapping methods * Add binary tests for MacOS, Ubuntu * Add documentation * Add a note on bash
2021-08-13Mention bash in prerequisites (#25379)Harmen Stoppels1-1/+2
Isn't installed on Alpine.
2021-07-11docs: fix reference to count of system packages (#24821)Matthew Fernandez1-1/+1
015e29efe105ddd039e8b395e12cf78a3787ebb3 that introduced this section to the documentation said “two” here instead of the actual count, three. 9f54cea5c500bb19d2301149460c741e96be1f8b then added a fourth, BLAS/LAPACK. Rather than trying to keep this leading count in sync, this change just replaces the wording with something more generic/stable.
2021-06-11setup-env: allow users to skip module function setup (#24236)Adam J. Stewart1-3/+9
* setup-env: allow users to skip module function setup * Add documentation on SPACK_SKIP_MODULES
2021-05-28adding support for export of private gpg key (#22557)Vanessasaurus1-1/+75
This PR allows users to `--export`, `--export-secret`, or both to export GPG keys from Spack. The docs are updated that include a warning that this usually does not need to be done. This addresses an issue brought up in slack, and also represented in #14721. Signed-off-by: vsoch <vsoch@users.noreply.github.com> Co-authored-by: vsoch <vsoch@users.noreply.github.com>
2021-04-02Document unzip (#22723)Harmen Stoppels1-1/+1
2021-03-03Bootstrap clingo from sources (#21446)Massimiliano Culpo1-0/+47
* Allow the bootstrapping of clingo from sources Allow python builds with system python as external for MacOS * Ensure consistent configuration when bootstrapping clingo This commit uses context managers to ensure we can bootstrap clingo using a consistent configuration regardless of the use case being managed. * Github actions: test clingo with bootstrapping from sources * Add command to inspect and clean the bootstrap store Prevent users to set the install tree root to the bootstrap store * clingo: documented how to bootstrap from sources Co-authored-by: Gregory Becker <becker33@llnl.gov>
2021-02-12Introduce a SPACK_PYTHON environment variable (#21222)Chuck Atkins1-0/+8
The SPACK_PYTHON environment variable can be set to a python interpreter to be used by the spack command. This allows the spack command itself to use a consistent and separate interpreter from whatever python might be used for package building.
2021-01-02copyrights: update all files with license headers for 2021Todd Gamblin1-1/+1
- [x] add `concretize.lp`, `spack.yaml`, etc. to licensed files - [x] update all licensed files to say 2013-2021 using `spack license update-copyright-year` - [x] appease mypy with some additions to package.py that needed for oneapi.py
2020-11-09[docs] getting_started.rst: fix typo (#19815)Emir İşman1-1/+1
2020-10-23docs: update docs on shell support and using packages (#19486)Todd Gamblin1-50/+30
Shell integration no longer requires setting `SPACK_ROOT`, so we can simplify the documentation on it. The docs on shell support and using packages are getting a bit old, and information on `spack load` (which seems to be everyone's most common way of using packages) is hard to find. This PR simplifies the shell documentation to remove SPACK_ROOT, and also moves some sections around for clearer organization. - [x] make docs on sourcing setup scripts clearer and simpler - [x] introduce `spack load` early in the basic usage guide instead of burying it in the module docs - [x] clean up module docs so that spack module tcl loads comes later - [x] be clear about the different ways to use packages so that the users can find the docs better. Co-authored-by: Massimiliano Culpo <massimiliano.culpo@gmail.com>
2020-10-11Add testing for Python 3.9 (#19261)Adam J. Stewart1-5/+5
2020-08-27docs: fix bugs in contribution, getting started guides (#18216)Richarda Butler1-4/+19
Co-authored-by: Greg Becker <becker33@llnl.gov> Co-authored-by: Adam J. Stewart <ajstewart426@gmail.com>
2020-08-20docs: List tar and some compressors in prerequisites (#18169)Michael Kuhn1-0/+3
Fixes #18152
2020-08-10Update packages.yaml format and support configuration updatesMassimiliano Culpo1-19/+38
The YAML config for paths and modules of external packages has changed: the new format allows a single spec to load multiple modules. Spack will automatically convert from the old format when reading the configs (the updates do not add new essential properties, so this change in Spack is backwards-compatible). With this update, Spack cannot modify existing configs/environments without updating them (e.g. “spack config add” will fail if the configuration is in a format that predates this PR). The user is prompted to do this explicitly and commands are provided. All config scopes can be updated at once. Each environment must be updated one at a time.
2020-08-03Fix docs about containers on cray (#17431)Harmen Stoppels1-1/+1
* For detecting Cray: CRAYPE_VERSION is not used, but MODULEPATH * Fix typo and write Cray with a capital
2020-07-23Revert "Add libglvnd packages/Add EGL support (#14572)" (#17682)Chuck Atkins1-94/+0
This reverts commit 573489db710c6fd315170a45d6c609db2e30e5e4.