EasyBuild documentation¶
Welcome to the documentation of EasyBuild, a software build and installation framework that allows you to manage (scientific) software on High Performance Computing (HPC) systems in an efficient way.
This documentation is intended for EasyBuild version 2.6.0, and was last rebuilt on Sun, 13 Mar 2016 16:18:04.
Introductory topics¶
Getting started¶
Basic usage topics¶
- Using the EasyBuild command line
- Specifying builds
- Commonly used command line options
- Command line help,
--help/-H - Report version,
--version - List of known toolchains,
--list-toolchains - List of available easyblocks,
--list-easyblocks - All available easyconfig parameters,
--avail-easyconfig-params/-a - Enable debug logging,
--debug/-d - Forced reinstallation,
--force/-f - Searching for easyconfigs,
--search/-S - Enabling dependency resolution,
--robot/-rand--robot-paths - Get an overview of planned installations
--dry-run/-D - Tweaking existing easyconfig files, using
--try-*
- Command line help,
- Writing easyconfig files: the basics
- Understanding EasyBuild logs
Advanced usage topics¶
- Controlling compiler optimization flags
- Experimental features
- Extended dry run
- Important notes
- Overview of dry run mechanism
- Temporary directories as build/install directories
- No downloading of missing source files/patches
- Checksum verification is skipped
- Source files are not unpacked
- Patch files are not applied, no runtime patching
- Module
loadstatements are executed or simulated - Build environment is reported
- Shell commands are not executed
- Sanity check paths/commands are not checked
- Module file is incomplete and only printed
- Guidelines for easyblocks
- Example output
- Including additional Python modules (
--include-*) - Integration with GitHub
- Manipulating dependencies
- Packaging support
- Partial installations
- Submitting jobs using
--job- Quick introduction to
--job - Configuring
--job- Selecting the job backend (
--job-backend) - Configuring the job backend (
--job-backend-config) - Number of requested cores per job (
--job-cores) - Maximum walltime of jobs (
--job-max-walltime) - Job output directory (
--job-output-dir) - Job polling interval (
--job-polling-interval) - Target resource for job backend (
--job-target-resource)
- Selecting the job backend (
- Usage of
--job - Examples
- Quick introduction to
- Using external modules
Getting help¶
Having trouble? We’d like to help!
- Search this documentation collection
- Search for information in the archives of the easybuild@lists.ugent.be mailing list or subscribe to post a question.
- Did you try
eb --help? - Ask a question in the #easybuild IRC channel on the Freenode network
- Consider participating to an EasyBuild conference call
- Report issues with EasyBuild framework in our framework ticket tracker.
- Report issues with EasyBuild easyblocks in our easyblocks ticket tracker.
- Report issues with EasyBuild easyconfigs in our easyconfigs ticket tracker.
- Report issues with EasyBuild documentation or other aspects in our general ticket tracker.
Lists and tables¶
As of version EasyBuild version 2.6.0:
- The complete table of available toolchains is visible at List of known toolchains
- The list of available easyblocks is visible at List of easyblocks
- The list of available (generic) easyconfig parameters is visible at Available easyconfig parameters
