Enhance

[Hsuchein]

No description provided.

[Copilot]

Pull request overview

This PR refreshes MAPLE’s example frequency inputs/outputs and adds extensive internal documentation/planning notes, alongside a README overhaul and removal of older example inputs/scripts.

Changes:

• Updated multiple example/freq/mw/* input files to use new absolute XYZ paths and refreshed corresponding .out reference outputs.
• Added substantial documentation under claude/ and introduced ARCHITECTURE.md; updated README.md.
• Removed several older frequency example input files and a helper script.

Reviewed changes

Copilot reviewed 33 out of 277 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
example/freq/mw/test4_inp1_nebts_ts.inp	Updates XYZ path reference to a Linux absolute path
example/freq/mw/test3_inp1_nebts_ts.out	Updates reference output formatting/content for freq run
example/freq/mw/test3_inp1_nebts_ts.inp	Updates XYZ path reference to a Linux absolute path
example/freq/mw/test2_inp1_nebts_ts.out	Updates reference output formatting/content for freq run
example/freq/mw/test2_inp1_nebts_ts.inp	Updates XYZ path and includes treat_imag_as_real=Ture
example/freq/mw/test1_inp1_nebts_ts.out	Expands reference output with banner/config/timing sections
example/freq/mw/test1_inp1_nebts_ts.inp	Updates XYZ path reference to a Linux absolute path
example/freq/mw/inp2.out	Tweaks reference output values/formatting and timing section
example/freq/mw/inp1.out	Updates reference output formatting/content for freq run
example/freq/mw/inp1.inp	Normalizes path casing in XYZ reference
example/freq/freq_xnr.inp	Removes legacy freq example input
example/freq/freq_traj.py	Removes legacy helper script
example/freq/freq_d4.inp	Removes legacy freq example input
example/freq/freq_ccx.inp	Removes legacy freq example input
example/freq/freq.inp	Removes legacy freq example input
claude/summary/summary.md	Adds large generated summary doc (includes absolute paths)
claude/summary/framework_overview.md	Adds framework overview doc
claude/summary/autoneb_algorithm.md	Adds AutoNEB algorithm doc
claude/plan/sdcg_fusion_plan.md	Adds SDCG optimizer implementation plan
claude/plan/sd_diis_refactor_plan.md	Adds SD/DIIS refactor plan
claude/knowledge/collaboration_notes.md	Adds collaboration knowledge base notes
claude/done/md_phase1_completion.md	Adds MD Phase 1 completion report
README.md	Rewrites README structure and content
ARCHITECTURE.md	Adds architecture summary document

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

treat_imag_as_real=Ture is a misspelling that can break boolean parsing and change runtime behavior. Change it to True (or the project’s accepted boolean literal) to ensure the option is applied as intended.

Suggested change

	#freq(method=nonmw, temperature=298, verbosity=2, treat_imag_as_real=Ture, pressure_kpa=300,ilow=3)
	#freq(method=nonmw, temperature=298, verbosity=2, treat_imag_as_real=True, pressure_kpa=300,ilow=3)

[Copilot]

These example inputs hard-code an absolute filesystem path, which makes the examples non-portable and will fail on other machines/CI. Prefer a repo-relative path (e.g., XYZ example/freq/mw/inp1_nebts_ts.xyz) or a documented placeholder/environment variable (e.g., ${MAPLE_ROOT}/...).

Suggested change

	XYZ /home/user/software/MAPLE/example/freq/mw/inp1_nebts_ts.xyz
	XYZ example/freq/mw/inp1_nebts_ts.xyz

[Copilot]

The documentation embeds a machine-specific absolute repo path. To keep docs reusable for other developers and CI, replace it with a repo-relative reference (e.g., <repo_root>/) or describe the path as an example rather than a fixed location.

[Copilot]

There is a missing space in the output text (completedOutput). If these .out files are meant as golden/reference outputs, fix the generator to emit Frequency analysis completed Output file: ... (or split into two sentences/lines) and update the references accordingly.

Suggested change

	Frequency analysis completedOutput file: /home/user/software/MAPLE/example/freq/mw/test1_inp1_nebts_ts.out
	Frequency analysis completed Output file: /home/user/software/MAPLE/example/freq/mw/test1_inp1_nebts_ts.out

[Copilot]

The README installation section groups fairchem-core under “ML potentials” but doesn’t clarify which models require it (e.g., UMA) versus other backends (ANI/AIMNet2/MACE) that may need different packages. Consider listing dependencies per-backend (UMA vs ANI vs AIMNet2 vs MACE) to prevent failed installs from incomplete dependency sets.

Suggested change

	# ML potentials
	pip install fairchem-core
	# ML potentials (install only the backends you plan to use)
	# UMA backend (uses fairchem-core)
	pip install fairchem-core
	# ANI backend
	pip install torchani
	# AIMNet2 backend
	pip install aimnet2
	# MACE backend
	pip install mace-torch