diff --git a/mpsd-software-environment.py b/mpsd-software-environment.py index 4f6be38a8045ec3d2d1aef0950c17dc768dc027b..03e1319df77ada67f6f4cbaf6224020a1be76e0a 100755 --- a/mpsd-software-environment.py +++ b/mpsd-software-environment.py @@ -128,7 +128,7 @@ def create_dir_structure(mpsd_release: str, script_dir: Path) -> None: The create_dir_structure function creates the directory structure for the specified release and clones the Spack environments repository if it doesn't exist. - + Parameters ---------- - mpsd_release: A string representing the MPSD release version. @@ -173,29 +173,28 @@ def get_release_info(mpsd_release: str, script_dir: Path) -> Tuple[str, str, Lis Get information about the specified release, such as the branch and commit hash of the Spack environments repository and the available toolchains. - Args - ---- + Parameters + ---------- mpsd_release : str - the name of the release to get information for. + The name of the release to get information for. script_dir : pathlib.Path - the base directory where releases are stored. + The base directory where releases are stored. Returns ------- spe_branch : str - the name of the branch for the Spack environments repository. + The name of the branch for the Spack environments repository. spe_commit_hash : str - the commit hash for the Spack environments repository. + The commit hash for the Spack environments repository. available_toolchains : list - a list of strings representing the available - toolchains for the release. + A list of strings representing the available toolchains for the release. Raises ------ - FileNotFoundError : - If the release directory does not exist. Run `create_dir_structure()` - first. + FileNotFoundError + If the release directory does not exist. Run `create_dir_structure()` first. """ + # Get the info for release release_base_dir = script_dir / mpsd_release if not os.path.exists(release_base_dir):