Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/version-specific/config-file-constants.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Constants available (only) in configuration files {: #avail_cfgfile_constants }

### Only in 'DEFAULT' section:
## Only in 'DEFAULT' section:

Constant name |Constant help |Constant value
--------------------------|---------------------------------------------------|-------------------------------------------------------------------
Expand Down
3 changes: 1 addition & 2 deletions docs/version-specific/easyconfig-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ Template name |Template value
``%(rshortver)s`` |short version for R (<major>.<minor>)
``%(rver)s`` |full version for R

Template names/values as set in easyconfig
------------------------------------------
## Template names/values as set in easyconfig

* ``%(bitbucket_account)s``
* ``%(github_account)s``
Expand Down
1 change: 1 addition & 0 deletions docs/version-specific/eb-list-toolchains.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ Name |Compiler(s) |MPI |Linear algebra |FFT
**iqacml** |icc, ifort |QLogicMPI |ACML, ScaLAPACK |FFTW
**ismkl** |icc, ifort |MPICH2 |imkl |imkl
**NVHPC** |NVHPC |*(none)* |*(none)* |*(none)*
**nvofbf** |NVHPC |OpenMPI |FlexiBLAS, ScaLAPACK |FFTW
**nvompi** |NVHPC |OpenMPI |*(none)* |*(none)*
**nvompic** |NVHPC |OpenMPI |*(none)* |*(none)*
**nvpsmpi** |NVHPC |psmpi |*(none)* |*(none)*
Expand Down
60 changes: 31 additions & 29 deletions docs/version-specific/generic-easyblocks.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

## ``BinariesTarball``

(derives from <a href='#tarball'>``Tarball``</a>)
(derives from [``Tarball``](#tarball))


Support for installing a tarball of binaries
Expand Down Expand Up @@ -85,7 +85,7 @@ moduleclass = 'bio'

## ``BuildEnv``

(derives from <a href='#bundle'>``Bundle``</a>)
(derives from [``Bundle``](#bundle))


Build environment of toolchain: only generate module file
Expand Down Expand Up @@ -157,7 +157,7 @@ moduleclass = 'devel'

## ``CMakeMake``

(derives from <a href='#configuremake'>``ConfigureMake``</a>)
(derives from [``ConfigureMake``](#configuremake))

Support for configuring build with CMake instead of traditional configure script

Expand Down Expand Up @@ -229,7 +229,7 @@ moduleclass = 'data'

## ``CMakeMakeCp``

(derives from <a href='#cmakemake'>``CMakeMake``</a>, <a href='#makecp'>``MakeCp``</a>)
(derives from [``CMakeMake``](#cmakemake), [``MakeCp``](#makecp))

Software configured with CMake but without 'make install' step

Expand Down Expand Up @@ -270,7 +270,7 @@ easyconfig parameter |description

## ``CMakeNinja``

(derives from <a href='#cmakemake'>``CMakeMake``</a>, <a href='#mesonninja'>``MesonNinja``</a>)
(derives from [``CMakeMake``](#cmakemake), [``MesonNinja``](#mesonninja))

Support for configuring with CMake, building and installing with MesonNinja.

Expand Down Expand Up @@ -308,7 +308,7 @@ easyconfig parameter |description

## ``CMakePythonPackage``

(derives from <a href='#cmakemake'>``CMakeMake``</a>, <a href='#pythonpackage'>``PythonPackage``</a>)
(derives from [``CMakeMake``](#cmakemake), [``PythonPackage``](#pythonpackage))

Build a Python package and module with cmake.

Expand Down Expand Up @@ -372,7 +372,7 @@ easyconfig parameter |description

## ``CmdCp``

(derives from <a href='#makecp'>``MakeCp``</a>)
(derives from [``MakeCp``](#makecp))


Software with no configure, no make, and no make install step.
Expand Down Expand Up @@ -409,7 +409,7 @@ easyconfig parameter |description

## ``Conda``

(derives from <a href='#binary'>``Binary``</a>)
(derives from [``Binary``](#binary))

Support for installing software using 'conda'.

Expand Down Expand Up @@ -502,12 +502,13 @@ moduleclass = 'tools'

## ``ConfigureMakePythonPackage``

(derives from <a href='#configuremake'>``ConfigureMake``</a>, <a href='#pythonpackage'>``PythonPackage``</a>)
(derives from [``ConfigureMake``](#configuremake), [``PythonPackage``](#pythonpackage))


Build a Python package and module with 'python configure/make/make install'.
Build a Python package and module with ``python configure``/``make``/``make install``.

Implemented by using:

- a custom implementation of configure_step
- using the build_step and install_step from ConfigureMake
- using the sanity_check_step and make_module_extra from PythonPackage
Expand Down Expand Up @@ -552,11 +553,11 @@ easyconfig parameter |description

### Customised steps in ``ConfigureMakePythonPackage`` easyblock

* ``build_step`` - Build Python package with 'make'.
* ``build_step`` - Build Python package with ``make``.

* ``configure_step`` - Configure build using 'python configure'.
* ``configure_step`` - Configure build using ``python configure``.

* ``install_step`` - Install with 'make install'.
* ``install_step`` - Install with ``make install``.


### Example easyconfig for ``ConfigureMakePythonPackage`` easyblock
Expand Down Expand Up @@ -596,7 +597,7 @@ moduleclass = 'vis'

## ``CrayToolchain``

(derives from <a href='#bundle'>``Bundle``</a>)
(derives from [``Bundle``](#bundle))


Compiler toolchain: generate module file only, nothing to build/install
Expand All @@ -616,7 +617,7 @@ easyconfig parameter |description

## ``FortranPythonPackage``

(derives from <a href='#pythonpackage'>``PythonPackage``</a>)
(derives from [``PythonPackage``](#pythonpackage))

Extends PythonPackage to add a Fortran compiler to the make call

Expand Down Expand Up @@ -683,6 +684,7 @@ easyconfig parameter|description


Base class for Intel software

- no configure/make : binary release
- add license_file variable

Expand All @@ -709,7 +711,7 @@ easyconfig parameter |description

## ``JAR``

(derives from <a href='#binary'>``Binary``</a>)
(derives from [``Binary``](#binary))

Support for installing JAR files.

Expand All @@ -724,7 +726,7 @@ easyconfig parameter|description

## ``JuliaBundle``

(derives from <a href='#bundle'>``Bundle``</a>)
(derives from [``Bundle``](#bundle))


Bundle of JuliaPackages: install Julia packages as extensions in a bundle
Expand Down Expand Up @@ -769,7 +771,7 @@ easyconfig parameter |description

## ``MakeCp``

(derives from <a href='#configuremake'>``ConfigureMake``</a>)
(derives from [``ConfigureMake``](#configuremake))


Software with no configure and no make install step.
Expand Down Expand Up @@ -880,7 +882,7 @@ easyconfig parameter|description |default value

## ``PackedBinary``

(derives from <a href='#binary'>``Binary``</a>, ``EasyBlock``)
(derives from [``Binary``](#binary), ``EasyBlock``)

Support for installing packed binary software.
Just unpack the sources in the install dir
Expand All @@ -902,7 +904,7 @@ easyconfig parameter|description

## ``PerlModule``

(derives from ``ExtensionEasyBlock``, <a href='#configuremake'>``ConfigureMake``</a>)
(derives from ``ExtensionEasyBlock``, [``ConfigureMake``](#configuremake))

Builds and installs a Perl module, and can provide a dedicated module file.

Expand All @@ -924,7 +926,7 @@ easyconfig parameter|description |default value

## ``PythonBundle``

(derives from <a href='#bundle'>``Bundle``</a>)
(derives from [``Bundle``](#bundle))


Bundle of PythonPackages: install Python packages as extensions in a bundle
Expand Down Expand Up @@ -1032,10 +1034,11 @@ easyconfig parameter|description |de

## ``Rpm``

(derives from <a href='#binary'>``Binary``</a>)
(derives from [``Binary``](#binary))


Support for installing RPM files.

- sources is a list of rpms
- installation is with --nodeps (so the sources list has to be complete)

Expand Down Expand Up @@ -1105,7 +1108,7 @@ easyconfig parameter|description |default value

## ``SystemCompiler``

(derives from <a href='#bundle'>``Bundle``</a>, ``EB_GCC``, ``EB_ifort``)
(derives from [``Bundle``](#bundle), ``EB_GCC``, ``EB_ifort``)


Support for generating a module file for the system compiler with specified name.
Expand Down Expand Up @@ -1162,7 +1165,7 @@ easyconfig parameter |description

## ``SystemMPI``

(derives from <a href='#bundle'>``Bundle``</a>, <a href='#configuremake'>``ConfigureMake``</a>, ``EB_impi``)
(derives from [``Bundle``](#bundle), [``ConfigureMake``](#configuremake), ``EB_impi``)


Support for generating a module file for the system mpi with specified name.
Expand Down Expand Up @@ -1214,8 +1217,7 @@ easyconfig parameter |description
(derives from ``ExtensionEasyBlock``)


Precompiled software supplied as a tarball:
- will unpack binary and copy it to the install dir
Precompiled software supplied as a tarball: will unpack binary and copy it to the install dir


### Extra easyconfig parameters specific to ``Tarball`` easyblock
Expand All @@ -1237,7 +1239,7 @@ easyconfig parameter|description

## ``Toolchain``

(derives from <a href='#bundle'>``Bundle``</a>)
(derives from [``Bundle``](#bundle))

Compiler toolchain easyblock: nothing to install, just generate module file.

Expand All @@ -1256,7 +1258,7 @@ easyconfig parameter |description

## ``VSCPythonPackage``

(derives from <a href='#versionindependentpythonpackage'>``VersionIndependentPythonPackage``</a>)
(derives from [``VersionIndependentPythonPackage``](#versionindependentpythonpackage))

Support for install VSC Python packages.

Expand Down Expand Up @@ -1288,7 +1290,7 @@ easyconfig parameter |description

## ``VersionIndependentPythonPackage``

(derives from <a href='#pythonpackage'>``PythonPackage``</a>)
(derives from [``PythonPackage``](#pythonpackage))

Support for building/installing python packages without requiring a specific python package.

Expand Down
Loading