Skip to content
This repository has been archived by the owner on Jun 29, 2020. It is now read-only.

Latest commit

 

History

History
192 lines (133 loc) · 7.91 KB

README.md

File metadata and controls

192 lines (133 loc) · 7.91 KB
Raw

The Meteoschweiz Spack Deployment

Official Spack documentation below.

Building software on tsa/daint

First git clone the Meteoschweiz spack fork and source the spack file under spack/share/spack in order to use it

$ git clone https://github.com/elsagermann/spack.git
$ cd spack/share/spack
$ . setup-env.sh

Then activate the environment machine (tsa, daint)

$ spack env activate <machine>

You are then able to build any packages available (spack list to print the whole list of available packages)

$ spack install <package>@<version>%<compiler> +<variants>

Ex:

$ spack install cosmo@master%pgi cosmo_target=gpu

This will clone the package, build it and then install the chosen package and all its dependencies under /scratch/$USER/install/tsa (see config.yaml file section for details). The build-stage of your package and its dependencies are not kept (add --keep-stage after the install command in order to keep it). Module files are also created during this process and installed under /scratch/$USER/modules/

Dev-building software on tsa/daint

If you do not want to git clone the source of the package you want to install, especially if you are developing, you can use a local source in order to install your package. In order to do so, first go to the base directory of the package and then use spack dev-build instead of spack install

$ cd <package_base_directory>
$ spack dev-build <package>@<version>%<compiler> +<variants>

The package, its dependencies and its modules will be still installed under /scratch/$USER/install/tsa & /scratch/$USER/modules/

Spack info

Use the spack command

$ spack info <package>

in order to get a list of all possible building configuration available such as: version available, list of dependencies and variants. Variants are a key-feature of spack since it tells it which build configuration we want (i.e COSMO with target gpu or cpu)

Spack edit

Use the spack command

$ spack edit <package>

in order to open the correspondig package.py file and edit it directly

Machine specific config files

Are available under spack/var/spack/environements/<machine>. Their structure is:

  • spack.yaml (spack environment file, describes the set of packages to be installed, and includes the below machine config files)
  • config:
    • -compilers.yaml (all info about available compilers, machine specific compiler flags, module to load (PrgEnv) before compiling)
    • -packages.yaml (all info about the already installed dependencies, i.e their module names or paths)
    • -modules.yaml (all info about the created modules, i.e which env variable or modules should be set once loaded)
    • -config.yaml (specifies the main installation path and the main module installation path, where to find the binaries etc.)

Spack Spack

Build Status Linux Builds codecov Read the Docs Slack

Spack is a multi-platform package manager that builds and installs multiple versions and configurations of software. It works on Linux, macOS, and many supercomputers. Spack is non-destructive: installing a new version of a package does not break existing installations, so many configurations of the same package can coexist.

Spack offers a simple "spec" syntax that allows users to specify versions and configuration options. Package files are written in pure Python, and specs allow package authors to write a single script for many different builds of the same package. With Spack, you can build your software all the ways you want to.

See the Feature Overview for examples and highlights.

To install spack and your first package, make sure you have Python. Then:

$ git clone https://github.com/spack/spack.git
$ cd spack/bin
$ ./spack install zlib

Documentation

Full documentation is available, or run spack help or spack help --all.

Tutorial

We maintain a hands-on tutorial. It covers basic to advanced usage, packaging, developer features, and large HPC deployments. You can do all of the exercises on your own laptop using a Docker container.

Feel free to use these materials to teach users at your organization about Spack.

Community

Spack is an open source project. Questions, discussion, and contributions are welcome. Contributions can be anything from new packages to bugfixes, documentation, or even new core features.

Resources:

Contributing

Contributing to Spack is relatively easy. Just send us a pull request. When you send your request, make develop the destination branch on the Spack repository.

Your PR must pass Spack's unit tests and documentation tests, and must be PEP 8 compliant. We enforce these guidelines with Travis CI. To run these tests locally, and for helpful tips on git, see our Contribution Guide.

Spack uses a rough approximation of the Git Flow branching model. The develop branch contains the latest contributions, and master is always tagged and points to the latest stable release.

Code of Conduct

Please note that Spack has a Code of Conduct. By participating in the Spack community, you agree to abide by its rules.

Authors

Many thanks go to Spack's contributors.

Spack was created by Todd Gamblin, [email protected].

Citing Spack

If you are referencing Spack in a publication, please cite the following paper:

License

Spack is distributed under the terms of both the MIT license and the Apache License (Version 2.0). Users may choose either license, at their option.

All new contributions must be made under both the MIT and Apache-2.0 licenses.

See LICENSE-MIT, LICENSE-APACHE, COPYRIGHT, and NOTICE for details.

SPDX-License-Identifier: (Apache-2.0 OR MIT)

LLNL-CODE-647188