fab package

Flexible build system for scientific software.

exception fab.FabException

Bases: Exception

Subpackages

• fab.parse package
  • ParseException
  • AnalysedFile
    • AnalysedFile.file_hash
    • AnalysedFile.to_dict()
    • AnalysedFile.from_dict()
    • AnalysedFile.save()
    • AnalysedFile.load()
    • AnalysedFile.field_names()
  • EmptySourceFile
    • EmptySourceFile.from_dict()
  • Submodules
    • fab.parse.c module
      • AnalysedC
      • CAnalyser
        • CAnalyser.run()
    • fab.parse.fortran module
      • AnalysedFortran
        • AnalysedFortran.add_program_def()
        • AnalysedFortran.add_module_def()
        • AnalysedFortran.add_module_dep()
        • AnalysedFortran.mod_filenames
        • AnalysedFortran.field_names()
        • AnalysedFortran.to_dict()
        • AnalysedFortran.from_dict()
        • AnalysedFortran.validate()
      • FortranAnalyser
        • FortranAnalyser.walk_nodes()
      • FortranParserWorkaround
        • FortranParserWorkaround.as_analysed_fortran()
    • fab.parse.fortran_common module
      • iter_content()
      • FortranAnalyserBase
        • FortranAnalyserBase.run()
        • FortranAnalyserBase.walk_nodes()
    • fab.parse.x90 module
      • AnalysedX90
        • AnalysedX90.to_dict()
        • AnalysedX90.from_dict()
        • AnalysedX90.field_names()
      • X90Analyser
        • X90Analyser.walk_nodes()
• fab.steps package
  • step()
  • run_mp()
  • run_mp_imap()
  • check_for_errors()
  • Subpackages
    • fab.steps.grab package
      • Submodules
        • fab.steps.grab.archive module
        • fab.steps.grab.fcm module
        • fab.steps.grab.folder module
        • fab.steps.grab.git module
        • fab.steps.grab.prebuild module
        • fab.steps.grab.svn module
  • Submodules
    • fab.steps.analyse module
      • analyse()
    • fab.steps.archive_objects module
      • archive_objects()
    • fab.steps.c_pragma_injector module
      • c_pragma_injector()
      • inject_pragmas()
    • fab.steps.cleanup_prebuilds module
      • cleanup_prebuilds()
      • by_age()
      • by_version_age()
      • remove_all_unused()
      • get_access_time()
    • fab.steps.compile_c module
      • MpCommonArgs
        • MpCommonArgs.config
        • MpCommonArgs.flags
      • compile_c()
      • store_artefacts()
    • fab.steps.compile_fortran module
      • MpCommonArgs
        • MpCommonArgs.config
        • MpCommonArgs.flags
        • MpCommonArgs.mod_hashes
        • MpCommonArgs.syntax_only
      • compile_fortran()
      • handle_compiler_args()
      • compile_pass()
      • get_compile_next()
      • store_artefacts()
      • process_file()
      • compile_file()
      • get_mod_hashes()
    • fab.steps.find_source_files module
      • Include
      • Exclude
      • find_source_files()
    • fab.steps.link module
      • DefaultLinkerSource
      • link_exe()
      • link_shared_object()
    • fab.steps.preprocess module
      • MpCommonArgs
        • MpCommonArgs.config
        • MpCommonArgs.output_suffix
        • MpCommonArgs.preprocessor
        • MpCommonArgs.flags
        • MpCommonArgs.name
      • pre_processor()
      • process_artefact()
      • preprocess_fortran()
      • DefaultCPreprocessorSource
      • preprocess_c()
    • fab.steps.psyclone module
      • preprocess_x90()
      • MpCommonArgs
        • MpCommonArgs.config
        • MpCommonArgs.analysed_x90
        • MpCommonArgs.kernel_roots
        • MpCommonArgs.transformation_script
        • MpCommonArgs.cli_args
        • MpCommonArgs.api
        • MpCommonArgs.all_kernel_hashes
        • MpCommonArgs.overrides_folder
        • MpCommonArgs.override_files
      • psyclone()
      • do_one_file()
      • make_parsable_x90()
    • fab.steps.root_inc_files module
      • root_inc_files()
• fab.tools package
  • Ar
    • Ar.create()
  • Category
    • Category.C_COMPILER
    • Category.C_PREPROCESSOR
    • Category.FORTRAN_COMPILER
    • Category.FORTRAN_PREPROCESSOR
    • Category.LINKER
    • Category.PSYCLONE
    • Category.FCM
    • Category.GIT
    • Category.SUBVERSION
    • Category.AR
    • Category.RSYNC
    • Category.MISC
    • Category.is_compiler
  • CCompiler
  • Compiler
    • Compiler.get_hash()
    • Compiler.openmp
    • Compiler.openmp_flag
    • Compiler.compile_file()
    • Compiler.check_available()
    • Compiler.get_version()
    • Compiler.run_version_command()
    • Compiler.parse_version_output()
    • Compiler.get_version_string()
  • CompilerSuiteTool
    • CompilerSuiteTool.suite
    • CompilerSuiteTool.mpi
  • Cpp
  • CppFortran
  • Fcm
  • Flags
    • Flags.checksum()
    • Flags.remove_flag()
  • FortranCompiler
    • FortranCompiler.has_syntax_only
    • FortranCompiler.set_module_output_path()
    • FortranCompiler.compile_file()
  • Fpp
  • Gcc
  • Gfortran
  • Git
    • Git.current_commit()
    • Git.init()
    • Git.clean()
    • Git.fetch()
    • Git.checkout()
    • Git.merge()
  • GnuVersionHandling
    • GnuVersionHandling.parse_version_output()
  • Icc
  • Ifort
  • IntelVersionHandling
    • IntelVersionHandling.parse_version_output()
  • Linker
    • Linker.check_available()
    • Linker.link()
  • MpiGcc
  • MpiGfortran
  • MpiIcc
  • MpiIfort
  • Preprocessor
    • Preprocessor.preprocess()
  • Psyclone
    • Psyclone.process()
  • Rsync
    • Rsync.execute()
  • Subversion
    • Subversion.execute()
    • Subversion.export()
    • Subversion.checkout()
    • Subversion.update()
    • Subversion.merge()
  • Tool
    • Tool.check_available()
    • Tool.is_available
    • Tool.is_compiler
    • Tool.exec_name
    • Tool.name
    • Tool.category
    • Tool.flags
    • Tool.logger
    • Tool.run()
  • ToolBox
    • ToolBox.add_tool()
    • ToolBox.get_tool()
  • ToolRepository
    • ToolRepository.add_tool()
    • ToolRepository.get_tool()
    • ToolRepository.set_default_compiler_suite()
    • ToolRepository.get_default()
  • Versioning
  • Submodules
    • fab.tools.ar module
      • Ar
        • Ar.create()
    • fab.tools.category module
      • Category
        • Category.C_COMPILER
        • Category.C_PREPROCESSOR
        • Category.FORTRAN_COMPILER
        • Category.FORTRAN_PREPROCESSOR
        • Category.LINKER
        • Category.PSYCLONE
        • Category.FCM
        • Category.GIT
        • Category.SUBVERSION
        • Category.AR
        • Category.RSYNC
        • Category.MISC
        • Category.is_compiler
    • fab.tools.compiler module
      • Compiler
        • Compiler.get_hash()
        • Compiler.openmp
        • Compiler.openmp_flag
        • Compiler.compile_file()
        • Compiler.check_available()
        • Compiler.get_version()
        • Compiler.run_version_command()
        • Compiler.parse_version_output()
        • Compiler.get_version_string()
      • CCompiler
      • FortranCompiler
        • FortranCompiler.has_syntax_only
        • FortranCompiler.set_module_output_path()
        • FortranCompiler.compile_file()
      • GnuVersionHandling
        • GnuVersionHandling.parse_version_output()
      • Gcc
      • MpiGcc
      • Gfortran
      • MpiGfortran
      • IntelVersionHandling
        • IntelVersionHandling.parse_version_output()
      • Icc
      • MpiIcc
      • Ifort
      • MpiIfort
    • fab.tools.flags module
      • Flags
        • Flags.checksum()
        • Flags.remove_flag()
    • fab.tools.linker module
      • Linker
        • Linker.check_available()
        • Linker.link()
    • fab.tools.preprocessor module
      • Preprocessor
        • Preprocessor.preprocess()
      • Cpp
      • CppFortran
      • Fpp
    • fab.tools.psyclone module
      • Psyclone
        • Psyclone.process()
    • fab.tools.rsync module
      • Rsync
        • Rsync.execute()
    • fab.tools.tool module
      • Tool
        • Tool.check_available()
        • Tool.is_available
        • Tool.is_compiler
        • Tool.exec_name
        • Tool.name
        • Tool.category
        • Tool.flags
        • Tool.logger
        • Tool.run()
      • CompilerSuiteTool
        • CompilerSuiteTool.suite
        • CompilerSuiteTool.mpi
    • fab.tools.tool_box module
      • ToolBox
        • ToolBox.add_tool()
        • ToolBox.get_tool()
    • fab.tools.tool_repository module
      • ToolRepository
        • ToolRepository.add_tool()
        • ToolRepository.get_tool()
        • ToolRepository.set_default_compiler_suite()
        • ToolRepository.get_default()
    • fab.tools.versioning module
      • Versioning
      • Git
        • Git.current_commit()
        • Git.init()
        • Git.clean()
        • Git.fetch()
        • Git.checkout()
        • Git.merge()
      • Subversion
        • Subversion.execute()
        • Subversion.export()
        • Subversion.checkout()
        • Subversion.update()
        • Subversion.merge()
      • Fcm

Submodules

• fab.artefacts module
  • ArtefactSet
    • ArtefactSet.INITIAL_SOURCE
    • ArtefactSet.PREPROCESSED_FORTRAN
    • ArtefactSet.PREPROCESSED_C
    • ArtefactSet.FORTRAN_BUILD_FILES
    • ArtefactSet.C_BUILD_FILES
    • ArtefactSet.X90_BUILD_FILES
    • ArtefactSet.CURRENT_PREBUILDS
    • ArtefactSet.PRAGMAD_C
    • ArtefactSet.BUILD_TREES
    • ArtefactSet.OBJECT_FILES
    • ArtefactSet.OBJECT_ARCHIVES
    • ArtefactSet.EXECUTABLES
  • ArtefactStore
    • ArtefactStore.reset()
    • ArtefactStore.add()
    • ArtefactStore.update_dict()
    • ArtefactStore.copy_artefacts()
    • ArtefactStore.replace()
  • ArtefactsGetter
  • CollectionGetter
  • CollectionConcat
  • SuffixFilter
  • FilterBuildTrees
• fab.build_config module
  • BuildConfig
    • BuildConfig.tool_box
    • BuildConfig.artefact_store
    • BuildConfig.build_output
    • BuildConfig.mpi
    • BuildConfig.openmp
    • BuildConfig.add_current_prebuilds()
  • AddFlags
    • AddFlags.run()
  • FlagsConfig
    • FlagsConfig.flags_for_path()
• fab.cli module
  • cli_fab()
• fab.constants module
• fab.dep_tree module
  • AnalysedDependent
    • AnalysedDependent.add_symbol_def()
    • AnalysedDependent.add_symbol_dep()
    • AnalysedDependent.add_file_dep()
    • AnalysedDependent.field_names()
    • AnalysedDependent.to_dict()
    • AnalysedDependent.from_dict()
  • extract_sub_tree()
  • filter_source_tree()
  • validate_dependencies()
• fab.metrics module
  • init_metrics()
  • send_metric()
  • stop_metrics()
  • metrics_summary()
• fab.mo module
  • add_mo_commented_file_deps()
• fab.util module
  • log_or_dot()
  • log_or_dot_finish()
  • HashedFile
    • HashedFile.file_hash
    • HashedFile.fpath
  • file_checksum()
  • string_checksum()
  • file_walk()
  • Timer
  • TimerLogger
  • CompiledFile
  • input_to_output_fpath()
  • suffix_filter()
  • by_type()
  • get_fab_workspace()
  • get_prebuild_file_groups()
  • common_arg_parser()