015e29efe1
* Transferred pending changes from efischer/develop * 1. Rewrite of "Getting Started": everything you need to set up Spack, even on old/ornery systems. This is not a reference manual section; items covered here are covered more systematically elsewhere in the manual. Some sections were moved here from elsewhere. 2. Beginning to write three methods of application developer support. Two methods were moved from elsewhere. * Edits... * Moved sections in preparation for additional text to be added from old efischer/docs branch. * Moved 2 more sections. * Avoid accid * Applied proofreading edits from @adamjstewart * Fixed non-standard section characters. * Moved section on profiling to the developer's guide. * Still working on Spack workflows... * Finished draft of packaging_guide.rst * Renamed sample projects. * Updates to docstrings * Added documentation to resolve #638 (content taken from #846) * Added section on resolving inconsistent run dependencies. Addresses #645 * Showed how to build Python extensions only compatible with certain versions of Python. * Added examples of getting the right behavior from depends_on(). See #1035 * Added section on Intel compilers and their GCC masquerading feature. Addresses #638, #1687. * Fixed formatting * Added fixes to filesystem views. Added a caveats section to ``spack setup``. * Updated section on Intel compiler configuration because compiler flags currently do not work (see #1687) * Defined trusted downloads, and updated text based on them. (See #1696) * Added workflow to deal with buggy upstream software. See #1683 * Added proper separation between Spack Docs vs. Reference Manual * Renamed spack_workflows to workflows. Resolves a conflict with the .gitignore file. * Removed repeated section. * Created new "Vendor Specific Compiler Configuration" section and organized existing Intel section into it. Added new PGI and NAG sections; but they need to be expanded / rewritten based on the existing text plus research through Spack issues on GitHub. * Fixed text on `spack load --dependencies` to conform to reality. See #1662 * Added patching as option for upstream bugfixes. * Added section on using licensed compilers. * Added section on non-downloadable tarballs. * Wrote sections on NAG and PGI. Arranged compilers in alphabetical order. * Fix indent. * Fixed typos. * Clarified dependency types. * Applied edits from Adam J. Stewart. Spellchecked workflows and getting_started. * Removed spurious header * Fixed Sphinx errors * Fixed erroneous symbol in docstring. * Fix many typos and formatting problems. * Spacing changes * Added section on fixing Git problems. See #1779 * Fixed signature of install() method. * Addressed system packages in greater detail. See #1794 #1795 * Fixed typos * Fixed quotes * Duplicate section on Spack profiling removed from configuration.rst. It had earlier been moved to developer_guide.rst, where it fits better. * Minor edits - Tweak supported platform language. - Various small changes to the new getting started guide. * Fixed bug with quotes.
74 lines
1.9 KiB
ReStructuredText
74 lines
1.9 KiB
ReStructuredText
.. Spack documentation master file, created by
|
|
sphinx-quickstart on Mon Dec 9 15:32:41 2013.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
===================
|
|
Spack Documentation
|
|
===================
|
|
|
|
Spack is a package management tool designed to support multiple
|
|
versions and configurations of software on a wide variety of platforms
|
|
and environments. It was designed for large supercomputing centers,
|
|
where many users and application teams share common installations of
|
|
software on clusters with exotic architectures, using libraries that
|
|
do not have a standard ABI. Spack is non-destructive: installing a
|
|
new version does not break existing installations, so many
|
|
configurations can coexist on the same system.
|
|
|
|
Most importantly, Spack is *simple*. It offers a simple *spec* syntax
|
|
so that users can specify versions and configuration options
|
|
concisely. Spack is also simple for package authors: package files
|
|
are written in pure Python, and specs allow package authors to
|
|
maintain a single file for many different builds of the same package.
|
|
|
|
See the :doc:`features` for examples and highlights.
|
|
|
|
Get spack from the `github repository
|
|
<https://github.com/llnl/spack>`_ and install your first
|
|
package:
|
|
|
|
.. code-block:: console
|
|
|
|
$ git clone https://github.com/llnl/spack.git
|
|
$ cd spack/bin
|
|
$ ./spack install libelf
|
|
|
|
If you're new to spack and want to start using it, see :doc:`getting_started`,
|
|
or refer to the full manual below.
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Tutorials
|
|
|
|
features
|
|
getting_started
|
|
basic_usage
|
|
workflows
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Reference Manual
|
|
|
|
configuration
|
|
mirrors
|
|
package_list
|
|
command_index
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Contributing to Spack
|
|
|
|
packaging_guide
|
|
developer_guide
|
|
API Docs <spack>
|
|
|
|
|
|
==================
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|