aboutsummaryrefslogtreecommitdiffstats
path: root/scripts/results.py
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/results.py')
-rwxr-xr-xscripts/results.py17
1 files changed, 17 insertions, 0 deletions
diff --git a/scripts/results.py b/scripts/results.py
index 7536e2f..1bf504e 100755
--- a/scripts/results.py
+++ b/scripts/results.py
@@ -13,6 +13,23 @@ Manage the analysis results in YAML format.
import manifest
+def get_results(filename="results.yaml"):
+ """
+ Find the results file and return the Manifest instance of it.
+
+ Parameters
+ ----------
+ filename : str, optional
+ Filename of the results file (default: ``results.yaml``)
+
+ Returns
+ -------
+ results : `~Manifest`
+ Manifest instance (i.e., results) of the found results file.
+ """
+ return manifest.get_manifest(filename)
+
+
def main(description="Manage the analysis results (YAML format)",
default_file="results.yaml"):
manifest.main(description=description, default_file=default_file)