From 7d97e8b0679d50f272c2a131482c352aa63adcf7 Mon Sep 17 00:00:00 2001 From: Peter Scheibel Date: Tue, 6 Nov 2018 19:57:32 -0800 Subject: New repo for advanced packaging tutorial (#9711) * modified tutorial packages * update hint in hdf5 tutorial file (typo for suggested argument) * add repo.yaml to tutorial repository * update tutorial docs to refer user to tutorial package repository * flake edits * recommend site scope vs. defaults * you don't specify the repo's name when adding a repo, just the path --- lib/spack/docs/tutorial_advanced_packaging.rst | 46 ++++++-------------------- 1 file changed, 11 insertions(+), 35 deletions(-) (limited to 'lib') diff --git a/lib/spack/docs/tutorial_advanced_packaging.rst b/lib/spack/docs/tutorial_advanced_packaging.rst index f72f483fcb..9b41980a69 100644 --- a/lib/spack/docs/tutorial_advanced_packaging.rst +++ b/lib/spack/docs/tutorial_advanced_packaging.rst @@ -25,46 +25,22 @@ dependents in your package. Setup for the tutorial ---------------------- -The simplest way to follow along with this tutorial is to use our Docker image, -which comes with Spack and various packages pre-installed: +.. note:: -.. code-block:: console - - $ docker pull alalazo/spack:advanced_packaging_tutorial - $ docker run --rm -h advanced-packaging-tutorial -it alalazo/spack:advanced_packaging_tutorial - root@advanced-packaging-tutorial:/# - root@advanced-packaging-tutorial:/# spack find - ==> 20 installed packages. - -- linux-ubuntu16.04-x86_64 / gcc@5.4.0 ------------------------- - arpack-ng@3.5.0 hdf5@1.10.1 libpciaccess@0.13.5 libtool@2.4.6 m4@1.4.18 ncurses@6.0 openblas@0.2.20 openssl@1.0.2k superlu@5.2.1 xz@5.2.3 - cmake@3.9.4 hwloc@1.11.8 libsigsegv@2.11 libxml2@2.9.4 mpich@3.2 netlib-lapack@3.6.1 openmpi@3.0.0 pkg-config@0.29.2 util-macros@1.19.1 zlib@1.2.11 + If you are not using the tutorial docker image, it is recommended that you + do this section of the tutorial in a fresh clone of Spack -If you already started the image, you can set the ``EDITOR`` environment -variable to your preferred editor (``vi``, ``emacs``, and ``nano`` are included in the image) -and move directly to :ref:`adv_pkg_tutorial_start`. - -If you choose not to use the Docker image, you can clone the Spack repository -and build the necessary bits yourself: +The tutorial uses custom package definitions with missing sections that +will be filled in during the tutorial. These package definitions are stored +in a separate package repository, which can be enabled with: .. code-block:: console - $ git clone https://github.com/spack/spack.git - Cloning into 'spack'... - remote: Counting objects: 92731, done. - remote: Compressing objects: 100% (1108/1108), done. - remote: Total 92731 (delta 1964), reused 4186 (delta 1637), pack-reused 87932 - Receiving objects: 100% (92731/92731), 33.31 MiB | 64.00 KiB/s, done. - Resolving deltas: 100% (43557/43557), done. - Checking connectivity... done. - - $ cd spack - $ git checkout tutorials/advanced_packaging - Branch tutorials/advanced_packaging set up to track remote branch tutorials/advanced_packaging from origin. - Switched to a new branch 'tutorials/advanced_packaging' - -At this point you can install the software that will be used -during the rest of the tutorial (the output of the commands is omitted -for the sake of brevity): + $ spack repo add --scope=site var/spack/repos/tutorial + +If you are using the tutorial docker image, all dependency packages +will have been installed. Otherwise, to install these packages you can use +the following commands: .. code-block:: console -- cgit v1.2.3-60-g2f50