Skip to content

CLI Module

easy_pmf.cli

Command Line Interface for Easy PMF.

This module provides command-line tools for PMF analysis.

Functions

main 

main()

Main entry point for the easy-pmf command-line tool.

Source code in src/easy_pmf/cli.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
def main() -> None:
    """Main entry point for the easy-pmf command-line tool."""
    parser = argparse.ArgumentParser(
        description="Easy PMF - Command Line Interface for Positive Matrix "
        "Factorization",
        formatter_class=argparse.RawDescriptionHelpFormatter,
        epilog="""
Examples:
  easy-pmf --interactive          # Interactive dataset selection
  easy-pmf --analyze-all          # Analyze all datasets in data/ folder
  easy-pmf --help                 # Show this help message

For more information, visit: https://github.com/easy-pmf/easy-pmf
        """,
    )

    parser.add_argument(
        "--interactive",
        "-i",
        action="store_true",
        help="Run interactive analysis (default)",
    )

    parser.add_argument(
        "--analyze-all",
        "-a",
        action="store_true",
        help="Analyze all datasets automatically",
    )

    parser.add_argument(
        "--data-dir",
        type=str,
        default="data",
        help="Directory containing data files (default: data)",
    )

    parser.add_argument(
        "--output-dir",
        type=str,
        default="output",
        help="Directory for output files (default: output)",
    )

    parser.add_argument(
        "--factors",
        "-f",
        type=int,
        default=7,
        help="Number of PMF factors (default: 7)",
    )

    parser.add_argument("--version", "-v", action="version", version="Easy PMF 0.1.0")

    args = parser.parse_args()

    # If no specific mode is chosen, default to interactive
    if not args.analyze_all:
        args.interactive = True

    try:
        if args.interactive:
            run_interactive_analysis(args)
        elif args.analyze_all:
            run_batch_analysis(args)
    except KeyboardInterrupt:
        print("\nAnalysis cancelled by user.")
        sys.exit(1)
    except Exception as e:
        print(f"Error: {e}")
        sys.exit(1)

run_interactive_analysis 

run_interactive_analysis(args)

Run interactive analysis mode.

Source code in src/easy_pmf/cli.py 
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
def run_interactive_analysis(args: argparse.Namespace) -> None:
    """Run interactive analysis mode."""
    print("🌟 Welcome to Easy PMF Interactive Analysis!")
    print("=" * 50)

    # Try to import and run the quick analysis
    try:
        import quick_analysis

        # Set up arguments for quick_analysis
        sys.argv = ["quick_analysis"]  # Reset sys.argv to avoid conflicts
        quick_analysis.main()
    except ImportError:
        print("Error: Could not import analysis modules.")
        print("Please ensure the package is properly installed.")
        sys.exit(1)

run_batch_analysis 

run_batch_analysis(args)

Run batch analysis on all datasets.

Source code in src/easy_pmf/cli.py 
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
def run_batch_analysis(args: argparse.Namespace) -> None:
    """Run batch analysis on all datasets."""
    print("🚀 Running batch analysis on all datasets...")
    print("=" * 50)

    try:
        import analyze_all_datasets

        # Set up arguments for analyze_all_datasets
        sys.argv = ["analyze_all_datasets"]  # Reset sys.argv to avoid conflicts
        analyze_all_datasets.main()
    except ImportError:
        print("Error: Could not import analysis modules.")
        print("Please ensure the package is properly installed.")
        sys.exit(1)