Changelog for EasyBuild documentation

(for EasyBuild release notes, see EasyBuild release notes)

• release 20230109.01 (Jan 9th 2023): update release notes for EasyBuild v4.7.0 (see EasyBuild v4.7.0 (January 9th 2023))
• release 20221021.01 (Oct 21st 2022): update release notes for EasyBuild v4.6.2 (see EasyBuild v4.6.2 (October 21st 2022))
• release 20220912.01 (Sep 12th 2022): update release notes for EasyBuild v4.6.1 (see EasyBuild v4.6.1 (September 12th 2022))
• release 20220708.01 (Jul 8th 2022): update release notes for EasyBuild v4.6.0 (see EasyBuild v4.6.0 (July 8th 2022))
• release 20220608.01 (Jun 8th 2022): update release notes for EasyBuild v4.5.5 (see EasyBuild v4.5.5 (June 8th 2022))
• release 20220331.01 (Mar 31st 2022): update release notes for EasyBuild v4.5.4 (see EasyBuild v4.5.4 (March 31st 2022))
• release 20220211.01 (Feb 11th 2022): update release notes for EasyBuild v4.5.3 (see EasyBuild v4.5.3 (February 11th 2022))
• release 20220124.01 (Jan 24th 2022): update release notes for EasyBuild v4.5.2 (see EasyBuild v4.5.2 (January 24th 2022))
• release 20211213.01 (Dec 13th 2021): update release notes for EasyBuild v4.5.1 (see EasyBuild v4.5.1 (December 13th 2021))
• release 20211029.01 (Oct 29th 2021): update release notes for EasyBuild v4.5.0 (see EasyBuild v4.5.0 (October 29th 2021))
• release 20210907.01 (Sep 7th 2021): update release notes for EasyBuild v4.4.2 (see EasyBuild v4.4.2 (September 7th 2021))
• release 20210706.01 (Jul 6th 2021): update release notes for EasyBuild v4.4.1 (see EasyBuild v4.4.1 (July 6th 2021))
• release 20210602.01 (Jun 2nd 2021): update release notes for EasyBuild v4.4.0 (see EasyBuild v4.4.0 (June 2nd 2021))
• release 20210409.01 (Apr 9th 2021): update release notes for EasyBuild v4.3.4 (see EasyBuild v4.3.4 (Apr 9th 2021))
• release 20210223.01 (Feb 23rd 2021): update release notes for EasyBuild v4.3.3 (see EasyBuild v4.3.3 (Feb 23rd 2021))
• release 20201210.01 (Dec 10th 2020): update release notes for EasyBuild v4.3.2 (see EasyBuild v4.3.2 (December 10th 2020))
• release 20201029.01 (Oct 29th 2020): update release notes for EasyBuild v4.3.1 (see EasyBuild v4.3.1 (October 29th 2020))
• release 20200913.01 (Sep 13th 2020): update release notes for EasyBuild v4.3.0 (see EasyBuild v4.3.0 (September 13th 2020))
• release 20200708.01 (July 8th 2020): update release notes for EasyBuild v4.2.2 (see EasyBuild v4.2.2 (July 8th 2020))
• release 20200520.01 (May 20th 2020): update release notes for EasyBuild v4.2.1 (see EasyBuild v4.2.1 (May 20th 2020))
• release 20200414.01 (Apr 14th 2020):
  • document new EasyBuild locking mechanism (see Locks to prevent duplicate installations running at the same time)
  • document support for creating index files (see Using an index to speed up searching for easyconfigs)
  • update release notes for EasyBuild v4.2.0 (see EasyBuild v4.2.0 (April 14th 2020))
• release 20200316.01 (Mar 16th 2020): update release notes for EasyBuild v4.1.2 (see EasyBuild v4.1.2 (March 16th 2020))
• release 20200116.01 (Jan 16th 2020): update release notes for EasyBuild v4.1.1 (see EasyBuild v4.1.1 (January 16th 2020))
• release 20191204.01 (Dec 4th 2019): update release notes for EasyBuild v4.1.0 (see EasyBuild v4.1.0 (December 4th 2019))
• release 20191015.01 (Oct 15th 2019): update release notes for EasyBuild v4.0.1 (see EasyBuild v4.0.1 (October 15th 2019))
• release 20190920.01 (Sep 20th 2019): update release notes for EasyBuild v4.0.0 (see EasyBuild v4.0.0 (September 20th 2019)); see also Overview of changes in EasyBuild version 4.0
• release 20190823.01 (Aug 23rd 2019): update release notes for EasyBuild v3.9.4 (see EasyBuild v3.9.4 (August 23rd 2019))
• release 20190708.01 (Jul 8th 2019): update release notes for EasyBuild v3.9.3 (see EasyBuild v3.9.3 (July 8th 2019))
• release 20190609.01 (Jun 9th 2019): update release notes for EasyBuild v3.9.2 (see EasyBuild v3.9.2 (June 9th 2019))
• release 20190908.01 (Jun 8th 2019): update documentation on support for generating (Singularity) container recipes/images (see Generating container recipes & images)
• release 20190520.01 (May 20th 2019): update release notes for EasyBuild v3.9.1 (see EasyBuild v3.9.1 (May 20th 2019))
• release 20190412.01 (Apr 12th 2019): update release notes for EasyBuild v3.9.0 (see EasyBuild v3.9.0 (April 12th 2019))
• release 20190129.01 (Jan 29th 2019): update release notes for EasyBuild v3.8.1 (see EasyBuild v3.8.1 (January 29th 2019))
• release 20190124.01 (Jan 24th 2019): add definitions for 2019a common toolchains (see Common toolchains)
• release 20181218.01 (Dec 18th 2018): update release notes for EasyBuild v3.8.0 (see EasyBuild v3.8.0 (December 18th 2018))
• release 20181114.01 (Nov 14th 2018): add documentation on deprecated easyconfigs & toolchains (Deprecated easyconfigs)
• release 20181104.01 (Nov 4th 2018): update --job documentation to also cover Slurm job backend (see Submitting jobs using --job)
• release 20181018.01 (Oct 18th 2018): update release notes for EasyBuild v3.7.1 (see EasyBuild v3.7.1 (October 18th 2018))
• release 20180925.01 (Sep 25th 2018): update release notes for EasyBuild v3.7.0 (see EasyBuild v3.7.0 (September 25th 2018))
• release 20180921.01 (Sep 21st 2018): document support for wrapping dependencies (see Wrapping dependencies)
• release 20180920.01 (Sep 20th 2018): document support for downloading sources directly from a Git repository (see Downloading from a Git repository)
• release 20180711.01 (Jul 11th 2018): update release notes for EasyBuild v3.6.2 (see EasyBuild v3.6.2 (July 11th 2018))
• release 20180710.01 (Jul 10th 2018): add definitions for 2018b common toolchains (see Common toolchains)
• release 20180528.01 (May 28th 2018): update release notes for EasyBuild v3.6.1 (see EasyBuild v3.6.1 (May 26th 2018))
• release 20180427.01 (Apr 27th 2018): update release notes for EasyBuild v3.6.0 (see EasyBuild v3.6.0 (April 26th 2018))
• release 20180425.01 (Apr 25th 2018): add documentation on support for generating container recipes & images (see Generating container recipes & images)
• release 20180307.01 (Mar 7th 2018): update release notes for EasyBuild v3.5.3 (see EasyBuild v3.5.3 (March 7th 2018))
• release 20180302.01 (Mar 2nd 2018): update release notes for EasyBuild v3.5.2 (see EasyBuild v3.5.2 (March 2nd 2018))
• release 20180116.01 (Jan 16th 2018): update release notes for EasyBuild v3.5.1 (see EasyBuild v3.5.1 (January 16th 2018))
• release 20180112.01 (Jan 12th 2018): add definitions for 2018a common toolchains (see Common toolchains)
• release 20171215.01 (Dec 15th 2017): update release notes for EasyBuild v3.5.0 (see EasyBuild v3.5.0 (December 15th 2017))
• release 20171208.01 (Dec 8th 2017): document support for user-defined hooks (see Hooks)
• release 20171017.01 (Oct 17th 2017): update release notes for EasyBuild v3.4.1 (see EasyBuild v3.4.1 (October 17th 2017))
• release 20170910.01 (Sept 10th 2017): update release notes for EasyBuild v3.4.0 (see EasyBuild v3.4.0 (September 10th 2017))
• release 20170906.01 (Sept 6th 2017): document --trace (see Tracing progress)
• release 20170824.02 (Aug 24th 2017): document --inject-checksums (see Adding or replacing checksums using --inject-checksums)
• release 20170824.01 (Aug 24th 2017): document --backup-modules (see Backing up of existing modules (--backup-modules))
• release 20170712.01 (July 12th 2017): update release notes for EasyBuild v3.3.1 (see EasyBuild v3.3.1 (July 12th 2017))
• release 20170708.01 (July 8th 2017): add documentation on Merging easyconfig pull requests (--merge-pr)
• release 20170705.01 (July 5th 2017): clarify Requirements for pull requests, add page listing EasyBuild maintainers
• release 20170626.01 (June 26th 2017): update release notes for EasyBuild v3.3.0 (see EasyBuild v3.3.0 (June 26th 2017))
• release 20170623.01 (June 23rd 2017): document use of checksums & alternative formats for sources (see Source files, patches and checksums)
• release 20170622.01 (June 22nd 2017): document support for detecting loaded modules (see detect_loaded_modules)
• release 20170522.01 (May 22nd 2017): document deprecated behaviour in EasyBuild v3.2.0 (see Overview of deprecated functionality in EasyBuild version 4.7.0)
• release 20170512.01 (May 12th 2017): update release notes for EasyBuild v3.2.1 (see EasyBuild v3.2.1 (May 12th 2017))
• release 20170505.01 (May 5th 2017): update release notes for EasyBuild v3.2.0 (see EasyBuild v3.2.0 (May 5th 2017))
• release 20170320.01 (Mar 20th 2017): update release notes for EasyBuild v3.1.2 (see EasyBuild v3.1.2 (March 20th 2017))
• release 20170307.01 (Mar 7th 2017): update release notes for EasyBuild v3.1.1 (see EasyBuild v3.1.1 (March 7th 2017))
• release 20170221.01 (Feb 21st 2017): add documentation on Contributing
• release 20170209.01 (Feb 9th 2017): add documentation on implementing easyblocks (see Implementing easyblocks)
• release 20170203.01 (Feb 3rd 2017): update release notes for EasyBuild v3.1.0 (see EasyBuild v3.1.0 (February 3rd 2017))
• release 20170129.01 (Jan 29th 2017): update --optarch documentation (see Setting architecture flags for different compilers via --optarch=<compiler:flags>;<compiler:flags>)
• release 20170109.01 (Jan 9th 2017): add documentation on Common toolchains
• release 20161222.01 (Dec 22nd 2016): update documentation and release notes for EasyBuild v3.0.2 (see EasyBuild v3.0.2 (December 22nd 2016))
• release 20161218.01 (Dec 18th 2016): document need to download vsc-* source tarballs from PyPI (see bootstrap_offline)
• release 20161202.01 (Dec 2nd 2016): add documentation on Cray support (see EasyBuild on Cray)
• release 20161130.01 (Nov 16th 2016): update release notes for EasyBuild v3.0.1 (see EasyBuild v3.0.1 (November 30th 2016))
• release 20161117.01 (Nov 17th 2016): update mentions of default configuration according to updated default in EasyBuild v3.0.0
• release 20161116.01 (Nov 16th 2016): update documentation and release notes for EasyBuild v3.0.0 (see EasyBuild v3.0.0 (November 16th 2016))
  • Archived easyconfigs
  • Support for RPATH
• release 20161028.01 (Oct 28th 2016): recommend using --rebuild rather than --force (see Rebuild installation, --rebuild)
• release 20161023.01 (Oct 24th 2016): add section on iterating over configure/build/install options (see List of configure/build/install options)
• release 20161014.01 (Oct 14th 2016): update documentation on deprecated functionality (see Deprecated functionality)
• release 20161010.01 (Oct 10th 2016): add page for EasyBuild demos (see Demos)
• release 20160923.02 (Sept 23rd 2016): update release notes for EasyBuild v2.9.0 (see EasyBuild v2.9.0 (September 23rd 2016))
• release 20160923.01 (Sept 23rd 2016): add generated list of supported software (see List of supported software)
• release 20160713.01 (July 13th 2016): update release notes for EasyBuild v2.8.2 (see EasyBuild v2.8.2 (July 13th 2016))
• release 20160613.01 (June 13th 2016): clarify required dependencies (setuptools, vsc-install) (see Required Python packages)
• release 20160607.01 (June 7th 2016): update/complete documentation on GitHub integration (see Integration with GitHub)
• release 20160530.01 (May 30th 2016): update release notes for EasyBuild v2.8.1 (see EasyBuild v2.8.1 (May 30th 2016))
• release 20160518.01 (May 18th 2016): update release notes for EasyBuild v2.8.0 (see EasyBuild v2.8.0 (May 18th 2016))
• release 20160429.01 (April 29th 2016): add section on updating EasyBuild, see Updating an existing EasyBuild installation
• release 20160320.01 (March 20th 2016): update release notes for EasyBuild v2.7.0 (see EasyBuild v2.7.0 (March 20th 2016))
• release 20160228.01 (February 28th 2016):
  • update documentation on external modules metadata (see Metadata for external modules)
• release 20160214.01 (February 14th 2016):

• add section on --show-config (see Overview of current configuration (--show-config, --show-full-config))

• release 20160126.02 (January 26th 2016): packaging support is stable since EasyBuild v2.5.0 (see Packaging support)
• release 20160126.01 (January 26th 2016): update release notes for EasyBuild v2.6.0 (see EasyBuild v2.6.0 (January 26th 2016))
• release 20151217.01 (December 17th 2015): update release notes for EasyBuild v2.5.0 (see EasyBuild v2.5.0 (December 17th 2015))
• release 20151209.01 (December 9th 2015):
  • add documentation on controlling compiler optimizations flags, see Controlling compiler optimization flags
• release 20151110.01 (November 10th 2015): update release notes for EasyBuild v2.4.0 (see EasyBuild v2.4.0 (November 10th 2015))
• release 20151108.01 (November 8th 2015):
  • document (experimental) support for using minimal toolchains (see Using minimal toolchains for dependencies)
• release 20151028.01 (October 28th 2015): document extended dry run mechanism (see Extended dry run)
• release 20151021.01 (October 21st 2015):
  • include initial documentation on experimental support for easyconfig files in YAML syntax (.yeb), see Writing easyconfig files in YAML syntax (.yeb format) [IN DEVELOPMENT]
• release 20150902.01 (September 2nd 2015): update release notes for EasyBuild v2.3.0 (see EasyBuild v2.3.0 (September 2nd 2015))
• release 20150715.01 (July 15th 2015): update release notes for EasyBuild v2.2.0 (see EasyBuild v2.2.0 (July 15th 2015))
• release 20150714.01 (July 14th 2015): add documentation on Packaging support
• release 20150709.01 (July 9th 2015): add documentation on Submitting jobs using --job
• release 20150708.01 (July 8th 2015):
  • add documentation on --include-* options (see Including additional Python modules (--include-*))
• release 20150703.01 (July 3rd 2015):
  • fix outdated documentation on easyblock parameter (see Easyblock specification)

• release 20150624.01 (June 24th 2015): mention MigrateFromEBToHMNS module naming scheme in section on

  --module-only (see Generating additional module files)

• release 20150610.01 (June 10th 2015): update Installing Lmod without root permissions for Lmod v6.0
• release 20150518.01 (May 18th 2015):
  • update section on --search: better examples + highlight ability to search via regular expression (see Searching for easyconfigs, --search / -S)
  • update release notes for EasyBuild v2.1.1 (see EasyBuild v2.1.1 (May 18th 2015))
• release 20150506.01 (May 6th 2015): updated documentation for EasyBuild v2.1.1
  • add note on $LMOD_CMD fallback to find full path to lmod binary (see Required modules tool)
• release 20150430.01 (Apr 30th 2015): updated documentation for EasyBuild v2.1.0
  • also cover extensions in page on concepts and terminology (see Extensions)
  • add documentation on Partial installations, covering --stop, --skip and --module-only
  • add documentation on Manipulating dependencies, covering --filter-deps and --hide-deps
  • document -module-syntax configuration option (see Module files syntax (--module-syntax))
  • add note on detection of unknown $EASYBUILD-prefixed environment variables (see Environment variables)
  • mention support for prepending/appending to --robot-paths (see Prepending and/or appending to the default robot search path)
  • update release notes for EasyBuild v2.1.0 (see EasyBuild release notes)
• release 20150425.01 (Apr 25th 2015):
  • add documentation on Using external modules
• release 20150407.01 (Apr 7th 2015):
  • add link to Unit tests page in dedicated section at Installing EasyBuild page (see install_running_unit_tests)
  • clarify relation between --installpath, --prefix, -subdir-* and --installpath-* configuration options (see Software and modules install path (--installpath, --installpath-software, --installpath-modules))
  • mention --show-default-configfiles command line option in relevant section (see Default configuration files)
• release 20150327.01 (Mar 27th 2015):
  • documented deprecated functionality w.r.t. error reporting (see error and exception log methods no longer raise an exception)
• release 20150316.01 (Mar 16th 2015):
  • include list of EasyBuild repositories cloned by install-EasyBuild-develop.sh script (see Installation of latest development version using provided script)
• release 20150312.01 (Mar 12th 2015):
  • enhance documentation w.r.t. template values in configuration files (see Templates and constants supported in configuration files)
  • improve documentation on --robot and --robot-paths (see Controlling the robot search path)
• release 20150310.01 (Mar 10th 2015):
  • document peculiarties w.r.t. dependencies in combination with a dummy toolchain (see Dependencies)
  • document clean_gists.py script (see clean_gists.py)
  • mention taking into account of proxy settings for downloading sources (see Source files, patches and checksums)
• release 20150306.03 (Mar 6th 2015): add release notes for EasyBuild v2.0.0 (see EasyBuild release notes)
• release 20150306.02 (Mar 6th 2015):
  • add documentation on GitHub integration features (see Integration with GitHub), mainly --from-pr (see from_pr)
  • document locations where (specified) easyconfig files are being searched for (see Specifying builds)
• release 20150306.01 (Mar 6th 2015):
  • add documentation on removed functionality (see Removed functionality)
  • clean up documentation on deprecated functionality (see Deprecated functionality)
  • add documentation on provided scripts, in particular fix-broken-easyconfigs.py (see Useful scripts)
• release 20150302.01 (Mar 2nd 2015): update/cleanup documentation on Alternative installation methods
• release 20150227.02 (Feb 27th 2015): add documentation on the EasyBuild unit test suites, see Unit tests
• release 20150227.01 (Feb 27th 2015): enhance documentation w.r.t. to (optional dependencies), see Installing EasyBuild
• release 20150220.01 (Feb 20th 2015):
  • document new advanced bootstrapping options: skipping stage 0 and providing source tarballs (see Installing EasyBuild)
• release 20150219.01 (Feb 19th 2015): first updates for EasyBuild v2.0.0
  • extend section on (default) EasyBuild configuration files to also cover $XDG_CONFIG_DIRS (see configuration_file:)
• release 20150205.01 (Feb 5th 2015): include information on deprecated functionality in (generic) easyblocks (see Deprecated functionality)
• release 20150126.01 (Jan 26th 2015):
  • fix pip installation prefix option (Alternative installation methods)
  • clarify need to have modules tool binary available in $PATH (Installing EasyBuild)
• release 20150112.01 (Jan 12th 2015): mention need to escape % when setting log file format via config file (see Logfile format (--logfile-format))
• release 20150107.01 (Jan 7th 2015): document behaviour of dummy toolchain (dummy toolchain (DEPRECATED))
• release 20141219.01 (Dec 19th 2014): add release notes for EasyBuild v1.16.1 (see EasyBuild release notes)
• release 20141218.01 (Dec 18th 2014): add release notes for EasyBuild v1.16.0 (see EasyBuild release notes)
• release 20141217.01 (Dec 17th 2014): document deprecated functionality in EasyBuild v1.x (Deprecated functionality)
• release 20141204.02 (Dec 4th 2014): add EasyBuild release notes (see EasyBuild release notes)
• release 20141204.01 (Dec 4th 2014): updates for EasyBuild v1.16.0
  • document details w.r.t. (controlling of) robot search path, incl. --robot-paths (Using the EasyBuild command line)
  • document use of templates and constants in EasyBuild configuration files (Configuring EasyBuild)
  • bump EasyBuild version to 1.16.0
  • changed release number scheme for documentation (based on datestamp)
• release 1.0.3 (Dec 3rd 2014): add page on Code style
• release 1.0.2 (Nov 6th 2014): typo and grammar fixes, update Lmod installation instructions for Lmod v5.8
• release 1.0.1 (Nov 4th 2014): fix issues with Changelog
• release 1.0.0 (Nov 4th 2014): initial release of revamped EasyBuild documentation @ http://easybuild.readthedocs.org, covering basic topics:
  • introductory topics:
    • What is EasyBuild?
    • Concepts and terminology
    • Typical workflow example: building and installing WRF
  • getting started:
    • Installing EasyBuild
    • Configuring EasyBuild
  • basic usage topics:
    • Using the EasyBuild command line
    • Writing easyconfig files: the basics
    • Understanding EasyBuild logs