aboutsummaryrefslogtreecommitdiffstats
path: root/acispy/results.py
blob: 5d454a670261d496bca6ba0707f41a7031a5aedd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# Copyright (c) 2017 Weitian LI <liweitianux@live.com>
# MIT license
#
# Weitian LI
# 2017-02-11

"""
Manage the analysis results in YAML format.
"""

from . 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)