Skip to content

Add the xTB backends to environment.yml - #72

Merged
galjos merged 1 commit into
mainfrom
environment-yml-backends
Jul 6, 2026
Merged

Add the xTB backends to environment.yml#72
galjos merged 1 commit into
mainfrom
environment-yml-backends

Conversation

@galjos

@galjos galjos commented Jul 6, 2026

Copy link
Copy Markdown
Member

environment.yml already installed DFTB+ but predates the xTB engines (#68, #70). Add the xTB backends so conda env create -f environment.yml provisions every calculation engine in one command.

dependencies:
  - python>=3.12
  - dftbplus        # DFTB+ engine: `dftb+` and `modes`
  - xtb             # native xtb binary, for --engine xtb-cli
  - tblite-python   # GFN-xTB via tblite, for --engine xtb
  - pip
  - pip:
      - "-e .[test,lint]"

After conda env create -f environment.yml && conda activate thermoscreening, thermo doctor reports every backend as found (pairs with #71). README updated to say the env covers all backends.

Verified the three backends resolve on conda-forge (dftbplus-25.1 nompi, xtb-6.6.1, tblite-python-0.3.0); YAML validated.

This is the "installable through the project" follow-up: the compiled backends (DFTB+/modes/xtb/tblite) can't be pip-installed, so the conda env is how the project bundles them, while thermo setup-dftb handles the Slater-Koster and GBSA parameter files.

The Conda environment already installed DFTB+; add the xTB engines' backends so
`conda env create -f environment.yml` provisions every calculation engine:
- xtb -- the native binary for `--engine xtb-cli`
- tblite-python -- GFN-xTB via tblite for `--engine xtb`

Also note in the README that the environment now covers all backends and that
`thermo doctor` should then report them all as found.
@codecov

codecov Bot commented Jul 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.66%. Comparing base (b87b46c) to head (2448873).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #72   +/-   ##
=======================================
  Coverage   96.66%   96.66%           
=======================================
  Files          24       24           
  Lines        1527     1527           
=======================================
  Hits         1476     1476           
  Misses         51       51           
Flag Coverage Δ
unittests 96.66% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@galjos
galjos merged commit 46c8d93 into main Jul 6, 2026
3 checks passed
@galjos
galjos deleted the environment-yml-backends branch July 6, 2026 09:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant