From 5b5b90098aa6966c9b594d3219048f21bce1b3c1 Mon Sep 17 00:00:00 2001
From: Hans Fangohr <hans.fangohr@mpsd.mpg.de>
Date: Mon, 12 Jun 2023 17:11:41 +0200
Subject: [PATCH] just tried this, so we might as well document the behaviour
because I wanted to know if package sets are included in the return value
---
mpsd-software.py | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/mpsd-software.py b/mpsd-software.py
index e32351a..b1ca8c7 100755
--- a/mpsd-software.py
+++ b/mpsd-software.py
@@ -729,6 +729,18 @@ def prepare_environment(mpsd_release: str, root_dir: Path) -> List[str]:
-------
available_toolchains : list
A list of available toolchains for the given MPSD release.
+
+ Example
+ -------
+ >>> prepare_environment('dev-23a', Path('.'))
+ ['foss2021a-cuda-mpi',
+ 'foss2021a-mpi',
+ 'foss2021a-serial',
+ 'foss2022a-cuda-mpi',
+ 'foss2022a-mpi',
+ 'foss2022a-serial',
+ 'global',
+ 'global_generic']
"""
logging.info(f"Preparing {mpsd_release=}")
--
GitLab