Skip to content

Add FHI-aims setup instructions to docs - #3553

Merged
Andrew-S-Rosen merged 1 commit into
mainfrom
docs/fhi-aims-setup
Oct 28, 2026
Merged

Andrew-S-Rosen merged 1 commit into
mainfrom
docs/fhi-aims-setup

Conversation

@Andrew-S-Rosen

@Andrew-S-Rosen Andrew-S-Rosen commented Oct 28, 2026 •

Copy link
Copy Markdown
Member

Summary

Adds an FHI-aims section to the calculator setup page (docs/install/codes.md), placed alphabetically after EMT.

It documents the three settings defined in src/quacc/settings.py:

  • AIMS_BIN — path to the FHI-aims executable (default aims.x)
  • AIMS_PARALLEL_CMD — parallelization prefix, without the executable
  • AIMS_SPECIES_DEFAULTS — path to a species-defaults set such as defaults_2020; the recipes append light/intermediate/tight/really_tight via the species_defaults kwarg, so that subdirectory should not be included

Includes an example ~/.bashrc block using the QUACC_-prefixed env vars, matching the style of the other code sections.

Also loosens the species_defaults type hint in static_job and relax_job (src/quacc/recipes/aims/core.py) from a Literal to str, since any species-defaults subdirectory name is valid. The docstrings now list light/intermediate/tight/really_tight as common options rather than the only ones.

https://claude.ai/code/session_01Dnd4tTW68q7UCigEQtcNm5


Generated by Claude Code

@Andrew-S-Rosen
Andrew-S-Rosen merged commit 1b457a2 into main Oct 28, 2026
20 of 21 checks passed
@Andrew-S-Rosen
Andrew-S-Rosen deleted the docs/fhi-aims-setup branch October 28, 2026 22:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants