package.py

Go to the documentation of this file.

# Copyright (c) 2022 [Authors](http://mofem.eng.gla.ac.uk/mofem/html/authors.html)
#  
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#  
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#  
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#  
# [MIT License](https://opensource.org/licenses/MIT)#
 
 
from spack import *
 
 
class MofemMixedFractureModule(CMakePackage):
    """mofem fracture module"""
 
    homepage = "http://mofem.eng.gla.ac.uk"
    git = "https://bitbucket.org/mofem/um_eshelbian_plasticity.git"
 
    maintainers = ['likask','CallumRuncie']
 
    # Development versions
    version('main', branch='main')
    version('develop', branch='develop')
    version('lukasz', branch='lukasz/develop')
    # Versions
    version('0.15.6', branch='Version0.15.6')
    version('0.15.5', branch='Version0.15.5')
    version('0.15.4', branch='Version0.15.4')
    version('0.15.3', branch='Version0.15.3')
    version('0.15.2', branch='Version0.15.2')
    version('0.15.1', branch='Version0.15.1')
    version('0.15.0', branch='Version0.15.0')
 
    variant('copy_user_modules', default=True,
        description='Copy user modules directory instead linking')
 
    extends('mofem-cephas')
 
    depends_on('mofem-cephas@main', when='@main')
    depends_on('mofem-cephas@develop', when='@develop')
    depends_on('mofem-cephas@lukasz', when='@lukasz')
    
    depends_on('mofem-cephas@0.15.5:', when='@0.15.6')
    depends_on('mofem-cephas@0.15.4:', when='@0.15.5')
    depends_on('mofem-cephas@0.15.3:', when='@0.15.4')
    depends_on('mofem-cephas@0.15.2:', when='@0.15.3')
    depends_on('mofem-cephas@0.15.1:', when='@0.15.2')
    depends_on('mofem-cephas@0.15.0:', when='@0.15.1')
 
    def setup_build_environment(self, env):
        env.set('CTEST_OUTPUT_ON_FAILURE', '1')
 
    # The CMakeLists.txt installed with mofem-cephas package set cmake
    # environment to install extension from extension repository. It searches
    # for modules in user provides paths, for example in Spack source path.Also
    # it finds all cmake exported targets installed in lib directory, which are
    # built with dependent extensions, f.e. mofem - users - modules or others if
    # needed.
    @property
    def root_cmakelists_dir(self):
        """The relative path to the directory containing CMakeLists.txt
 
        This path is relative to the root of the extracted tarball,
        not to the ``build_directory``. Defaults to the current directory.
 
        :return: directory containing CMakeLists.txt
        """
        spec = self.spec
        return spec['mofem-cephas'].prefix.include.cmake.users_modules
 
    @property
    def build_directory(self):
        spec = self.spec
        build_type = spec.variants['build_type'].value
        build_dir = 'users_modules/eshelbian_plasticity'
        return join_path(self.stage.path, build_dir)
 
    def cmake_args(self):
        spec = self.spec
        from_variant = self.define_from_variant
 
        options = []
 
        # obligatory options
        options.extend([
            '-DCMAKE_EXPORT_COMPILE_COMMANDS=ON',
            '-DMPI_RUN_FLAGS=--allow-run-as-root',
            '-DWITH_SPACK=YES'])
        options.append(self.define(
            'MOFEM_DIR', spec['mofem-cephas'].prefix))
        options.append(self.define(
            'EXTERNAL_MODULE_SOURCE_DIRS', self.stage.source_path))
 
        # build tests
        options.append(self.define('MOFEM_UM_BUILD_TESTS', self.run_tests))
 
        return options
 
    # This function is not needed to run code installed by extension, nor in
    # the install process. However, for users like to have access to source
    # code to play, change and make it. Having source code at hand one can
    # compile in own build directory it in package view when the extension is
    # activated.
    @run_after('install')
    def copy_source_code(self):
        source = self.stage.source_path
        prefix = self.prefix
        install_tree(source, prefix.ext_users_modules.mixed_fracture_module)
 
    def check(self):
        """Searches the CMake-generated Makefile for the target ``test``
        and runs it if found.
        """
        with working_dir(self.build_directorybuild_directory):
            ctest('-L', 'short', '--output-on-failure', parallel=False)