Skip to content

Commit

Permalink
Merge pull request #14 from openkim/devel
Browse files Browse the repository at this point in the history
Update version to be compatible with kim-api 2.3.0
  • Loading branch information
mjwen authored Aug 18, 2022
2 parents a5e0f3a + eb839d3 commit 054b0ac
Show file tree
Hide file tree
Showing 9 changed files with 35 additions and 40 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/pythonpublish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
- name: Install kim-api
run: |
export KIMPY_DIR=${PWD}
export KIM_API_VERSION="2.2.1"
export KIM_API_VERSION="2.3.0"
cd $KIMPY_DIR && cd ..
wget http://s3.openkim.org/kim-api/kim-api-$KIM_API_VERSION.txz
tar Jxvf kim-api-$KIM_API_VERSION.txz
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/testing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- name: Install kim-api
run: |
export KIMPY_DIR=${PWD}
export KIM_API_VERSION="2.2.1"
export KIM_API_VERSION="2.3.0"
cd $KIMPY_DIR && cd ..
wget http://s3.openkim.org/kim-api/kim-api-$KIM_API_VERSION.txz
tar Jxvf kim-api-$KIM_API_VERSION.txz
Expand Down Expand Up @@ -80,7 +80,7 @@ jobs:
- name: Install kim-api
run: |
export KIMPY_DIR=${PWD}
export KIM_API_VERSION="2.2.1"
export KIM_API_VERSION="2.3.0"
cd $KIMPY_DIR && cd ..
mkdir -p KIM_API && cd KIM_API
export KIM_API_DIR=$PWD
Expand Down Expand Up @@ -157,7 +157,7 @@ jobs:
- name: Install KIM-API
run: |
export KIMPY_DIR=${PWD}
export KIM_API_VERSION="2.2.1"
export KIM_API_VERSION="2.3.0"
cd $KIMPY_DIR && cd ..
wget http://s3.openkim.org/kim-api/kim-api-$KIM_API_VERSION.txz
tar Jxvf kim-api-$KIM_API_VERSION.txz
Expand Down
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ jobs:
before_install:
# environment variable
- export KIMPY_DIR=$PWD ;
- export KIM_API_VERSION="2.2.1"
- export KIM_API_VERSION="2.3.0"

- if [ "$TRAVIS_OS_NAME" = "osx" ]; then
python3 --version ;
Expand Down
32 changes: 24 additions & 8 deletions CHANGELOG.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,39 @@
Change Log
==========

v2.0.1 (2022/08/18)
===================

- Include generated binding and testing file in the repo, instead of generating
them in the setup.py file. This means each time we modify the source template
file, we need to run `$ python scripts/generate_all.py` manually
- Drop python3.6 support
- Update to be compatible with kim-api-2.3.0


v2.0.0 (2021/04/26)
===================

This release is not backward compatible.

- remove the manual memory management. There is no need to destroy the KIM-API objects in Python explicitly. By using smart pointers with custom deleters, Python controls the ownership of newly created objects, and the garbage collector module is tracking their status.
- the interface is updated, and no error message returns from the KIM-API to the users. It throws a RuntimeError exception with a print indicating what went wrong in case of an error.
- input and return arguments are now in lower case.
- methods are provided with a docstring explaining the purpose.
- NeighList module is updated. One uses NeighList() class to create an instance of the NeighList object and calls its methods.
- find example usage at kimpy/examples/
- Remove the manual memory management. There is no need to destroy the KIM-API
objects in Python explicitly. By using smart pointers with custom deleters,
Python controls the ownership of newly created objects, and the garbage
collector module is tracking their status.
- The interface is updated, and no error message returns from the KIM-API to the
users. It throws a RuntimeError exception with a print indicating what went
wrong in case of an error.
- Input and return arguments are now in lower case.
- Methods are provided with a docstring explaining the purpose.
- NeighList module is updated. One uses NeighList() class to create an instance
of the NeighList object and calls its methods.
- Find example usage at kimpy/examples/


v0.3.3 (2019/10/28)
==================

- update setup.py to not explicitly use `pip` and `python`
- Update setup.py to not explicitly use `pip` and `python`

- remove pybind11==2.2.3 version dependence, since the `get_include()` of
- Remove pybind11==2.2.3 version dependence, since the `get_include()` of
pybind11 is fixed
22 changes: 0 additions & 22 deletions TODO

This file was deleted.

4 changes: 2 additions & 2 deletions api_compatibility.py
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ def check_kim_api_compatibility(kimpy_version, kim_api_version):
msg3 += "latest kimpy, which is not compatible "
msg3 += "with this\n KIM-API version "
msg3 += '"{}" yet. Please contact\n '.format(kim_api_version)
msg3 += "Mingjian Wen (wenxx151@umn.edu) or\n "
msg3 += "Mingjian Wen (wenxx151@gmail.com) or\n "
msg3 += "raise an issue on github so we update the kimpy.\n"
else:
compatible_kimpy = suggest_kimpy(kim_api_version, compatible_table)
Expand All @@ -190,5 +190,5 @@ def check_kim_api_compatibility(kimpy_version, kim_api_version):


if __name__ == "__main__":
kim_api_compatibility = check_kim_api_compatibility("0.2.3", "2.0.1")
kim_api_compatibility = check_kim_api_compatibility("2.0.1", "2.3.0")
print(kim_api_compatibility)
3 changes: 2 additions & 1 deletion api_compatibility.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#
# To update kimpy version (in kimpy/__init__.py) and kim-api version (in .travis.yml),
# append to this table and then run:
# $ python scripts/update_version.py
# $ python utils/update_version.py
#

# kimpy-version target-api-version backward-compatible-api-version
Expand All @@ -20,3 +20,4 @@
0.3.4 2.2.0 2.2.0
1.0.0 2.2.1 2.2.0
2.0.0 2.2.1 2.2.1
2.0.1 2.3.0 2.2.1
2 changes: 1 addition & 1 deletion kimpy/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = "2.0.0"
__version__ = "2.0.1"

# import all modules
from . import model
Expand Down
2 changes: 1 addition & 1 deletion utils/update_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ def update_version(version, path, key, in_quotes=False, extra_space=False):
path = os.path.join(kimpy_dir, ".travis.yml")
update_version(api_v, path, "export KIM_API_VERSION", in_quotes=True)

path = os.path.join(kimpy_dir, ".github/workflows/pythonpackage.yml")
path = os.path.join(kimpy_dir, ".github/workflows/testing.yml")
update_version(api_v, path, "export KIM_API_VERSION", in_quotes=True)
path = os.path.join(kimpy_dir, ".github/workflows/pythonpublish.yml")
update_version(api_v, path, "export KIM_API_VERSION", in_quotes=True)

0 comments on commit 054b0ac

Please sign in to comment.