spack package¶
- spack.spack_version_info = (0, 20, 0, 'dev0')¶
(major, minor, micro, dev release) tuple
Subpackages¶
- spack.bootstrap package
BootstrapEnvironment
BootstrapEnvironment.bin_dirs()
BootstrapEnvironment.environment_root()
BootstrapEnvironment.pythonpaths()
BootstrapEnvironment.spack_dev_requirements()
BootstrapEnvironment.spack_yaml()
BootstrapEnvironment.update_installations()
BootstrapEnvironment.update_syspath_and_environ()
BootstrapEnvironment.view_root()
all_core_root_specs()
ensure_bootstrap_configuration()
ensure_core_dependencies()
ensure_environment_dependencies()
ensure_patchelf_in_path_or_raise()
is_bootstrapping()
status_message()
- Submodules
- spack.bootstrap.config module
- spack.bootstrap.core module
Bootstrapper
BuildcacheBootstrapper
IS_WINDOWS
METADATA_YAML_FILENAME
SourceBootstrapper
all_core_root_specs()
bootstrapper()
bootstrapping_sources()
clingo_root_spec()
create_bootstrapper()
ensure_clingo_importable_or_raise()
ensure_core_dependencies()
ensure_executables_in_path_or_raise()
ensure_gpg_in_path_or_raise()
ensure_module_importable_or_raise()
ensure_patchelf_in_path_or_raise()
gnupg_root_spec()
patchelf_root_spec()
source_is_enabled_or_raise()
verify_patchelf()
- spack.bootstrap.environment module
BootstrapEnvironment
BootstrapEnvironment.bin_dirs()
BootstrapEnvironment.environment_root()
BootstrapEnvironment.pythonpaths()
BootstrapEnvironment.spack_dev_requirements()
BootstrapEnvironment.spack_yaml()
BootstrapEnvironment.update_installations()
BootstrapEnvironment.update_syspath_and_environ()
BootstrapEnvironment.view_root()
black_root_spec()
ensure_environment_dependencies()
flake8_root_spec()
isort_root_spec()
mypy_root_spec()
pytest_root_spec()
- spack.bootstrap.status module
- spack.build_systems package
- Submodules
- spack.build_systems.aspell_dict module
- spack.build_systems.autotools module
AutotoolsBuilder
AutotoolsBuilder.archive_files
AutotoolsBuilder.autoreconf()
AutotoolsBuilder.autoreconf_extra_args
AutotoolsBuilder.autoreconf_search_path_args
AutotoolsBuilder.build()
AutotoolsBuilder.build_directory
AutotoolsBuilder.build_system
AutotoolsBuilder.build_targets
AutotoolsBuilder.build_time_test_callbacks
AutotoolsBuilder.check()
AutotoolsBuilder.configure()
AutotoolsBuilder.configure_abs_path
AutotoolsBuilder.configure_args()
AutotoolsBuilder.configure_directory
AutotoolsBuilder.delete_configure_to_force_update()
AutotoolsBuilder.enable_or_disable()
AutotoolsBuilder.force_autoreconf
AutotoolsBuilder.install()
AutotoolsBuilder.install_libtool_archives
AutotoolsBuilder.install_targets
AutotoolsBuilder.install_time_test_callbacks
AutotoolsBuilder.installcheck()
AutotoolsBuilder.legacy_attributes
AutotoolsBuilder.legacy_methods
AutotoolsBuilder.patch_config_files
AutotoolsBuilder.patch_libtool
AutotoolsBuilder.phases
AutotoolsBuilder.remove_libtool_archives()
AutotoolsBuilder.run_after_callbacks
AutotoolsBuilder.run_before_callbacks
AutotoolsBuilder.set_configure_or_die()
AutotoolsBuilder.setup_build_environment()
AutotoolsBuilder.with_or_without()
AutotoolsPackage
- spack.build_systems.bundle module
- spack.build_systems.cached_cmake module
CachedCMakeBuilder
CachedCMakeBuilder.cache_name
CachedCMakeBuilder.cache_path
CachedCMakeBuilder.initconfig()
CachedCMakeBuilder.initconfig_compiler_entries()
CachedCMakeBuilder.initconfig_hardware_entries()
CachedCMakeBuilder.initconfig_mpi_entries()
CachedCMakeBuilder.initconfig_package_entries()
CachedCMakeBuilder.install_cmake_cache()
CachedCMakeBuilder.legacy_attributes
CachedCMakeBuilder.legacy_methods
CachedCMakeBuilder.phases
CachedCMakeBuilder.run_after_callbacks
CachedCMakeBuilder.std_cmake_args
CachedCMakeBuilder.std_initconfig_entries()
CachedCMakePackage
cmake_cache_option()
cmake_cache_path()
cmake_cache_string()
- spack.build_systems.cmake module
CMakeBuilder
CMakeBuilder.archive_files
CMakeBuilder.build()
CMakeBuilder.build_directory
CMakeBuilder.build_dirname
CMakeBuilder.build_system
CMakeBuilder.build_targets
CMakeBuilder.build_time_test_callbacks
CMakeBuilder.check()
CMakeBuilder.cmake()
CMakeBuilder.cmake_args()
CMakeBuilder.define()
CMakeBuilder.define_from_variant()
CMakeBuilder.generator
CMakeBuilder.install()
CMakeBuilder.install_targets
CMakeBuilder.legacy_attributes
CMakeBuilder.legacy_methods
CMakeBuilder.phases
CMakeBuilder.root_cmakelists_dir
CMakeBuilder.run_after_callbacks
CMakeBuilder.std_args()
CMakeBuilder.std_cmake_args
CMakePackage
- spack.build_systems.cuda module
- spack.build_systems.generic module
- spack.build_systems.gnu module
- spack.build_systems.intel module
IntelPackage
IntelPackage.auto_dispatch_options
IntelPackage.base_lib_dir
IntelPackage.blas_libs
IntelPackage.build_system_class
IntelPackage.component_bin_dir()
IntelPackage.component_include_dir()
IntelPackage.component_lib_dir()
IntelPackage.configure()
IntelPackage.configure_auto_dispatch()
IntelPackage.configure_rpath()
IntelPackage.file_to_source
IntelPackage.filter_compiler_wrappers()
IntelPackage.global_license_file
IntelPackage.headers
IntelPackage.install()
IntelPackage.intel64_int_suffix
IntelPackage.lapack_libs
IntelPackage.libs
IntelPackage.license_comment
IntelPackage.license_files
IntelPackage.license_required
IntelPackage.license_url
IntelPackage.license_vars
IntelPackage.modify_LLVMgold_rpath()
IntelPackage.mpi_compiler_wrappers
IntelPackage.mpi_setup_dependent_build_environment()
IntelPackage.normalize_path()
IntelPackage.normalize_suite_dir()
IntelPackage.openmp_libs
IntelPackage.pset_components
IntelPackage.run_after_callbacks
IntelPackage.run_before_callbacks
IntelPackage.scalapack_libs
IntelPackage.setup_dependent_build_environment()
IntelPackage.setup_dependent_package()
IntelPackage.setup_run_environment()
IntelPackage.tbb_headers
IntelPackage.tbb_libs
IntelPackage.uninstall_ism()
IntelPackage.validate_install()
IntelPackage.version_yearlike
IntelPackage.version_years
debug_print()
raise_lib_error()
- spack.build_systems.lua module
LuaBuilder
LuaBuilder.build_system
LuaBuilder.build_time_test_callbacks
LuaBuilder.generate_luarocks_config()
LuaBuilder.install()
LuaBuilder.install_time_test_callbacks
LuaBuilder.legacy_attributes
LuaBuilder.legacy_methods
LuaBuilder.luarocks_args()
LuaBuilder.phases
LuaBuilder.preprocess()
LuaBuilder.setup_build_environment()
LuaBuilder.unpack()
LuaPackage
- spack.build_systems.makefile module
MakefileBuilder
MakefileBuilder.build()
MakefileBuilder.build_directory
MakefileBuilder.build_system
MakefileBuilder.build_targets
MakefileBuilder.build_time_test_callbacks
MakefileBuilder.check()
MakefileBuilder.edit()
MakefileBuilder.install()
MakefileBuilder.install_targets
MakefileBuilder.install_time_test_callbacks
MakefileBuilder.installcheck()
MakefileBuilder.legacy_attributes
MakefileBuilder.legacy_methods
MakefileBuilder.phases
MakefileBuilder.run_after_callbacks
MakefilePackage
- spack.build_systems.maven module
- spack.build_systems.meson module
MesonBuilder
MesonBuilder.archive_files
MesonBuilder.build()
MesonBuilder.build_directory
MesonBuilder.build_dirname
MesonBuilder.build_system
MesonBuilder.build_targets
MesonBuilder.build_time_test_callbacks
MesonBuilder.check()
MesonBuilder.install()
MesonBuilder.install_targets
MesonBuilder.legacy_attributes
MesonBuilder.legacy_methods
MesonBuilder.meson()
MesonBuilder.meson_args()
MesonBuilder.phases
MesonBuilder.root_mesonlists_dir
MesonBuilder.run_after_callbacks
MesonBuilder.std_args()
MesonBuilder.std_meson_args
MesonPackage
- spack.build_systems.msbuild module
MSBuildBuilder
MSBuildBuilder.build()
MSBuildBuilder.build_directory
MSBuildBuilder.build_system
MSBuildBuilder.build_targets
MSBuildBuilder.define()
MSBuildBuilder.define_targets()
MSBuildBuilder.install()
MSBuildBuilder.install_targets
MSBuildBuilder.msbuild_args()
MSBuildBuilder.msbuild_install_args()
MSBuildBuilder.phases
MSBuildBuilder.std_msbuild_args
MSBuildBuilder.toolchain_version
MSBuildPackage
- spack.build_systems.nmake module
NMakeBuilder
NMakeBuilder.build()
NMakeBuilder.build_directory
NMakeBuilder.build_system
NMakeBuilder.build_targets
NMakeBuilder.define()
NMakeBuilder.ignore_quotes
NMakeBuilder.install()
NMakeBuilder.install_targets
NMakeBuilder.makefile_root
NMakeBuilder.nmake_args()
NMakeBuilder.nmake_install_args()
NMakeBuilder.nmakefile_name
NMakeBuilder.override_env()
NMakeBuilder.phases
NMakeBuilder.std_nmake_args
NMakePackage
- spack.build_systems.octave module
- spack.build_systems.oneapi module
IntelOneApiLibraryPackage
IntelOneApiPackage
IntelOneApiPackage.c
IntelOneApiPackage.component_dir
IntelOneApiPackage.component_prefix
IntelOneApiPackage.homepage
IntelOneApiPackage.install()
IntelOneApiPackage.install_component()
IntelOneApiPackage.redistribute_source
IntelOneApiPackage.setup_run_environment()
IntelOneApiPackage.update_description()
IntelOneApiStaticLibraryList
- spack.build_systems.perl module
PerlBuilder
PerlBuilder.build()
PerlBuilder.build_system
PerlBuilder.build_time_test_callbacks
PerlBuilder.check()
PerlBuilder.configure()
PerlBuilder.configure_args()
PerlBuilder.fix_shebang()
PerlBuilder.install()
PerlBuilder.install_time_test_callbacks
PerlBuilder.legacy_attributes
PerlBuilder.legacy_methods
PerlBuilder.phases
PerlBuilder.run_after_callbacks
PerlPackage
- spack.build_systems.python module
PythonExtension
PythonPackage
PythonPackage.build_system_class
PythonPackage.get_external_python_for_prefix()
PythonPackage.headers
PythonPackage.homepage
PythonPackage.install_time_test_callbacks
PythonPackage.legacy_buildsystem
PythonPackage.libs
PythonPackage.list_url
PythonPackage.maintainers
PythonPackage.py_namespace
PythonPackage.pypi
PythonPackage.update_external_dependencies()
PythonPackage.url
PythonPipBuilder
PythonPipBuilder.build_directory
PythonPipBuilder.build_system
PythonPipBuilder.build_time_test_callbacks
PythonPipBuilder.config_settings()
PythonPipBuilder.global_options()
PythonPipBuilder.install()
PythonPipBuilder.install_options()
PythonPipBuilder.install_time_test_callbacks
PythonPipBuilder.legacy_attributes
PythonPipBuilder.legacy_long_methods
PythonPipBuilder.legacy_methods
PythonPipBuilder.phases
PythonPipBuilder.run_after_callbacks
PythonPipBuilder.std_args()
- spack.build_systems.qmake module
QMakeBuilder
QMakeBuilder.build()
QMakeBuilder.build_directory
QMakeBuilder.build_system
QMakeBuilder.build_time_test_callbacks
QMakeBuilder.check()
QMakeBuilder.install()
QMakeBuilder.install_time_test_callbacks
QMakeBuilder.legacy_attributes
QMakeBuilder.legacy_methods
QMakeBuilder.phases
QMakeBuilder.qmake()
QMakeBuilder.qmake_args()
QMakeBuilder.run_after_callbacks
QMakePackage
- spack.build_systems.r module
- spack.build_systems.racket module
- spack.build_systems.rocm module
- spack.build_systems.ruby module
- spack.build_systems.scons module
SConsBuilder
SConsBuilder.build()
SConsBuilder.build_args()
SConsBuilder.build_system
SConsBuilder.build_test()
SConsBuilder.build_time_test_callbacks
SConsBuilder.install()
SConsBuilder.install_args()
SConsBuilder.install_time_test_callbacks
SConsBuilder.legacy_attributes
SConsBuilder.legacy_long_methods
SConsBuilder.legacy_methods
SConsBuilder.phases
SConsBuilder.run_after_callbacks
SConsPackage
- spack.build_systems.sip module
SIPBuilder
SIPBuilder.build()
SIPBuilder.build_args()
SIPBuilder.build_system
SIPBuilder.build_time_test_callbacks
SIPBuilder.configure()
SIPBuilder.configure_args()
SIPBuilder.configure_file()
SIPBuilder.extend_path_setup()
SIPBuilder.install()
SIPBuilder.install_args()
SIPBuilder.install_time_test_callbacks
SIPBuilder.legacy_attributes
SIPBuilder.legacy_methods
SIPBuilder.phases
SIPBuilder.run_after_callbacks
SIPPackage
- spack.build_systems.sourceforge module
- spack.build_systems.sourceware module
- spack.build_systems.waf module
WafBuilder
WafBuilder.build()
WafBuilder.build_args()
WafBuilder.build_directory
WafBuilder.build_system
WafBuilder.build_test()
WafBuilder.build_time_test_callbacks
WafBuilder.configure()
WafBuilder.configure_args()
WafBuilder.install()
WafBuilder.install_args()
WafBuilder.install_test()
WafBuilder.install_time_test_callbacks
WafBuilder.legacy_attributes
WafBuilder.legacy_methods
WafBuilder.phases
WafBuilder.python()
WafBuilder.run_after_callbacks
WafBuilder.waf()
WafPackage
- spack.build_systems.xorg module
- spack.cmd package
CommandNameError
PythonNameError
all_commands()
cmd_name()
disambiguate_spec()
disambiguate_spec_from_hashes()
display_specs()
display_specs_as_json()
ensure_single_spec_or_die()
extant_file()
filter_loaded_specs()
find_environment()
first_line()
get_command()
get_module()
gray_hash()
is_git_repo()
iter_groups()
matching_spec_from_env()
parse_specs()
print_how_many_pkgs()
python_name()
remove_options()
require_active_env()
require_cmd_name()
require_python_name()
spack_is_git_repo()
- Subpackages
- Submodules
- spack.cmd.add module
- spack.cmd.arch module
- spack.cmd.audit module
- spack.cmd.blame module
- spack.cmd.bootstrap module
- spack.cmd.build_env module
- spack.cmd.buildcache module
- spack.cmd.cd module
- spack.cmd.change module
- spack.cmd.checksum module
- spack.cmd.ci module
- spack.cmd.clean module
- spack.cmd.clone module
- spack.cmd.commands module
- spack.cmd.compiler module
- spack.cmd.compilers module
- spack.cmd.concretize module
- spack.cmd.config module
- spack.cmd.containerize module
- spack.cmd.create module
AutoreconfPackageTemplate
AutotoolsPackageTemplate
BazelPackageTemplate
BuildSystemGuesser
BundlePackageTemplate
CMakePackageTemplate
IntelPackageTemplate
LuaPackageTemplate
MakefilePackageTemplate
MavenPackageTemplate
MesonPackageTemplate
OctavePackageTemplate
PackageTemplate
PerlbuildPackageTemplate
PerlmakePackageTemplate
PythonPackageTemplate
QMakePackageTemplate
RPackageTemplate
RacketPackageTemplate
RubyPackageTemplate
SIPPackageTemplate
SconsPackageTemplate
WafPackageTemplate
create()
get_build_system()
get_name()
get_repository()
get_url()
get_versions()
setup_parser()
- spack.cmd.debug module
- spack.cmd.dependencies module
- spack.cmd.dependents module
- spack.cmd.deprecate module
- spack.cmd.dev_build module
- spack.cmd.develop module
- spack.cmd.diff module
- spack.cmd.docs module
- spack.cmd.edit module
- spack.cmd.env module
MakeTargetVisitor
ViewAction
create_temp_env_directory()
env()
env_activate()
env_activate_setup_parser()
env_create()
env_create_setup_parser()
env_deactivate()
env_deactivate_setup_parser()
env_depfile()
env_depfile_setup_parser()
env_list()
env_list_setup_parser()
env_loads()
env_loads_setup_parser()
env_remove()
env_remove_setup_parser()
env_revert()
env_revert_setup_parser()
env_status()
env_status_setup_parser()
env_update()
env_update_setup_parser()
env_view()
env_view_setup_parser()
setup_parser()
subcommand_functions
subcommands
- spack.cmd.extensions module
- spack.cmd.external module
- spack.cmd.fetch module
- spack.cmd.find module
- spack.cmd.gc module
- spack.cmd.gpg module
- spack.cmd.graph module
- spack.cmd.help module
- spack.cmd.info module
- spack.cmd.install module
cache_opt()
compute_tests_install_kwargs()
concrete_specs_from_file()
default_log_file()
install()
install_all_specs_from_active_environment()
install_kwargs_from_args()
install_specs()
install_specs_inside_environment()
install_specs_outside_environment()
print_cdash_help()
report_filename()
require_user_confirmation_for_overwrite()
setup_parser()
specs_from_cli()
- spack.cmd.license module
- spack.cmd.list module
- spack.cmd.load module
- spack.cmd.location module
- spack.cmd.log_parse module
- spack.cmd.maintainers module
- spack.cmd.make_installer module
- spack.cmd.mark module
- spack.cmd.mirror module
all_specs_with_all_versions()
concrete_specs_from_cli_or_file()
concrete_specs_from_environment()
concrete_specs_from_user()
create_mirror_for_all_specs()
create_mirror_for_all_specs_inside_environment()
create_mirror_for_individual_specs()
extend_with_additional_versions()
extend_with_dependencies()
filter_externals()
mirror()
mirror_add()
mirror_create()
mirror_destroy()
mirror_list()
mirror_remove()
mirror_set_url()
not_excluded_fn()
process_mirror_stats()
setup_parser()
specs_from_text_file()
versions_per_spec()
- spack.cmd.module module
- spack.cmd.patch module
- spack.cmd.pkg module
- spack.cmd.providers module
- spack.cmd.pydoc module
- spack.cmd.python module
- spack.cmd.reindex module
- spack.cmd.remove module
- spack.cmd.repo module
- spack.cmd.resource module
- spack.cmd.restage module
- spack.cmd.solve module
- spack.cmd.spec module
- spack.cmd.stage module
- spack.cmd.style module
changed_files()
cwd_relative()
exclude_directories
grouper()
is_package()
missing_tools()
mypy_ignores
print_style_header()
print_tool_header()
print_tool_result()
rewrite_and_print_output()
run_black()
run_flake8()
run_isort()
run_mypy()
setup_parser()
style()
tool
tool_names
tools
validate_toolset()
- spack.cmd.tags module
- spack.cmd.test module
- spack.cmd.test_env module
- spack.cmd.tutorial module
- spack.cmd.undevelop module
- spack.cmd.uninstall module
- spack.cmd.unit_test module
- spack.cmd.unload module
- spack.cmd.url module
- spack.cmd.verify module
- spack.cmd.versions module
- spack.cmd.view module
- spack.compilers package
CacheReference
CompilerDuplicateError
CompilerID
CompilerSpecInsufficientlySpecificError
DetectVersionArgs
InvalidCompilerConfigurationError
NameVariation
NoCompilerForSpecError
NoCompilersError
UnknownCompilerError
add_compilers_to_config()
all_compiler_specs()
all_compiler_types()
all_compilers()
all_compilers_config()
all_os_classes()
arguments_to_detect_version_fn()
class_for_compiler_name()
compiler_config_files()
compiler_for_spec()
compiler_from_dict()
compiler_specs_for_arch()
compilers_for_arch()
compilers_for_spec()
detect_version()
find()
find_compilers()
find_new_compilers()
find_specs_by_arch()
get_compiler_config()
get_compiler_duplicates()
get_compilers()
is_mixed_toolchain()
make_compiler_list()
pkg_spec_for_compiler()
remove_compiler_from_config()
select_new_compilers()
supported()
supported_compilers()
- Submodules
- spack.compilers.aocc module
Aocc
Aocc.PrgEnv
Aocc.PrgEnv_compiler
Aocc.c11_flag
Aocc.c99_flag
Aocc.cc_names
Aocc.cc_pic_flag
Aocc.cflags
Aocc.cxx11_flag
Aocc.cxx14_flag
Aocc.cxx17_flag
Aocc.cxx_names
Aocc.cxx_pic_flag
Aocc.cxxflags
Aocc.debug_flags
Aocc.extract_version_from_output()
Aocc.f77_names
Aocc.f77_pic_flag
Aocc.f77_version()
Aocc.fc_names
Aocc.fc_pic_flag
Aocc.fc_version()
Aocc.fflags
Aocc.link_paths
Aocc.openmp_flag
Aocc.opt_flags
Aocc.required_libs
Aocc.stdcxx_libs
Aocc.verbose_flag
Aocc.version_argument
- spack.compilers.apple_clang module
- spack.compilers.arm module
Arm
Arm.c11_flag
Arm.c99_flag
Arm.cc_names
Arm.cc_pic_flag
Arm.cxx11_flag
Arm.cxx14_flag
Arm.cxx17_flag
Arm.cxx_names
Arm.cxx_pic_flag
Arm.extract_version_from_output()
Arm.f77_names
Arm.f77_pic_flag
Arm.f77_version()
Arm.fc_names
Arm.fc_pic_flag
Arm.fc_version()
Arm.link_paths
Arm.openmp_flag
Arm.opt_flags
Arm.required_libs
Arm.verbose_flag
Arm.version_argument
Arm.version_regex
- spack.compilers.cce module
Cce
Cce.PrgEnv
Cce.PrgEnv_compiler
Cce.c11_flag
Cce.c99_flag
Cce.cc_names
Cce.cc_pic_flag
Cce.cxx11_flag
Cce.cxx14_flag
Cce.cxx_names
Cce.cxx_pic_flag
Cce.debug_flags
Cce.f77_names
Cce.f77_pic_flag
Cce.fc_names
Cce.fc_pic_flag
Cce.is_clang_based
Cce.link_paths
Cce.openmp_flag
Cce.stdcxx_libs
Cce.suffixes
Cce.verbose_flag
Cce.version_argument
Cce.version_regex
- spack.compilers.clang module
Clang
Clang.c11_flag
Clang.c99_flag
Clang.cc_names
Clang.cc_pic_flag
Clang.cxx11_flag
Clang.cxx14_flag
Clang.cxx17_flag
Clang.cxx_names
Clang.cxx_pic_flag
Clang.debug_flags
Clang.extract_version_from_output()
Clang.f77_names
Clang.f77_pic_flag
Clang.f77_version()
Clang.fc_names
Clang.fc_pic_flag
Clang.fc_version()
Clang.link_paths
Clang.openmp_flag
Clang.opt_flags
Clang.required_libs
Clang.verbose_flag
Clang.version_argument
f77_mapping
fc_mapping
- spack.compilers.dpcpp module
- spack.compilers.fj module
Fj
Fj.c11_flag
Fj.c99_flag
Fj.cc_names
Fj.cc_pic_flag
Fj.cxx11_flag
Fj.cxx14_flag
Fj.cxx17_flag
Fj.cxx98_flag
Fj.cxx_names
Fj.cxx_pic_flag
Fj.debug_flags
Fj.f77_names
Fj.f77_pic_flag
Fj.fc_names
Fj.fc_pic_flag
Fj.link_paths
Fj.openmp_flag
Fj.opt_flags
Fj.required_libs
Fj.verbose_flag
Fj.version_argument
Fj.version_regex
- spack.compilers.gcc module
Gcc
Gcc.PrgEnv
Gcc.PrgEnv_compiler
Gcc.c11_flag
Gcc.c99_flag
Gcc.cc_names
Gcc.cc_pic_flag
Gcc.cxx11_flag
Gcc.cxx14_flag
Gcc.cxx17_flag
Gcc.cxx98_flag
Gcc.cxx_names
Gcc.cxx_pic_flag
Gcc.debug_flags
Gcc.default_version()
Gcc.f77_names
Gcc.f77_pic_flag
Gcc.f77_version()
Gcc.fc_names
Gcc.fc_pic_flag
Gcc.fc_version()
Gcc.link_paths
Gcc.openmp_flag
Gcc.opt_flags
Gcc.prefix
Gcc.required_libs
Gcc.stdcxx_libs
Gcc.suffixes
Gcc.verbose_flag
- spack.compilers.intel module
Intel
Intel.PrgEnv
Intel.PrgEnv_compiler
Intel.c11_flag
Intel.c99_flag
Intel.cc_names
Intel.cc_pic_flag
Intel.cxx11_flag
Intel.cxx14_flag
Intel.cxx_names
Intel.cxx_pic_flag
Intel.debug_flags
Intel.f77_names
Intel.f77_pic_flag
Intel.fc_names
Intel.fc_pic_flag
Intel.link_paths
Intel.openmp_flag
Intel.opt_flags
Intel.required_libs
Intel.stdcxx_libs
Intel.verbose_flag
Intel.version_argument
Intel.version_regex
- spack.compilers.msvc module
- spack.compilers.nag module
Nag
Nag.cc_names
Nag.cxx11_flag
Nag.cxx_names
Nag.debug_flags
Nag.disable_new_dtags
Nag.enable_new_dtags
Nag.f77_names
Nag.f77_pic_flag
Nag.f77_rpath_arg
Nag.fc_names
Nag.fc_pic_flag
Nag.fc_rpath_arg
Nag.link_paths
Nag.linker_arg
Nag.openmp_flag
Nag.opt_flags
Nag.verbose_flag
Nag.version_argument
Nag.version_regex
- spack.compilers.nvhpc module
Nvhpc
Nvhpc.PrgEnv
Nvhpc.PrgEnv_compiler
Nvhpc.c11_flag
Nvhpc.c99_flag
Nvhpc.cc_names
Nvhpc.cc_pic_flag
Nvhpc.cxx11_flag
Nvhpc.cxx14_flag
Nvhpc.cxx17_flag
Nvhpc.cxx_names
Nvhpc.cxx_pic_flag
Nvhpc.debug_flags
Nvhpc.f77_names
Nvhpc.f77_pic_flag
Nvhpc.fc_names
Nvhpc.fc_pic_flag
Nvhpc.link_paths
Nvhpc.openmp_flag
Nvhpc.opt_flags
Nvhpc.required_libs
Nvhpc.stdcxx_libs
Nvhpc.verbose_flag
Nvhpc.version_argument
Nvhpc.version_regex
- spack.compilers.oneapi module
Oneapi
Oneapi.PrgEnv
Oneapi.PrgEnv_compiler
Oneapi.c11_flag
Oneapi.c99_flag
Oneapi.cc_names
Oneapi.cc_pic_flag
Oneapi.cxx11_flag
Oneapi.cxx14_flag
Oneapi.cxx17_flag
Oneapi.cxx20_flag
Oneapi.cxx_names
Oneapi.cxx_pic_flag
Oneapi.debug_flags
Oneapi.f77_names
Oneapi.f77_pic_flag
Oneapi.fc_names
Oneapi.fc_pic_flag
Oneapi.link_paths
Oneapi.openmp_flag
Oneapi.opt_flags
Oneapi.required_libs
Oneapi.setup_custom_environment()
Oneapi.stdcxx_libs
Oneapi.verbose_flag
Oneapi.version_argument
Oneapi.version_regex
- spack.compilers.pgi module
Pgi
Pgi.PrgEnv
Pgi.PrgEnv_compiler
Pgi.c11_flag
Pgi.c99_flag
Pgi.cc_names
Pgi.cc_pic_flag
Pgi.cxx11_flag
Pgi.cxx_names
Pgi.cxx_pic_flag
Pgi.debug_flags
Pgi.f77_names
Pgi.f77_pic_flag
Pgi.fc_names
Pgi.fc_pic_flag
Pgi.ignore_version_errors
Pgi.link_paths
Pgi.openmp_flag
Pgi.opt_flags
Pgi.required_libs
Pgi.stdcxx_libs
Pgi.verbose_flag
Pgi.version_argument
Pgi.version_regex
- spack.compilers.rocmcc module
Rocmcc
Rocmcc.PrgEnv
Rocmcc.PrgEnv_compiler
Rocmcc.c11_flag
Rocmcc.c99_flag
Rocmcc.cc_names
Rocmcc.cxx11_flag
Rocmcc.cxx14_flag
Rocmcc.cxx17_flag
Rocmcc.cxx_names
Rocmcc.extract_version_from_output()
Rocmcc.f77_names
Rocmcc.f77_version()
Rocmcc.fc_names
Rocmcc.fc_version()
Rocmcc.link_paths
Rocmcc.stdcxx_libs
- spack.compilers.xl module
Xl
Xl.c11_flag
Xl.c99_flag
Xl.cc_names
Xl.cc_pic_flag
Xl.cxx11_flag
Xl.cxx14_flag
Xl.cxx_names
Xl.cxx_pic_flag
Xl.debug_flags
Xl.f77_names
Xl.f77_pic_flag
Xl.f77_version()
Xl.fc_names
Xl.fc_pic_flag
Xl.fc_version()
Xl.fflags
Xl.link_paths
Xl.openmp_flag
Xl.opt_flags
Xl.verbose_flag
Xl.version_argument
Xl.version_regex
- spack.compilers.xl_r module
- spack.container package
- spack.detection package
DetectedPackage
by_executable()
by_library()
executable_prefix()
executables_in_path()
update_configuration()
- Submodules
- spack.detection.common module
DetectedPackage
WindowsCompilerExternalPaths
WindowsKitExternalPaths
WindowsKitExternalPaths.find_windows_driver_development_kit_paths()
WindowsKitExternalPaths.find_windows_kit_bin_paths()
WindowsKitExternalPaths.find_windows_kit_lib_paths()
WindowsKitExternalPaths.find_windows_kit_reg_installed_roots_paths()
WindowsKitExternalPaths.find_windows_kit_reg_sdk_paths()
WindowsKitExternalPaths.find_windows_kit_roots()
compute_windows_program_path_for_package()
compute_windows_user_path_for_package()
executable_prefix()
find_win32_additional_install_paths()
is_executable()
library_prefix()
path_to_dict()
update_configuration()
- spack.detection.path module
- spack.environment package
- spack.lock format
Environment
Environment.active
Environment.add()
Environment.add_default_view_to_env()
Environment.added_specs()
Environment.all_hashes()
Environment.all_specs()
Environment.change_existing_spec()
Environment.check_views()
Environment.clear()
Environment.concretize()
Environment.concretize_and_add()
Environment.concretized_specs()
Environment.config_scopes()
Environment.config_stage_dir
Environment.default_view
Environment.destroy()
Environment.develop()
Environment.env_file_config_scope()
Environment.env_file_config_scope_name()
Environment.env_subdir_path
Environment.get_by_hash()
Environment.get_one_by_hash()
Environment.included_config_scopes()
Environment.install_all()
Environment.install_specs()
Environment.internal
Environment.is_develop()
Environment.lock_path
Environment.log_path
Environment.manifest_path
Environment.matching_spec()
Environment.name
Environment.regenerate_views()
Environment.remove()
Environment.removed_specs()
Environment.repo
Environment.repos_path
Environment.rm_default_view_from_env()
Environment.roots()
Environment.undevelop()
Environment.uninstalled_specs()
Environment.update_default_view()
Environment.update_stale_references()
Environment.user_specs
Environment.view_path_default
Environment.write()
Environment.write_transaction()
SpackEnvironmentError
SpackEnvironmentViewError
activate()
active()
active_environment()
all_environment_names()
all_environments()
config_dict()
create()
deactivate()
default_manifest_yaml()
display_specs()
exists()
installed_specs()
is_env_dir()
is_latest_format()
manifest_file()
no_active_environment()
read()
root()
update_yaml()
- Submodules
- spack.environment.environment module
Environment
Environment.active
Environment.add()
Environment.add_default_view_to_env()
Environment.added_specs()
Environment.all_hashes()
Environment.all_specs()
Environment.change_existing_spec()
Environment.check_views()
Environment.clear()
Environment.concretize()
Environment.concretize_and_add()
Environment.concretized_specs()
Environment.config_scopes()
Environment.config_stage_dir
Environment.default_view
Environment.destroy()
Environment.develop()
Environment.env_file_config_scope()
Environment.env_file_config_scope_name()
Environment.env_subdir_path
Environment.get_by_hash()
Environment.get_one_by_hash()
Environment.included_config_scopes()
Environment.install_all()
Environment.install_specs()
Environment.internal
Environment.is_develop()
Environment.lock_path
Environment.log_path
Environment.manifest_path
Environment.matching_spec()
Environment.name
Environment.regenerate_views()
Environment.remove()
Environment.removed_specs()
Environment.repo
Environment.repos_path
Environment.rm_default_view_from_env()
Environment.roots()
Environment.undevelop()
Environment.uninstalled_specs()
Environment.update_default_view()
Environment.update_stale_references()
Environment.user_specs
Environment.view_path_default
Environment.write()
Environment.write_transaction()
SpackEnvironmentError
SpackEnvironmentViewError
ViewDescriptor
activate()
active()
active_environment()
all_environment_names()
all_environments()
config_dict()
create()
deactivate()
deactivate_config_scope()
default_manifest_yaml()
display_specs()
env_path
env_subdir_name
exists()
installed_specs()
is_env_dir()
is_latest_format()
lockfile_format_version
lockfile_name
make_repo_path()
manifest_file()
manifest_name
no_active_environment()
prepare_config_scope()
read()
root()
spack_env_var
update_yaml()
valid_env_name()
valid_environment_name_re
validate_env_name()
yaml_equivalent()
- spack.environment.shell module
- spack.hooks package
- Submodules
- spack.hooks.absolutify_elf_sonames module
- spack.hooks.licensing module
- spack.hooks.module_file_generation module
- spack.hooks.permissions_setters module
- spack.hooks.sbang module
- spack.hooks.write_install_manifest module
- spack.modules package
LmodModulefileWriter
TclModulefileWriter
disable_modules()
- Submodules
- spack.modules.common module
BaseConfiguration
BaseConfiguration.context
BaseConfiguration.default_projections
BaseConfiguration.defaults
BaseConfiguration.env
BaseConfiguration.exclude_env_vars
BaseConfiguration.excluded
BaseConfiguration.hash
BaseConfiguration.literals_to_load
BaseConfiguration.projections
BaseConfiguration.specs_to_load
BaseConfiguration.specs_to_prereq
BaseConfiguration.suffixes
BaseConfiguration.template
BaseConfiguration.verbose
BaseContext
BaseFileLayout
BaseModuleFileWriter
DefaultTemplateNotDefined
ModuleIndexEntry
ModuleNotFoundError
ModulesError
ModulesTemplateNotFoundError
UpstreamModuleIndex
configuration()
dependencies()
disable_modules()
generate_module_index()
get_deprecated()
get_module()
merge_config_rules()
read_module_index()
read_module_indices()
root_path()
update_dictionary_extending_lists()
- spack.modules.lmod module
- spack.modules.tcl module
- spack.operating_systems package
- spack.platforms package
Cray
Darwin
Linux
Platform
Platform.add_operating_system()
Platform.add_target()
Platform.back_end
Platform.back_os
Platform.binary_formats
Platform.default
Platform.default_os
Platform.detect()
Platform.front_end
Platform.front_os
Platform.operating_system()
Platform.priority
Platform.reserved_oss
Platform.reserved_targets
Platform.setup_platform_environment()
Platform.target()
Test
Windows
by_name()
host()
prevent_cray_detection()
reset()
- Submodules
- spack.platforms.cray module
- spack.platforms.darwin module
- spack.platforms.linux module
- spack.platforms.test module
- spack.platforms.windows module
- spack.reporters package
CDash
CDash.build_report()
CDash.build_report_for_package()
CDash.concretization_report()
CDash.extract_standalone_test_data()
CDash.finalize_report()
CDash.initialize_report()
CDash.report_build_name()
CDash.report_test_data()
CDash.success
CDash.test_report()
CDash.test_report_for_package()
CDash.test_skipped_report()
CDash.upload()
CDashConfiguration
JUnit
Reporter
- Submodules
- spack.reporters.base module
- spack.reporters.cdash module
CDash
CDash.buildIds
CDash.build_report()
CDash.build_report_for_package()
CDash.concretization_report()
CDash.extract_standalone_test_data()
CDash.finalize_report()
CDash.initialize_report()
CDash.report_build_name()
CDash.report_test_data()
CDash.success
CDash.test_report()
CDash.test_report_for_package()
CDash.test_skipped_report()
CDash.upload()
CDashConfiguration
build_stamp()
- spack.reporters.extract module
- spack.reporters.junit module
- spack.schema package
- Submodules
- spack.schema.bootstrap module
- spack.schema.buildcache_spec module
- spack.schema.cdash module
- spack.schema.compilers module
- spack.schema.concretizer module
- spack.schema.config module
- spack.schema.container module
- spack.schema.cray_manifest module
- spack.schema.database_index module
- spack.schema.env module
- spack.schema.environment module
- spack.schema.gitlab_ci module
- spack.schema.merged module
- spack.schema.mirrors module
- spack.schema.modules module
- spack.schema.packages module
- spack.schema.projections module
- spack.schema.repos module
- spack.schema.spec module
- spack.schema.upstreams module
- spack.solver package
- Submodules
- spack.solver.asp module
AspFunction
AspFunctionBuilder
AspObject
DEFAULT_OUTPUT_CONFIGURATION
DeclaredVersion
InternalConcretizerError
OutputConfiguration
PyclingoDriver
Result
Solver
SpackSolverSetup
SpackSolverSetup.add_concrete_versions_from_specs()
SpackSolverSetup.available_compilers()
SpackSolverSetup.build_version_dict()
SpackSolverSetup.compiler_defaults()
SpackSolverSetup.compiler_supports_os()
SpackSolverSetup.condition()
SpackSolverSetup.conflict_rules()
SpackSolverSetup.define_compiler_version_constraints()
SpackSolverSetup.define_concrete_input_specs()
SpackSolverSetup.define_target_constraints()
SpackSolverSetup.define_variant_values()
SpackSolverSetup.define_version_constraints()
SpackSolverSetup.define_virtual_constraints()
SpackSolverSetup.emit_facts_from_requirement_rules()
SpackSolverSetup.external_packages()
SpackSolverSetup.flag_defaults()
SpackSolverSetup.generate_possible_compilers()
SpackSolverSetup.impose()
SpackSolverSetup.literal_specs()
SpackSolverSetup.os_defaults()
SpackSolverSetup.package_compiler_defaults()
SpackSolverSetup.package_dependencies_rules()
SpackSolverSetup.package_provider_rules()
SpackSolverSetup.package_requirement_rules()
SpackSolverSetup.pkg_rules()
SpackSolverSetup.pkg_version_rules()
SpackSolverSetup.platform_defaults()
SpackSolverSetup.preferred_variants()
SpackSolverSetup.provider_defaults()
SpackSolverSetup.provider_requirements()
SpackSolverSetup.setup()
SpackSolverSetup.spec_clauses()
SpackSolverSetup.spec_versions()
SpackSolverSetup.target_defaults()
SpackSolverSetup.target_preferences()
SpackSolverSetup.target_ranges()
SpackSolverSetup.virtual_preferences()
SpackSolverSetup.virtual_providers()
SpecBuilder
SpecBuilder.build_specs()
SpecBuilder.depends_on()
SpecBuilder.deprecated()
SpecBuilder.external_spec_selected()
SpecBuilder.hash()
SpecBuilder.ignored_attributes
SpecBuilder.no_flags()
SpecBuilder.node()
SpecBuilder.node_compiler()
SpecBuilder.node_compiler_version()
SpecBuilder.node_flag()
SpecBuilder.node_flag_compiler_default()
SpecBuilder.node_flag_source()
SpecBuilder.node_os()
SpecBuilder.node_platform()
SpecBuilder.node_target()
SpecBuilder.reorder_flags()
SpecBuilder.sort_fn()
SpecBuilder.variant_value()
SpecBuilder.version()
UnsatisfiableSpecError
all_compilers_in_config()
ast_getter()
ast_sym()
ast_type()
bootstrap_clingo()
build_criteria_names()
build_priority_offset
check_packages_exist()
default_clingo_control()
extend_flag_list()
extract_args()
fixed_priority_offset
high_fixed_priority_offset
issequence()
listify()
packagize()
specify()
stringify()
version_origin_fields
version_origin_str
version_provenance
- spack.util package
- Subpackages
- Submodules
- spack.util.classes module
- spack.util.compression module
BZipFileType
CompressedFileTypeInterface
FileTypeInterface
GZipFileType
LzmaFileType
TarFileType
ZCompressedFileType
ZipFleType
allowed_archive()
check_and_remove_ext()
check_extension()
decompressor_for()
extension_from_file()
extension_from_path()
extension_from_stream()
is_bz2_supported()
is_gzip_supported()
is_lzma_supported()
reg_remove_ext()
strip_extension()
strip_last_extension()
- spack.util.cpus module
- spack.util.crypto module
- spack.util.debug module
- spack.util.editor module
- spack.util.elf module
ELF_CONSTANTS
ELF_CONSTANTS.CLASS32
ELF_CONSTANTS.CLASS64
ELF_CONSTANTS.DATA2LSB
ELF_CONSTANTS.DATA2MSB
ELF_CONSTANTS.DT_NEEDED
ELF_CONSTANTS.DT_NULL
ELF_CONSTANTS.DT_RPATH
ELF_CONSTANTS.DT_RUNPATH
ELF_CONSTANTS.DT_SONAME
ELF_CONSTANTS.DT_STRTAB
ELF_CONSTANTS.ET_DYN
ELF_CONSTANTS.ET_EXEC
ELF_CONSTANTS.MAGIC
ELF_CONSTANTS.PT_DYNAMIC
ELF_CONSTANTS.PT_INTERP
ELF_CONSTANTS.PT_LOAD
ELF_CONSTANTS.SHT_STRTAB
ElfDynamicSectionUpdateFailed
ElfFile
ElfFile.byte_order
ElfFile.dt_needed_strs
ElfFile.dt_needed_strtab_offsets
ElfFile.dt_rpath_offset
ElfFile.dt_rpath_str
ElfFile.dt_soname_str
ElfFile.dt_soname_strtab_offset
ElfFile.elf_hdr
ElfFile.has_needed
ElfFile.has_pt_dynamic
ElfFile.has_pt_interp
ElfFile.has_rpath
ElfFile.has_soname
ElfFile.is_64_bit
ElfFile.is_little_endian
ElfFile.is_runpath
ElfFile.pt_dynamic_p_filesz
ElfFile.pt_dynamic_p_offset
ElfFile.pt_dynamic_strtab_offset
ElfFile.pt_interp_p_filesz
ElfFile.pt_interp_p_offset
ElfFile.pt_interp_str
ElfFile.pt_load
ElfFile.rpath_strtab_offset
ElfHeader
ElfParsingError
ProgramHeader32
ProgramHeader64
SectionHeader
find_strtab_size_at_offset()
get_rpaths()
parse_c_string()
parse_elf()
parse_header()
parse_program_headers()
parse_pt_dynamic()
parse_pt_interp()
read_exactly()
replace_rpath_in_place_or_raise()
retrieve_strtab()
vaddr_to_offset()
- spack.util.environment module
AppendFlagsEnv
AppendPath
DeprioritizeSystemPaths
EnvironmentModifications
EnvironmentModifications.append_flags()
EnvironmentModifications.append_path()
EnvironmentModifications.apply_modifications()
EnvironmentModifications.clear()
EnvironmentModifications.deprioritize_system_paths()
EnvironmentModifications.extend()
EnvironmentModifications.from_environment_diff()
EnvironmentModifications.from_sourcing_file()
EnvironmentModifications.group_by_name()
EnvironmentModifications.is_unset()
EnvironmentModifications.prepend_path()
EnvironmentModifications.prune_duplicate_paths()
EnvironmentModifications.remove_flags()
EnvironmentModifications.remove_path()
EnvironmentModifications.reversed()
EnvironmentModifications.set()
EnvironmentModifications.set_path()
EnvironmentModifications.shell_modifications()
EnvironmentModifications.unset()
NameModifier
NameValueModifier
PrependPath
PruneDuplicatePaths
RemoveFlagsEnv
RemovePath
SetEnv
SetPath
UnsetEnv
concatenate_paths()
deprioritize_system_paths()
dump_environment()
env_flag()
env_var_to_source_line()
environment_after_sourcing_files()
filter_system_paths()
get_host_environment()
get_host_environment_metadata()
get_path()
inspect_path()
is_system_path()
path_put_first()
path_set()
pickle_environment()
preserve_environment()
prune_duplicate_paths()
sanitize()
set_env()
set_or_unset_not_first()
validate()
- spack.util.executable module
- spack.util.file_cache module
- spack.util.file_permissions module
- spack.util.gcs module
- spack.util.git module
- spack.util.gpg module
- spack.util.hash module
- spack.util.ld_so_conf module
- spack.util.lock module
- spack.util.log_parse module
- spack.util.module_cmd module
- spack.util.naming module
- spack.util.package_hash module
- spack.util.parallel module
- spack.util.path module
- spack.util.pattern module
- spack.util.prefix module
- spack.util.s3 module
- spack.util.spack_json module
- spack.util.spack_yaml module
- spack.util.string module
- spack.util.timer module
- spack.util.url module
- spack.util.web module
- spack.util.windows_registry module
Submodules¶
spack.abi module¶
- class spack.abi.ABI[source]¶
Bases:
object
This class provides methods to test ABI compatibility between specs. The current implementation is rather rough and could be improved.
- architecture_compatible(target, constraint)[source]¶
Return true if architecture of target spec is ABI compatible to the architecture of constraint spec. If either the target or constraint specs have no architecture, target is also defined as architecture ABI compatible to constraint.
spack.audit module¶
Classes and functions to register audit checks for various parts of Spack and run them on-demand.
To register a new class of sanity checks (e.g. sanity checks for compilers.yaml), the first action required is to create a new AuditClass object:
audit_cfgcmp = AuditClass(
tag='CFG-COMPILER',
description='Sanity checks on compilers.yaml',
kwargs=()
)
This object is to be used as a decorator to register functions that will perform each a single check:
@audit_cfgcmp
def _search_duplicate_compilers(error_cls):
pass
These functions need to take as argument the keywords declared when
creating the decorator object plus an error_cls
argument at the
end, acting as a factory to create Error objects. It should return a
(possibly empty) list of errors.
Calls to each of these functions are triggered by the run
method of
the decorator object, that will forward the keyword arguments passed
as input.
- spack.audit.CALLBACKS = {'CFG-COMPILER': <spack.audit.AuditClass object>, 'CFG-PACKAGES': <spack.audit.AuditClass object>, 'GENERIC': <spack.audit.AuditClass object>, 'PKG-ATTRIBUTES': <spack.audit.AuditClass object>, 'PKG-DIRECTIVES': <spack.audit.AuditClass object>, 'PKG-HTTPS-DIRECTIVES': <spack.audit.AuditClass object>, 'PKG-PROPERTIES': <spack.audit.AuditClass object>}¶
Map an audit tag to a list of callables implementing checks
- class spack.audit.Error(summary, details)[source]¶
Bases:
object
Information on an error reported in a test.
- spack.audit.GROUPS = {'configs': ['CFG-COMPILER', 'CFG-PACKAGES'], 'generic': ['GENERIC'], 'packages': ['PKG-DIRECTIVES', 'PKG-ATTRIBUTES', 'PKG-PROPERTIES'], 'packages-https': ['PKG-HTTPS-DIRECTIVES']}¶
Map a group of checks to the list of related audit tags
- spack.audit.config_compiler = <spack.audit.AuditClass object>¶
Sanity checks on compilers.yaml
- spack.audit.config_packages = <spack.audit.AuditClass object>¶
Sanity checks on packages.yaml
- spack.audit.generic = <spack.audit.AuditClass object>¶
Generic checks relying on global state
- spack.audit.package_directives = <spack.audit.AuditClass object>¶
Sanity checks on package directives
spack.binary_distribution module¶
- class spack.binary_distribution.BinaryCacheIndex(cache_root)[source]¶
Bases:
object
The BinaryCacheIndex tracks what specs are available on (usually remote) binary caches.
This index is “best effort”, in the sense that whenever we don’t find what we’re looking for here, we will attempt to fetch it directly from configured mirrors anyway. Thus, it has the potential to speed things up, but cache misses shouldn’t break any spack functionality.
At the moment, everything in this class is initialized as lazily as possible, so that it avoids slowing anything in spack down until absolutely necessary.
TODO: What’s the cost if, e.g., we realize in the middle of a spack install that the cache is out of date, and we fetch directly? Does it mean we should have paid the price to update the cache earlier?
- clear()[source]¶
For testing purposes we need to be able to empty the cache and clear associated data structures.
- find_built_spec(spec, mirrors_to_check=None)[source]¶
Look in our cache for the built spec corresponding to
spec
.If the spec can be found among the configured binary mirrors, a list is returned that contains the concrete spec and the mirror url of each mirror where it can be found. Otherwise,
None
is returned.This method does not trigger reading anything from remote mirrors, but rather just checks if the concrete spec is found within the cache.
The cache can be updated by calling
update()
on the cache.- Parameters
spec (spack.spec.Spec) – Concrete spec to find
mirrors_to_check – Optional mapping containing mirrors to check. If None, just assumes all configured mirrors.
- Returns
- An list of objects containing the found specs and mirror url where
each can be found, e.g.:
[ { "spec": <concrete-spec>, "mirror_url": <mirror-root-url> } ]
- find_by_hash(find_hash, mirrors_to_check=None)[source]¶
Same as find_built_spec but uses the hash of a spec.
- Parameters
find_hash (str) – hash of the spec to search
mirrors_to_check – Optional mapping containing mirrors to check. If None, just assumes all configured mirrors.
- regenerate_spec_cache(clear_existing=False)[source]¶
Populate the local cache of concrete specs (
_mirrors_for_spec
) from the locally cached buildcache index files. This is essentially a no-op if it has already been done, as we keep track of the index hashes for which we have already associated the built specs.
- update(with_cooldown=False)[source]¶
Make sure local cache of buildcache index files is up to date. If the same mirrors are configured as the last time this was called and none of the remote buildcache indices have changed, calling this method will only result in fetching the index hash from each mirror to confirm it is the same as what is stored locally. Otherwise, the buildcache
index.json
andindex.json.hash
files are retrieved from each configured mirror and stored locally (both in memory and on disk under_index_cache_root
).
- class spack.binary_distribution.BinaryCacheQuery(all_architectures)[source]¶
Bases:
object
Callable object to query if a spec is in a binary cache
- class spack.binary_distribution.BuildManifestVisitor[source]¶
Bases:
BaseDirectoryVisitor
Visitor that collects a list of files and symlinks that can be checked for need of relocation. It knows how to dedupe hardlinks and deal with symlinks to files and directories.
- before_visit_dir(root, rel_path, depth)[source]¶
Return True from this function to recurse into the directory at os.path.join(root, rel_path). Return False in order not to recurse further.
- before_visit_symlinked_dir(root, rel_path, depth)[source]¶
Return
True
to recurse into the symlinked directory andFalse
in order not to. Note:rel_path
is the path to the symlink itself. Following symlinked directories blindly can cause infinite recursion due to cycles.
- visit_file(root, rel_path, depth)[source]¶
Handle the non-symlink file at
os.path.join(root, rel_path)
- class spack.binary_distribution.DefaultIndexFetcher(url, local_hash, urlopen=<function _urlopen.<locals>.dispatch_open>)[source]¶
Bases:
object
Fetcher for index.json, using separate index.json.hash as cache invalidation strategy
- class spack.binary_distribution.EtagIndexFetcher(url, etag, urlopen=<function _urlopen.<locals>.dispatch_open>)[source]¶
Bases:
object
Fetcher for index.json, using ETags headers as cache invalidation strategy
- exception spack.binary_distribution.FetchCacheError(errors)[source]¶
Bases:
Exception
Error thrown when fetching the cache failed, usually a composite error list.
- class spack.binary_distribution.FetchIndexResult(etag, hash, data, fresh)¶
Bases:
tuple
- property data¶
Alias for field number 2
- property etag¶
Alias for field number 0
- property fresh¶
Alias for field number 3
- property hash¶
Alias for field number 1
- exception spack.binary_distribution.ListMirrorSpecsError(message, long_message=None)[source]¶
Bases:
SpackError
Raised when unable to retrieve list of specs from the mirror
- exception spack.binary_distribution.NewLayoutException(msg)[source]¶
Bases:
SpackError
Raised if directory layout is different from buildcache.
- exception spack.binary_distribution.NoChecksumException(message, long_message=None)[source]¶
Bases:
SpackError
Raised if file fails checksum verification.
- exception spack.binary_distribution.NoGpgException(msg)[source]¶
Bases:
SpackError
Raised when gpg2 is not in PATH
- exception spack.binary_distribution.NoKeyException(msg)[source]¶
Bases:
SpackError
Raised when gpg has no default key added.
- exception spack.binary_distribution.NoOverwriteException(file_path)[source]¶
Bases:
SpackError
Raised when a file exists and must be overwritten.
- exception spack.binary_distribution.NoVerifyException(message, long_message=None)[source]¶
Bases:
SpackError
Raised if file fails signature verification.
- exception spack.binary_distribution.PickKeyException(keys)[source]¶
Bases:
SpackError
Raised when multiple keys can be used to sign.
- exception spack.binary_distribution.UnsignedPackageException(message, long_message=None)[source]¶
Bases:
SpackError
Raised if installation of unsigned package is attempted without the use of
--no-check-signature
.
- spack.binary_distribution.binary_index = <spack.binary_distribution.BinaryCacheIndex object>¶
Singleton binary_index instance