Skip to content

Commit

Permalink
Tweak text on wfl-ase version compatibility in README and top level d…
Browse files Browse the repository at this point in the history
…ocs file
  • Loading branch information
bernstei committed Jun 14, 2024
1 parent 699172e commit 3728749
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 11 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,9 @@ For examples and more information see [documentation](https://libatoms.github.io

`wfl` its dependendensies may be installed vi `pip install wfl`.

NOTE: `wfl` is only tested against the latest ASE pip release, currently v3.23.
For the time being, ASEv3.22 is allowed with the most recent branch of `wfl`, hoewever,
not fully supported (e.g. the correct file-based calculator keywords must be specified
by the user).

NOTE: (as of 14 June 2024) `wfl` is only tested against the latest ASE pip release, currently v3.23.0.
For the time being, v3.22.1 is the mininum version listed as a (pip) prerequisite of `wfl`, because
it at least mostly works, but it may not be fully compatible and is not actively tested.

# Recent changes

Expand Down
12 changes: 6 additions & 6 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ Quick start that installs all of the mandatory dependencies:

.. code-block:: sh
pip install wfl
python3 -m pip install wfl
.. note::


`wfl` is only tested against the latest ASE pip release, currently v3.23.
For the time being, ASEv3.22 is allowed with the most recent branch of `wfl`, hoewever,
not fully supported (e.g. the correct file-based calculator keywords must be specified
by the user).
(as of 14 June 2024) `wfl` is only tested against the latest
ASE pip release, currently v3.23.0. For the time being, v3.22.1 is
the mininum version listed as a (pip) prerequisite of `wfl`, because
it at least mostly works, but it may not be fully compatible and is
not actively tested.


***************************************
Expand Down

0 comments on commit 3728749

Please sign in to comment.