Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Aims profile update #313

Merged
merged 26 commits into from
Jun 14, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
35246d6
update constructing aims profile if command or species dir are given
gelzinyte Jun 4, 2024
4853594
fix typos
gelzinyte Jun 4, 2024
0dcc924
"profile" can also be provided among kwargs, no overwritting
gelzinyte Jun 4, 2024
a1f22d8
typo in variable name
gelzinyte Jun 4, 2024
955bb92
typos
gelzinyte Jun 5, 2024
084861d
resotre util function that is used by other calculators than aims
gelzinyte Jun 5, 2024
ffd4b36
trial asev3.23 test and dropping modification of ase keywords
gelzinyte Jun 5, 2024
72f9777
update aims tests to work with ase's config file
gelzinyte Jun 10, 2024
9af635b
add xfails until qe is upated
gelzinyte Jun 10, 2024
499e593
update CI tests to use latest pip ase version
gelzinyte Jun 10, 2024
0637dcd
bug fixes in unit tests
gelzinyte Jun 10, 2024
bd28478
partial docs update
gelzinyte Jun 10, 2024
a8e08f9
finish doc updates
gelzinyte Jun 10, 2024
43962cc
undo removing ace fitting docs
gelzinyte Jun 10, 2024
5d379ec
debug github CI
gelzinyte Jun 10, 2024
8615ed8
docs typos
gelzinyte Jun 11, 2024
7dcd9fb
specify ase version for CI
gelzinyte Jun 11, 2024
736a943
specify a dummy aims command directly, not via an ase configuration
gelzinyte Jun 11, 2024
8caa60f
move wst test to a subdirectory
gelzinyte Jun 12, 2024
6f5a235
change my mind about the name
gelzinyte Jun 12, 2024
2ed00fc
more specific name to the test configuration
gelzinyte Jun 12, 2024
7a62831
rename/move local test scripts
gelzinyte Jun 12, 2024
c730f0c
remove imported unused warnings
gelzinyte Jun 13, 2024
699172e
update ase version and docs
gelzinyte Jun 14, 2024
3728749
Tweak text on wfl-ase version compatibility in README and top level d…
bernstei Jun 14, 2024
c185f6d
typos
gelzinyte Jun 14, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/pytests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ jobs:

- name: Install latest ASE from gitlab
run: |
python3 -m pip install ase==3.23.0
python3 -m pip install ase
echo -n "ASE VERSION "
python3 -c "import ase; print(ase.__file__, ase.__version__)"

Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,12 @@ The main functions of Workflow is to efficiently parallelise operations over a s

For examples and more information see [documentation](https://libatoms.github.io/workflow/)

NOTE: because of the very large time intervals between official ASE releases, `wfl` is typically
set up for (and tested against) the latest ASE gitlab repo `master` branch. Recent changes
that require this support include variable cell minimization using `FrechetCellFilter` and
`Espresso` calculator configuration. See documentation link above for installation instructions.
`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).


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

.. code-block:: sh

python3 -m pip install git+https://github.com/libAtoms/workflow
pip install wfl

.. warning::
.. note::

`wfl` requires ASE, so `ase` is listed as a `pip` dependency,
and if not already installed, `pip install` will install the latest
`pypi` release. However, because of the large delay in producing new
releases, the latest `pypi` version is often quite old, and `wfl`
has some functionality that requires a newer version. To ensure
a sufficiently up-to-date version is available, before installing
`wfl` install the latest `ase` from gitlab, with a command such as

.. code-block:: sh
`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).

python3 -m pip install git+https://gitlab.com/ase/ase

***************************************
Repository
Expand Down
Loading