Skip to content

Commit

Permalink
wip #54 update README about OMP_NUM_THREADS and xTB
Browse files Browse the repository at this point in the history
  • Loading branch information
joshkamm committed Feb 15, 2024
1 parent bc20e47 commit b47306a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,8 +128,8 @@ Notes:

* The venv or conda environment containing py-conformational-sampling should be activated when using the library
* Since openbabel is used to interpret the input file, any openbabel supported molecular file format can be used as input with slight modification (e.g. `stk_ligand = load_stk_mol(ligand_path, fmt='mol')` for a mol file)
* It is recommended that the environment variable OMP_NUM_THREADS is set to "1". If unset, it seems that xTB attempts to use multiple threads for each individual conformer, and this can be an order of magnitude less efficient than parallelizing over conformers. Py-conformational-sampling sets OMP_NUM_THREADS in its package's `__init__.py` file, but this will not take effect if you import xtb before conformational_sampling
* Binding atoms may be alternatively supplied by specifying the element and index of binding atoms based on zero-indexed ordering in the ligand structure file (example excerpt below)
* It is recommended that the environment variable OMP_NUM_THREADS is set to "1". Otherwise it seems that xTB attempts to use threads for each individual conformer and that this can be an order of magnitude less efficient than parallelizing over conformers.

```python
functional_groups = [stk.SingleAtom(stk.C(73)), stk.SingleAtom(stk.O(22))]
Expand Down

0 comments on commit b47306a

Please sign in to comment.