Skip to content

CLI API

AID2E CLI package.

Modular command-line interface with organized command categories: - Config commands: describe, inspect, validate - Workflow commands: optimize, run (future) - Utility commands: list, version

The CLI can be imported in two ways for backward compatibility

from aid2e.cli.aid2e_cli import cli # Legacy from aid2e.cli import cli # Preferred

cli()

AID2E - AI assisted Detector Design for EIC.

A framework for optimization of detector designs and other complex systems.

Commands are organized into categories:

 Configuration Inspection: describe - Quick summary of config files (auto-detects type) inspect - Detailed configuration view with section filtering validate - Validate configuration syntax and structure

 Workflow Execution: optimize - Run optimization from configuration

 Utilities: list - Show available optimizers/templates/problems version - Display version information

Source code in src/aid2e/cli/aid2e_cli.py 
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
@click.group()
@click.version_option(version=__MAIN_VERSION__, prog_name="aid2e")
def cli():
    """
    AID2E - AI assisted Detector Design for EIC.

    A framework for optimization of detector designs and other complex systems.

    Commands are organized into categories:

    \b
    Configuration Inspection:
      describe   - Quick summary of config files (auto-detects type)
      inspect    - Detailed configuration view with section filtering
      validate   - Validate configuration syntax and structure

    \b
    Workflow Execution:
      optimize   - Run optimization from configuration

    \b
    Utilities:
      list       - Show available optimizers/templates/problems
      version    - Display version information
    """
    pass