.. _changelog: Changelog for EasyBuild documentation ------------------------------------- (for EasyBuild release notes, see :ref:`release_notes`) * **release 20230109.01** (`Jan 9th 2023`): update release notes for EasyBuild v4.7.0 (see :ref:`release_notes_eb470`) * **release 20221021.01** (`Oct 21st 2022`): update release notes for EasyBuild v4.6.2 (see :ref:`release_notes_eb462`) * **release 20220912.01** (`Sep 12th 2022`): update release notes for EasyBuild v4.6.1 (see :ref:`release_notes_eb461`) * **release 20220708.01** (`Jul 8th 2022`): update release notes for EasyBuild v4.6.0 (see :ref:`release_notes_eb460`) * **release 20220608.01** (`Jun 8th 2022`): update release notes for EasyBuild v4.5.5 (see :ref:`release_notes_eb455`) * **release 20220331.01** (`Mar 31st 2022`): update release notes for EasyBuild v4.5.4 (see :ref:`release_notes_eb454`) * **release 20220211.01** (`Feb 11th 2022`): update release notes for EasyBuild v4.5.3 (see :ref:`release_notes_eb453`) * **release 20220124.01** (`Jan 24th 2022`): update release notes for EasyBuild v4.5.2 (see :ref:`release_notes_eb452`) * **release 20211213.01** (`Dec 13th 2021`): update release notes for EasyBuild v4.5.1 (see :ref:`release_notes_eb451`) * **release 20211029.01** (`Oct 29th 2021`): update release notes for EasyBuild v4.5.0 (see :ref:`release_notes_eb450`) * **release 20210907.01** (`Sep 7th 2021`): update release notes for EasyBuild v4.4.2 (see :ref:`release_notes_eb442`) * **release 20210706.01** (`Jul 6th 2021`): update release notes for EasyBuild v4.4.1 (see :ref:`release_notes_eb441`) * **release 20210602.01** (`Jun 2nd 2021`): update release notes for EasyBuild v4.4.0 (see :ref:`release_notes_eb440`) * **release 20210409.01** (`Apr 9th 2021`): update release notes for EasyBuild v4.3.4 (see :ref:`release_notes_eb434`) * **release 20210223.01** (`Feb 23rd 2021`): update release notes for EasyBuild v4.3.3 (see :ref:`release_notes_eb433`) * **release 20201210.01** (`Dec 10th 2020`): update release notes for EasyBuild v4.3.2 (see :ref:`release_notes_eb432`) * **release 20201029.01** (`Oct 29th 2020`): update release notes for EasyBuild v4.3.1 (see :ref:`release_notes_eb431`) * **release 20200913.01** (`Sep 13th 2020`): update release notes for EasyBuild v4.3.0 (see :ref:`release_notes_eb430`) * **release 20200708.01** (`July 8th 2020`): update release notes for EasyBuild v4.2.2 (see :ref:`release_notes_eb422`) * **release 20200520.01** (`May 20th 2020`): update release notes for EasyBuild v4.2.1 (see :ref:`release_notes_eb421`) * **release 20200414.01** (`Apr 14th 2020`): * document new EasyBuild locking mechanism (see :ref:`locks`) * document support for creating index files (see :ref:`easyconfigs_index`) * update release notes for EasyBuild v4.2.0 (see :ref:`release_notes_eb420`) * **release 20200316.01** (`Mar 16th 2020`): update release notes for EasyBuild v4.1.2 (see :ref:`release_notes_eb412`) * **release 20200116.01** (`Jan 16th 2020`): update release notes for EasyBuild v4.1.1 (see :ref:`release_notes_eb411`) * **release 20191204.01** (`Dec 4th 2019`): update release notes for EasyBuild v4.1.0 (see :ref:`release_notes_eb410`) * **release 20191015.01** (`Oct 15th 2019`): update release notes for EasyBuild v4.0.1 (see :ref:`release_notes_eb401`) * **release 20190920.01** (`Sep 20th 2019`): update release notes for EasyBuild v4.0.0 (see :ref:`release_notes_eb400`); see also :ref:`eb4_changes_overview` * **release 20190823.01** (`Aug 23rd 2019`): update release notes for EasyBuild v3.9.4 (see :ref:`release_notes_eb394`) * **release 20190708.01** (`Jul 8th 2019`): update release notes for EasyBuild v3.9.3 (see :ref:`release_notes_eb393`) * **release 20190609.01** (`Jun 9th 2019`): update release notes for EasyBuild v3.9.2 (see :ref:`release_notes_eb392`) * **release 20190908.01** (`Jun 8th 2019`): update documentation on support for generating (Singularity) container recipes/images (see :ref:`containers`) * **release 20190520.01** (`May 20th 2019`): update release notes for EasyBuild v3.9.1 (see :ref:`release_notes_eb391`) * **release 20190412.01** (`Apr 12th 2019`): update release notes for EasyBuild v3.9.0 (see :ref:`release_notes_eb390`) * **release 20190129.01** (`Jan 29th 2019`): update release notes for EasyBuild v3.8.1 (see :ref:`release_notes_eb381`) * **release 20190124.01** (`Jan 24th 2019`): add definitions for ``2019a`` common toolchains (see :ref:`common_toolchains`) * **release 20181218.01** (`Dec 18th 2018`): update release notes for EasyBuild v3.8.0 (see :ref:`release_notes_eb380`) * **release 20181114.01** (`Nov 14th 2018`): add documentation on deprecated easyconfigs & toolchains (:ref:`deprecated_easyconfigs`) * **release 20181104.01** (`Nov 4th 2018`): update ``--job`` documentation to also cover ``Slurm`` job backend (see :ref:`submitting_jobs`) * **release 20181018.01** (`Oct 18th 2018`): update release notes for EasyBuild v3.7.1 (see :ref:`release_notes_eb371`) * **release 20180925.01** (`Sep 25th 2018`): update release notes for EasyBuild v3.7.0 (see :ref:`release_notes_eb370`) * **release 20180921.01** (`Sep 21st 2018`): document support for wrapping dependencies (see :ref:`wrapping_dependencies`) * **release 20180920.01** (`Sep 20th 2018`): document support for downloading sources directly from a Git repository (see :ref:`common_easyconfig_param_sources_git_config`) * **release 20180711.01** (`Jul 11th 2018`): update release notes for EasyBuild v3.6.2 (see :ref:`release_notes_eb362`) * **release 20180710.01** (`Jul 10th 2018`): add definitions for ``2018b`` common toolchains (see :ref:`common_toolchains`) * **release 20180528.01** (`May 28th 2018`): update release notes for EasyBuild v3.6.1 (see :ref:`release_notes_eb361`) * **release 20180427.01** (`Apr 27th 2018`): update release notes for EasyBuild v3.6.0 (see :ref:`release_notes_eb360`) * **release 20180425.01** (`Apr 25th 2018`): add documentation on support for generating container recipes & images (see :ref:`containers`) * **release 20180307.01** (`Mar 7th 2018`): update release notes for EasyBuild v3.5.3 (see :ref:`release_notes_eb353`) * **release 20180302.01** (`Mar 2nd 2018`): update release notes for EasyBuild v3.5.2 (see :ref:`release_notes_eb352`) * **release 20180116.01** (`Jan 16th 2018`): update release notes for EasyBuild v3.5.1 (see :ref:`release_notes_eb351`) * **release 20180112.01** (`Jan 12th 2018`): add definitions for ``2018a`` common toolchains (see :ref:`common_toolchains`) * **release 20171215.01** (`Dec 15th 2017`): update release notes for EasyBuild v3.5.0 (see :ref:`release_notes_eb350`) * **release 20171208.01** (`Dec 8th 2017`): document support for user-defined hooks (see :ref:`hooks`) * **release 20171017.01** (`Oct 17th 2017`): update release notes for EasyBuild v3.4.1 (see :ref:`release_notes_eb341`) * **release 20170910.01** (`Sept 10th 2017`): update release notes for EasyBuild v3.4.0 (see :ref:`release_notes_eb340`) * **release 20170906.01** (`Sept 6th 2017`): document ``--trace`` (see :ref:`trace`) * **release 20170824.02** (`Aug 24th 2017`): document ``--inject-checksums`` (see :ref:`inject_checksums`) * **release 20170824.01** (`Aug 24th 2017`): document ``--backup-modules`` (see :ref:`backup_modules`) * **release 20170712.01** (`July 12th 2017`): update release notes for EasyBuild v3.3.1 (see :ref:`release_notes_eb331`) * **release 20170708.01** (`July 8th 2017`): add documentation on :ref:`github_merge_pr` * **release 20170705.01** (`July 5th 2017`): clarify :ref:`contributing_review_process_pr_requirements`, add page listing :ref:`maintainers` * **release 20170626.01** (`June 26th 2017`): update release notes for EasyBuild v3.3.0 (see :ref:`release_notes_eb330`) * **release 20170623.01** (`June 23rd 2017`): document use of ``checksums`` & alternative formats for ``sources`` (see :ref:`common_easyconfig_param_sources`) * **release 20170622.01** (`June 22nd 2017`): document support for detecting loaded modules (see :ref:`detect_loaded_modules`) * **release 20170522.01** (`May 22nd 2017`): document deprecated behaviour in EasyBuild v3.2.0 (see :ref:`overview_deprecated`) * **release 20170512.01** (`May 12th 2017`): update release notes for EasyBuild v3.2.1 (see :ref:`release_notes_eb321`) * **release 20170505.01** (`May 5th 2017`): update release notes for EasyBuild v3.2.0 (see :ref:`release_notes_eb320`) * **release 20170320.01** (`Mar 20th 2017`): update release notes for EasyBuild v3.1.2 (see :ref:`release_notes_eb312`) * **release 20170307.01** (`Mar 7th 2017`): update release notes for EasyBuild v3.1.1 (see :ref:`release_notes_eb311`) * **release 20170221.01** (`Feb 21st 2017`): add documentation on :ref:`contributing` * **release 20170209.01** (`Feb 9th 2017`): add documentation on implementing easyblocks (see :ref:`implementing_easyblocks`) * **release 20170203.01** (`Feb 3rd 2017`): update release notes for EasyBuild v3.1.0 (see :ref:`release_notes_eb310`) * **release 20170129.01** (`Jan 29th 2017`): update ``--optarch`` documentation (see :ref:`controlling_compiler_optimization_flags_optarch_per_compiler`) * **release 20170109.01** (`Jan 9th 2017`): add documentation on :ref:`common_toolchains` * **release 20161222.01** (`Dec 22nd 2016`): update documentation and release notes for EasyBuild v3.0.2 (see :ref:`release_notes_eb302`) * **release 20161218.01** (`Dec 18th 2016`): document need to download ``vsc-*`` source tarballs from PyPI (see :ref:`bootstrap_offline`) * **release 20161202.01** (`Dec 2nd 2016`): add documentation on Cray support (see :ref:`cray_support`) * **release 20161130.01** (`Nov 16th 2016`): update release notes for EasyBuild v3.0.1 (see :ref:`release_notes_eb301`) * **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 :ref:`release_notes_eb300`) * :ref:`archived_easyconfigs` * :ref:`rpath_support` * **release 20161028.01** (`Oct 28th 2016`): recommend using ``--rebuild`` rather than ``--force`` (see :ref:`rebuild_option`) * **release 20161023.01** (`Oct 24th 2016`): add section on iterating over configure/build/install options (see :ref:`configure_build_install_command_options_iterate`) * **release 20161014.01** (`Oct 14th 2016`): update documentation on deprecated functionality (see :ref:`deprecated`) * **release 20161010.01** (`Oct 10th 2016`): add page for EasyBuild demos (see :ref:`demos`) * **release 20160923.02** (`Sept 23rd 2016`): update release notes for EasyBuild v2.9.0 (see :ref:`release_notes_eb290`) * **release 20160923.01** (`Sept 23rd 2016`): add generated list of supported software (see :ref:`list_software`) * **release 20160713.01** (`July 13th 2016`): update release notes for EasyBuild v2.8.2 (see :ref:`release_notes_eb282`) * **release 20160613.01** (`June 13th 2016`): clarify required dependencies (setuptools, vsc-install) (see :ref:`required_python_packages`) * **release 20160607.01** (`June 7th 2016`): update/complete documentation on GitHub integration (see :ref:`integration_with_github`) * **release 20160530.01** (`May 30th 2016`): update release notes for EasyBuild v2.8.1 (see :ref:`release_notes_eb281`) * **release 20160518.01** (`May 18th 2016`): update release notes for EasyBuild v2.8.0 (see :ref:`release_notes_eb280`) * **release 20160429.01** (`April 29th 2016`): add section on updating EasyBuild, see :ref:`updating` * **release 20160320.01** (`March 20th 2016`): update release notes for EasyBuild v2.7.0 (see :ref:`release_notes_eb270`) * **release 20160228.01** (`February 28th 2016`): * update documentation on external modules metadata (see :ref:`using_external_modules_metadata`) * **release 20160214.01** (`February 14th 2016`): * add section on ``--show-config`` (see :ref:`configuration_show_config`) * **release 20160126.02** (`January 26th 2016`): packaging support is stable since EasyBuild v2.5.0 (see :ref:`packaging_support`) * **release 20160126.01** (`January 26th 2016`): update release notes for EasyBuild v2.6.0 (see :ref:`release_notes_eb260`) * **release 20151217.01** (`December 17th 2015`): update release notes for EasyBuild v2.5.0 (see :ref:`release_notes_eb250`) * **release 20151209.01** (`December 9th 2015`): * add documentation on controlling compiler optimizations flags, see :ref:`controlling_compiler_optimization_flags` * **release 20151110.01** (`November 10th 2015`): update release notes for EasyBuild v2.4.0 (see :ref:`release_notes_eb240`) * **release 20151108.01** (`November 8th 2015`): * document (experimental) support for using minimal toolchains (see :ref:`minimal_toolchains`) * **release 20151028.01** (`October 28th 2015`): document extended dry run mechanism (see :ref:`extended_dry_run`) * **release 20151021.01** (`October 21st 2015`): * include initial documentation on experimental support for easyconfig files in YAML syntax (``.yeb``), see :ref:`easyconfig_yeb_format` * **release 20150902.01** (`September 2nd 2015`): update release notes for EasyBuild v2.3.0 (see :ref:`release_notes_eb230`) * **release 20150715.01** (`July 15th 2015`): update release notes for EasyBuild v2.2.0 (see :ref:`release_notes_eb220`) * **release 20150714.01** (`July 14th 2015`): add documentation on :ref:`packaging_support` * **release 20150709.01** (`July 9th 2015`): add documentation on :ref:`submitting_jobs` * **release 20150708.01** (`July 8th 2015`): * add documentation on ``--include-*`` options (see :ref:`including_additional_python_modules`) * **release 20150703.01** (`July 3rd 2015`): * fix outdated documentation on ``easyblock`` parameter (see :ref:`writing_easyconfigs_easyblock_spec`) * **release 20150624.01** (`June 24th 2015`): mention ``MigrateFromEBToHMNS`` module naming scheme in section on ``--module-only`` (see :ref:`module_only_additional`) * **release 20150610.01** (`June 10th 2015`): update :ref:`installing_lmod` for Lmod v6.0 * **release 20150518.01** (`May 18th 2015`): * update section on ``--search``: better examples + highlight ability to search via regular expression (see :ref:`searching_for_easyconfigs`) * update release notes for EasyBuild v2.1.1 (see :ref:`release_notes_eb211`) * **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 :ref:`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 :ref:`extensions`) * add documentation on :ref:`partial_installations`, covering ``--stop``, ``--skip`` and ``--module-only`` * add documentation on :ref:`manipulating_dependencies`, covering ``--filter-deps`` and ``--hide-deps`` * document ``-module-syntax`` configuration option (see :ref:`module_syntax`) * add note on detection of unknown ``$EASYBUILD``-prefixed environment variables (see :ref:`configuration_env_vars`) * mention support for prepending/appending to ``--robot-paths`` (see :ref:`robot_search_path_prepend_append`) * update release notes for EasyBuild v2.1.0 (see :ref:`release_notes`) * **release 20150425.01** (`Apr 25th 2015`): * add documentation on :ref:`using_external_modules` * **release 20150407.01** (`Apr 7th 2015`): * add link to :ref:`unit_tests` page in dedicated section at :ref:`installation` page (see :ref:`install_running_unit_tests`) * clarify relation between ``--installpath``, ``--prefix``, ``-subdir-*`` and ``--installpath-*`` configuration options (see :ref:`installpath`) * mention ``--show-default-configfiles`` command line option in relevant section (see :ref:`default_configuration_files`) * **release 20150327.01** (`Mar 27th 2015`): * documented deprecated functionality w.r.t. error reporting (see :ref:`depr_error_reporting`) * **release 20150316.01** (`Mar 16th 2015`): * include list of EasyBuild repositories cloned by ``install-EasyBuild-develop.sh`` script (see :ref:`install_latest_develop_using_script`) * **release 20150312.01** (`Mar 12th 2015`): * enhance documentation w.r.t. template values in configuration files (see :ref:`configuration_file_templates_constants`) * improve documentation on ``--robot`` and ``--robot-paths`` (see :ref:`controlling_robot_search_path`) * **release 20150310.01** (`Mar 10th 2015`): * document peculiarties w.r.t. dependencies in combination with a ``dummy`` toolchain (see :ref:`dependency_specs`) * document ``clean_gists.py`` script (see :ref:`clean_gists_script`) * mention taking into account of proxy settings for downloading sources (see :ref:`common_easyconfig_param_sources`) * **release 20150306.03** (`Mar 6th 2015`): add release notes for EasyBuild v2.0.0 (see :ref:`release_notes`) * **release 20150306.02** (`Mar 6th 2015`): * add documentation on GitHub integration features (see :ref:`integration_with_github`), mainly ``--from-pr`` (see :ref:`from_pr`) * document locations where (specified) easyconfig files are being searched for (see :ref:`specifying_easyconfigs`) * **release 20150306.01** (`Mar 6th 2015`): * add documentation on removed functionality (see :ref:`removed_functionality`) * clean up documentation on deprecated functionality (see :ref:`deprecated`) * add documentation on provided scripts, in particular ``fix-broken-easyconfigs.py`` (see :ref:`useful_scripts`) * **release 20150302.01** (`Mar 2nd 2015`): update/cleanup documentation on :ref:`alt_inst_methods` * **release 20150227.02** (`Feb 27th 2015`): add documentation on the EasyBuild unit test suites, see :ref:`unit_tests` * **release 20150227.01** (`Feb 27th 2015`): enhance documentation w.r.t. to (optional dependencies), see :ref:`installation` * **release 20150220.01** (`Feb 20th 2015`): * document new advanced bootstrapping options: skipping stage 0 and providing source tarballs (see :ref:`installation`) * **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 :ref:`configuration_file:`) * **release 20150205.01** (`Feb 5th 2015`): include information on deprecated functionality in (generic) easyblocks (see :ref:`deprecated`) * **release 20150126.01** (`Jan 26th 2015`): * fix ``pip`` installation prefix option (:ref:`alt_inst_methods`) * clarify need to have modules tool binary available in ``$PATH`` (:ref:`installation`) * **release 20150112.01** (`Jan 12th 2015`): mention need to escape ``%`` when setting log file format via config file (see :ref:`logfile_format`) * **release 20150107.01** (`Jan 7th 2015`): document behaviour of `dummy` toolchain (:ref:`dummy_toolchain`) * **release 20141219.01** (`Dec 19th 2014`): add release notes for EasyBuild v1.16.1 (see :ref:`release_notes`) * **release 20141218.01** (`Dec 18th 2014`): add release notes for EasyBuild v1.16.0 (see :ref:`release_notes`) * **release 20141217.01** (`Dec 17th 2014`): document deprecated functionality in EasyBuild v1.x (:ref:`deprecated`) * **release 20141204.02** (`Dec 4th 2014`): add EasyBuild release notes (see :ref:`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`` (:ref:`using_the_easybuild_command_line`) * document use of templates and constants in EasyBuild configuration files (:ref:`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 :ref:`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: * :ref:`what_is_easybuild` * :ref:`concepts_and_terminology` * :ref:`typical_workflow` * getting started: * :ref:`installation` * :ref:`configuring_easybuild` * basic usage topics: * :ref:`using_the_easybuild_command_line` * :ref:`writing_easyconfig_files` * :ref:`understanding_easyBuild_logs`