spack/etc/spack/defaults/modules.yaml

# -------------------------------------------------------------------------
# This is the default configuration for Spack's module file generation.
#
# Settings here are versioned with Spack and are intended to provide
# sensible defaults out of the box. Spack maintainers should edit this
# file to keep it current.
#
# Users can override these settings by editing the following files.
#
# Per-spack-instance settings (overrides defaults):
#   $SPACK_ROOT/etc/spack/modules.yaml
#
# Per-user settings (overrides default and site settings):
#   ~/.spack/modules.yaml
# -------------------------------------------------------------------------
modules:
  enable:
    - tcl
  prefix_inspections:
    bin:
      - PATH
    man:
      - MANPATH
    share/man:
      - MANPATH
    share/aclocal:
      - ACLOCAL_PATH
    lib:
      - LIBRARY_PATH
    lib64:
      - LIBRARY_PATH
    include:
      - CPATH
    lib/pkgconfig:
      - PKG_CONFIG_PATH
    lib64/pkgconfig:
      - PKG_CONFIG_PATH
    share/pkgconfig:
      - PKG_CONFIG_PATH
    '':
      - CMAKE_PREFIX_PATH

  lmod:
    hierarchy:
      - mpi
module files configuration : added default configuration 2016-03-24 09:04:02 +00:00			`# -------------------------------------------------------------------------`
Add "default" configuration scope. - Default scope is versioned with spack and can be overridden by site or user config. - Default scope provides sensible default concretization preferences for all of Spack. - per-platform concretization scope can be added later (to force a particular MPI on, e.g., Cray systems) 2016-07-20 00:10:17 +00:00			`# This is the default configuration for Spack's module file generation.`
module files configuration : added default configuration 2016-03-24 09:04:02 +00:00			`#`
Add "default" configuration scope. - Default scope is versioned with spack and can be overridden by site or user config. - Default scope provides sensible default concretization preferences for all of Spack. - per-platform concretization scope can be added later (to force a particular MPI on, e.g., Cray systems) 2016-07-20 00:10:17 +00:00			`# Settings here are versioned with Spack and are intended to provide`
			`# sensible defaults out of the box. Spack maintainers should edit this`
			`# file to keep it current.`
			`#`
			`# Users can override these settings by editing the following files.`
			`#`
			`# Per-spack-instance settings (overrides defaults):`
			`# $SPACK_ROOT/etc/spack/modules.yaml`
			`#`
			`# Per-user settings (overrides default and site settings):`
			`# ~/.spack/modules.yaml`
module files configuration : added default configuration 2016-03-24 09:04:02 +00:00			`# -------------------------------------------------------------------------`
			`modules:`
Simplify /etc/spack/modules.yaml formatting. 2016-05-11 16:05:24 +00:00			`enable:`
			`- tcl`
			`prefix_inspections:`
			`bin:`
			`- PATH`
			`man:`
			`- MANPATH`
Add share/man to prefix inspections. The share/man path should be in prefix_inspections for MANPATH as share/man is a common location for manual pages. 2016-07-11 18:35:22 +00:00			`share/man:`
			`- MANPATH`
add ACLOCAL_PATH updates for packages that register m4 macros (#2518) 2016-12-07 21:53:57 +00:00			`share/aclocal:`
			`- ACLOCAL_PATH`
Simplify /etc/spack/modules.yaml formatting. 2016-05-11 16:05:24 +00:00			`lib:`
			`- LIBRARY_PATH`
			`lib64:`
			`- LIBRARY_PATH`
			`include:`
			`- CPATH`
			`lib/pkgconfig:`
modules.yaml: use the right envvar for pkg-config Fixes #1072. 2016-06-20 15:10:13 +00:00			`- PKG_CONFIG_PATH`
Simplify /etc/spack/modules.yaml formatting. 2016-05-11 16:05:24 +00:00			`lib64/pkgconfig:`
modules.yaml: use the right envvar for pkg-config Fixes #1072. 2016-06-20 15:10:13 +00:00			`- PKG_CONFIG_PATH`
Consistently support pkg-config files in share subdirectory (#12838) While the build environment already takes share/pkgconfig into account, the generated module files etc. only consider lib/pkgconfig and lib64/pkgconfig. 2019-10-06 02:03:35 +00:00			`share/pkgconfig:`
			`- PKG_CONFIG_PATH`
Simplify /etc/spack/modules.yaml formatting. 2016-05-11 16:05:24 +00:00			`'':`
			`- CMAKE_PREFIX_PATH`
Modulefiles generated with a template engine (#3183) * Module files now are generated using a template engine refers #2902 #3173 jinja2 has been hooked into Spack. The python module `modules.py` has been splitted into several modules under the python package `spack/modules`. Unit tests stressing module file generation have been refactored accordingly. The module file generator for Lmod has been extended to multi-providers and deeper hierarchies. * Improved the support for templates in module files. Added an entry in `config.yaml` (`template_dirs`) to list all the directories where Spack could find templates for `jinja2`. Module file generators have a simple override mechanism to override template selection ('modules.yaml' beats 'package.py' beats 'default'). * Added jinja2 and MarkupSafe to vendored packages. * Spec.concretize() sets mutual spec-package references The correct place to set the mutual references between spec and package objects at the end of concretization. After a call to concretize we should now be ensured that spec is the same object as spec.package.spec. Code in `build_environment.py` that was performing the same operation has been turned into an assertion to be defensive on the new behavior. * Improved code and data layout for modules and related tests. Common fixtures related to module file generation have been extracted in `conftest.py`. All the mock configurations for module files have been extracted from python code and have been put into their own yaml file. Added a `context_property` decorator for the template engine, to make it easy to define dictionaries out of properties. The default for `verbose` in `modules.yaml` is now False instead of True. * Extendable module file contexts + short description from docstring The contexts that are used in conjunction with `jinja2` templates to generate module files can now be extended from package.py and modules.yaml. Module files generators now infer the short description from package.py docstring (and as you may expect it's the first paragraph) * 'module refresh' regenerates all modules by default `module refresh` without `--module-type` specified tries to regenerate all known module types. The same holds true for `module rm` Configure options used at build time are extracted and written into the module files where possible. * Fixed python3 compatibility, tests for Lmod and Tcl. Added test for exceptional paths of execution when generating Lmod module files. Fixed a few compatibility issues with python3. Fixed a bug in Tcl with naming_scheme and autoload + unit tests * Updated module file tutorial docs. Fixed a few typos in docstrings. The reference section for module files has been reorganized. The idea is to have only three topics at the highest level: - shell support + spack load/unload use/unuse - module file generation (a.k.a. APIs + modules.yaml) - module file maintenance (spack module refresh/rm) Module file generation will cover the entries in modules.yaml Also: - Licenses have been updated to include NOTICE and extended to 2017 - docstrings have been reformatted according to Google style * Removed redundant arguments to RPackage and WafPackage. All the callbacks in `RPackage` and `WafPackage` that are not build phases have been modified not to accept a `spec` and a `prefix` argument. This permits to leverage the common `configure_args` signature to insert by default the configuration arguments into the generated module files. I think it's preferable to handling those packages differently than `AutotoolsPackage`. Besides only one package seems to override one of these methods. * Fixed broken indentation + improved resiliency of refresh Fixed broken indentation in `spack module refresh` (probably a rebase gone silently wrong?). Filter the writers for blacklisted specs before searching for name clashes. An error with a single writer will not stop regeneration, but instead will print a warning and continue the command. 2017-09-19 19:34:20 +00:00
			`lmod:`
			`hierarchy:`
			`- mpi`