Warning, /AID2E-framework/docs/README.md is written in an unsupported language. File is not indexed.
0001 # AID2E Framework
0002
0003 AI assisted Detector Design for EIC (AID2E) is a Python toolkit for authoring and validating detector design optimization workflows. It provides typed configuration models, a Click-based CLI, scheduler/optimizer hooks, and ePIC-specific utilities. Docs: https://aid2e.github.io/AID2E-framework
0004
0005 ## Repository Layout
0006
0007 - src/aid2e/ main package (CLI at aid2e.cli, optimizers, schedulers, utilities)
0008 - tests/ mirrored test suite, including fixtures for DTLZ2 and ePIC configs
0009 - docs/ MkDocs site sources (published to GitHub Pages)
0010 - scripts/ helper scripts for docs build/deploy
0011 - packages/ legacy package splits (kept for reference; primary code now lives under src/)
0012
0013 ## Quickstart
0014
0015 ```bash
0016 python -m venv .venv
0017 source .venv/bin/activate
0018 pip install -e .
0019
0020 # Run tests
0021 pytest -v
0022
0023 # Try the CLI
0024 aid2e --help
0025 aid2e version
0026 ```
0027
0028 ## Using Configuration Loaders
0029
0030 - Load a problem + design config:
0031
0032 ```python
0033 from aid2e.utilities.configurations import load_config
0034
0035 cfg = load_config("path/to/problem.config")
0036 print(cfg.problem.design_config.get_parameter_names())
0037 ```
0038
0039 - Example fixtures live in tests/test_utilities/fixtures/dtlz2/ (design.params, problem.config).
0040
0041 ## Developing
0042
0043 - Lint/format/type: black ., flake8, mypy (install extras with pip install -e ".[dev]")
0044 - Docs: pip install -e ".[docs]" && ./scripts/docs-serve.sh
0045 - Tests: pytest -v
0046
0047 ## Documentation
0048
0049 MkDocs site sources are under docs/ (Material theme). The navigation is defined in mkdocs.yml; API reference is generated via mkdocstrings.
0050
0051 ## Contributing
0052
0053 - Prefer adding tests alongside changes.
0054 - Keep imports under the aid2e namespace (aid2e.cli, aid2e.utilities.configurations, etc.).
0055 - Update docs and fixtures when changing configuration schemas.
