package.MofemUsersModules Class Reference

Inheritance diagram for package.MofemUsersModules:

Collaboration diagram for package.MofemUsersModules:

Public Member Functions
	setup_build_environment (self, env)
	build_directory (self)
	cmake_args (self)
	copy_source_code (self)
	check (self)

Public Attributes
	build_directory

Static Public Attributes
str	homepage = "http://mofem.eng.gla.ac.uk"
str	git = "https://likask@bitbucket.org/mofem/users-modules-cephas.git"
	branch
	tag
	commit
list	maintainers = ['likask']
	default
	description
	False
	when
	True

Detailed Description

MofemUsersModules creates installation environment for user-provided
modules and extends of mofem-cephas package. For more information how to
work with Spack and MoFEM see
http://mofem.eng.gla.ac.uk/mofem/html/install_spack.html

Definition at line 10 of file package.py.

Member Function Documentation

build_directory()

package.MofemUsersModules.build_directory

(

self

)

Definition at line 144 of file package.py.

    def build_directory(self):
        spec = self.spec
        build_type = spec.variants['build_type'].value
        build_dir = 'um-build-%s-%s' % (build_type,spec.dag_hash(7))
        if '+docker' in spec:
          return join_path('/mofem_install',build_dir)
        else:
          return join_path(self.stage.path, build_dir)
 

check()

package.MofemUsersModules.check

(

self

)

Searches the CMake-generated Makefile for the target ``test``
and runs it if found.

Definition at line 201 of file package.py.

    def check(self):
        """Searches the CMake-generated Makefile for the target ``test``
        and runs it if found.
        """
        with working_dir(self.build_directory):
            ctest(parallel=False)

cmake_args()

package.MofemUsersModules.cmake_args

(

self

)

Definition at line 153 of file package.py.

    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.users_module))
        options.append(self.define_from_variant(
            'STAND_ALLONE_USERS_MODULES', 'copy_user_modules'))
        options.append(
            self.define_from_variant('BUILD_SHARED_LIBS', 'shared'))
        
        options.append(
            from_variant('BUILD_BASIC_FINITE_ELEMENTS', 'basic_fe'))
        options.append(
            from_variant('BUILD_TUTORIALS', 'basic_tutorials'))
        
        for name, v in spec.variants.items():
            if (name.startswith('build_tut_')):
                if '+basic_tutorials' in spec:
                    options.append(
                        from_variant(name.upper(), name))
                else:
                    options.append(
                        from_variant(name.upper(), 'basic_tutorials'))
                
 
        return options
 

copy_source_code()

package.MofemUsersModules.copy_source_code

(

self

)

Definition at line 196 of file package.py.

    def copy_source_code(self):
        source = self.stage.source_path
        prefix = self.prefix
        install_tree(source, prefix.users_modules)
 

setup_build_environment()

package.MofemUsersModules.setup_build_environment	(		self,
			env
	)

Definition at line 140 of file package.py.

    def setup_build_environment(self, env):
        env.set('CTEST_OUTPUT_ON_FAILURE', '1')
 

Member Data Documentation

branch

package.MofemUsersModules.branch

static

Definition at line 19 of file package.py.

build_directory

package.MofemUsersModules.build_directory

Definition at line 205 of file package.py.

commit

package.MofemUsersModules.commit

static

Definition at line 36 of file package.py.

default

package.MofemUsersModules.default

static

Definition at line 54 of file package.py.

description

package.MofemUsersModules.description

static

Definition at line 55 of file package.py.

False

package.MofemUsersModules.False

static

Definition at line 58 of file package.py.

git

str package.MofemUsersModules.git = "https://likask@bitbucket.org/mofem/users-modules-cephas.git"

static

Definition at line 17 of file package.py.

homepage

str package.MofemUsersModules.homepage = "http://mofem.eng.gla.ac.uk"

static

Definition at line 16 of file package.py.

maintainers

list package.MofemUsersModules.maintainers = ['likask']

static

Definition at line 52 of file package.py.

tag

package.MofemUsersModules.tag

static

Definition at line 35 of file package.py.

True

package.MofemUsersModules.True

static

Definition at line 97 of file package.py.

when

package.MofemUsersModules.when

static

Definition at line 62 of file package.py.

---

The documentation for this class was generated from the following file:

• /home/lk58p/mofem_install/vanilla_dev_release/mofem-cephas/packages/mofem-users-modules/package.py