py4vasp

Please note that this document is intended mostly for developers that want to use the version of py4vasp provided on Github. If you just want to install py4vasp to use it, please follow the official documentation.

Installation

We use the poetry dependency manager which takes care of all dependencies and maintains a virtual environment to check the code. If you want to test something in the virtual environment, just use e.g. poetry run jupyter-notebook.

Using poetry installing and the code requires the following steps. The last step will test whether everything worked

git clone [email protected]:vasp-dev/py4vasp.git
pip install poetry
poetry install
poetry run pytest

Note that this will install py4vasp into a virtual environment managed by poetry. This isolates the code from all other packages you have installed and makes sure that when you modify the code all the relevant dependencies are tracked.

Occasionally, we encountered errors when installing the mdtraj dependency in this fashion, in particular on MacOS and Windows. If you notice the same behavior, we recommend to manage your environment with conda and install py4vasp in the following manner

git clone [email protected]:vasp-dev/py4vasp.git
conda create --name py4vasp-env python=3.8
conda activate py4vasp-env
conda install -c conda-forge poetry
conda install -c conda-forge mdtraj
poetry install
poetry run pytest

py4vasp core

If you want to use py4vasp to develop your own scripts, you may want to limit the amount of external dependencies. To this end, we provide alternative configuration files that only install numpy, h5py, and the development dependencies. To install this core package replace the configurations files in the root folder with the ones in the core folder

cp core/* .

Then you can install py4vasp with the same steps as above. Note that some tests will be skipped because they require the external packages to run.

If you want to exclude even the development dependencies, you can run

poetry install --without dev

for the minimal installation.

Code style

Code style is enforced, but is not something the developer should spend time on, so we decided on using black and isort. Please run

black src tests
isort src tests

before committing the code. This will autoformat your code and sort the import statements in a consistent order. If you would like this code formatting to be done along with each commit, you can run

pre-commit install

Contributing to py4vasp

We welcome contributions to py4vasp. To improve the code please follow this workflow

• Create an issue for the bugfix or feature you plan to work on, this gives the option to provide some input before work is invested.
• Implement your work in a fork of the repository and create a pull request for it. Please make sure to test your code thoroughly and commit the tests in the pull request in the tests directory.
• In the message to your merge request mention the issue the code attempts to solve.
• We will try to include your merge request rapidly when all the tests pass and your code is covered by tests.

Please limit the size of a pull request to approximately 200 lines of code otherwise reviewing the changes gets unwieldy. Prefer splitting the work into multiple smaller chunks if necessary.