Skip to content

Commit

Permalink
remove PIConGPU install description using spack
Browse files Browse the repository at this point in the history
Our spack recipe is not maintained and no PIConGPU developer/maintainer is using spack to use PIConGPU. To avoid users getting frustrated by the broken spack recipe the documentation is currently removed until we support and test the spack workflow.
The documentation of how the dependencies of PIConGPU can be installed with spack is still available.

Latest PIConGPU version with documentation referencing the spack
workflow: 5d241da
  • Loading branch information
psychocoderHPC committed Dec 1, 2022
1 parent 5d241da commit d8104a6
Show file tree
Hide file tree
Showing 5 changed files with 2 additions and 93 deletions.
2 changes: 1 addition & 1 deletion INSTALL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Compiler
- if the installed version of **gcc** is too new, `compile an older gcc <https://gist.github.com/slizzered/a9dc4e13cb1c7fffec53>`_
- *Spack:*

- ``spack install gcc@8.5.0``
- ``spack install gcc@11.3.0``
- make it the default in your `packages.yaml <http://spack.readthedocs.io/en/latest/getting_started.html#compiler-configuration>`_ or *suffix* `all following <http://spack.readthedocs.io/en/latest/features.html#simple-package-installation>`_ ``spack install`` commands with a *space* and ``%[email protected]``

CMake
Expand Down
2 changes: 1 addition & 1 deletion USAGE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

.. seealso::

You need to have an :ref:`environment loaded <install-profile>` (``source $HOME/picongpu.profile`` when installing from source or ``spack load picongpu`` when using spack) that provides all :ref:`PIConGPU dependencies <install-dependencies>` to complete this chapter.
You need to have an :ref:`environment loaded <install-profile>` (``source $HOME/picongpu.profile`` when installing from source) that provides all :ref:`PIConGPU dependencies <install-dependencies>` to complete this chapter.

.. warning::

Expand Down
1 change: 0 additions & 1 deletion docs/source/install/instructions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ As explained in the previous section, select and **follow exactly one** of the f
.. toctree::
:maxdepth: 1

instructions/spack
instructions/docker
instructions/source

Expand Down
76 changes: 0 additions & 76 deletions docs/source/install/instructions/spack.rst

This file was deleted.

14 changes: 0 additions & 14 deletions docs/source/install/path.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,6 @@ It loads according modules and sets :ref:`helper environment variables <install-
For many HPC systems we have already prepared and maintain an environment which will run out of the box.
See if your system is :ref:`in the list <install-profile>` so you can skip the installation completely!

Spack
^^^^^

[Spack]_ is a flexible package manager that can build and organize software dependencies.
It can be configured once for your hardware architecture to create optimally tuned binaries and provides modulefile support (e.g. [modules]_, [Lmod]_).
Those auto-build modules manage your environment variables and allow easy switching between versions, configurations and compilers.

Build from Source
^^^^^^^^^^^^^^^^^

Expand All @@ -61,13 +54,6 @@ We are also working on `Singularity <http://singularity.lbl.gov/>`_ images.
References
----------

.. [Spack]
T. Gamblin and contributors.
*A flexible package manager that supports multiple versions, configurations, platforms, and compilers*,
SC '15 Proceedings of the International Conference for High Performance Computing, Networking, Storage and Analysis (2015),
`DOI:10.1145/2807591.2807623 <https://dx.doi.org/10.1145/2807591.2807623>`_,
https://github.com/spack/spack
.. [modules]
J.L. Furlani, P.W. Osel.
*Abstract Yourself With Modules*,
Expand Down

0 comments on commit d8104a6

Please sign in to comment.