diff --git a/mpsd-software-environment.py b/mpsd-software-environment.py index 510aee799d22c5fb6ee89a3117a54e70af5a7eaa..0b8ca746f27e1b0b0a50a1dbf46e6e206cfad372 100755 --- a/mpsd-software-environment.py +++ b/mpsd-software-environment.py @@ -120,7 +120,7 @@ def setup_log_cmd( def create_dir_structure(mpsd_release: str, script_dir: Path) -> None: """ Create the directory structure and clone spack environments repo. - + The create_dir_structure function creates the directory structure for the specified release and clones the Spack environments repository if it doesn't exist. @@ -171,16 +171,16 @@ def get_release_info(mpsd_release: str, script_dir: Path) -> Tuple[str, str, Lis Args ---- - mpsd_release : str + mpsd_release : str the name of the release to get information for. - script_dir : pathlib.Path + script_dir : pathlib.Path the base directory where releases are stored. Returns ------- - spe_branch : str + spe_branch : str the name of the branch for the Spack environments repository. - spe_commit_hash : str + spe_commit_hash : str the commit hash for the Spack environments repository. available_toolchains : list a list of strings representing the available @@ -188,7 +188,7 @@ def get_release_info(mpsd_release: str, script_dir: Path) -> Tuple[str, str, Lis Raises ------ - Exception : + Exception : If the release directory does not exist. Run `create_dir_structure()` first. """ @@ -219,7 +219,7 @@ def get_release_info(mpsd_release: str, script_dir: Path) -> Tuple[str, str, Lis def prepare_environment(mpsd_release: str, script_dir: Path) -> List[str]: """ - Creates + Creates - Creates the directory structure for the given MPSD release and clones the spack-environments repository. - Determines the branch and commit hash of the spack-environments repository and