Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
M
mpsd-software-manager
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
MPSD Computational Science
mpsd-software-manager
Commits
6449b8c9
Commit
6449b8c9
authored
1 year ago
by
Ashwin Kumar Karnad
Browse files
Options
Downloads
Patches
Plain Diff
Try to fix doc string of get_release_info
parent
59061ac3
No related branches found
Branches containing commit
No related tags found
3 merge requests
!19
Move linux-debian11 into main
,
!13
Restructure doc strings
,
!11
Making docstrings comply with numpydoc
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
mpsd-software-environment.py
+11
-12
11 additions, 12 deletions
mpsd-software-environment.py
with
11 additions
and
12 deletions
mpsd-software-environment.py
+
11
−
12
View file @
6449b8c9
...
@@ -128,7 +128,7 @@ def create_dir_structure(mpsd_release: str, script_dir: Path) -> None:
...
@@ -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 create_dir_structure function creates the directory structure for
the specified release and clones the Spack environments repository if it
the specified release and clones the Spack environments repository if it
doesn
'
t exist.
doesn
'
t exist.
Parameters
Parameters
----------
----------
- mpsd_release: A string representing the MPSD release version.
- 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
...
@@ -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
Get information about the specified release, such as the branch and commit hash
of the Spack environments repository and the available toolchains.
of the Spack environments repository and the available toolchains.
Arg
s
Parameter
s
----
----
------
mpsd_release : str
mpsd_release : str
t
he name of the release to get information for.
T
he name of the release to get information for.
script_dir : pathlib.Path
script_dir : pathlib.Path
t
he base directory where releases are stored.
T
he base directory where releases are stored.
Returns
Returns
-------
-------
spe_branch : str
spe_branch : str
t
he name of the branch for the Spack environments repository.
T
he name of the branch for the Spack environments repository.
spe_commit_hash : str
spe_commit_hash : str
t
he commit hash for the Spack environments repository.
T
he commit hash for the Spack environments repository.
available_toolchains : list
available_toolchains : list
a list of strings representing the available
A list of strings representing the available toolchains for the release.
toolchains for the release.
Raises
Raises
------
------
FileNotFoundError :
FileNotFoundError
If the release directory does not exist. Run `create_dir_structure()`
If the release directory does not exist. Run `create_dir_structure()` first.
first.
"""
"""
# Get the info for release
# Get the info for release
release_base_dir
=
script_dir
/
mpsd_release
release_base_dir
=
script_dir
/
mpsd_release
if
not
os
.
path
.
exists
(
release_base_dir
):
if
not
os
.
path
.
exists
(
release_base_dir
):
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment