Metadata-Version: 2.1
Name: tools4vasp
Version: 0.0.2
Summary: Python tools for VASP
Home-page: https://github.com/Tonner-Zech-Group/VASP-tools
Author: Patrick Melix
Author-email: Patrick Melix <patrick.melix@uni-leipzig.de>
Project-URL: Homepage, https://github.com/Tonner-Zech-Group/VASP-tools
Project-URL: Issues, https://github.com/Tonner-Zech-Group/VASP-tools/issues
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Unix Shell
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Chemistry
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ase >=1.0
Requires-Dist: matplotlib >=3.8.4
Requires-Dist: natsort >=8.3.1
Requires-Dist: numpy >=1.24.3
Requires-Dist: pymatgen >=2023.5.10

# VASP-tools

Our collection of tools for pre- and post-processing VASP calculations. Mainly Python and Bash.

## Installation

Clone this repository and run `pip install .` inside the main directory. If you want to always use the latest content of the repo you can use the 'developement' install of pip by running `pip install -e .`. Just doing `git pull` to get the latest content of the repo will then automatically result in the usage of the latest code without need to reinstall.

You can also use the latest release by installing it from PyPi:

```bash
pip install orcatools
```

## Dependencies

Different for each script, but mainly

- [ASE](https://wiki.fysik.dtu.dk/ase/)
- [VTST](http://theory.cm.utexas.edu/vtsttools/)
- [Pymatgen](https://pymatgen.org/)
- [Geodesic Interpolation](https://github.com/virtualzx-nad/geodesic-interpolate)

## Pre-Processing

- freq2mode: generates MODECAR and mass-weighted MODCAR files from frequency calculations

## Post-Processing

- chgcar2cube.py: Convert CHGCAR-like files to cube files using Pymatgen and ASE.
- neb2movie.py: Convert VASP NEB to ASE ext-xyz movie, just like nebmovie.pl of VTST.
- poscar2nbands.py: Helper to get the NBANDS value for LOBSTER calculations using the current POSCAR, INCAR and POTCAR setup with 'standard' options.
- vasp2traj.py: Convert VASP geometry optimization output to ASE compatible ext-xyz trajectory file.
- vasp-check.py: Assert proper occupations and SCF+GO convergence in VASP using ASE.
- vaspGetEF.py: Creates a plot of energy and forces along multiple GO runs (e.g. for restart jobs). Gathers data in all numeric subfolders and this folder containing a vasprun.xml file (depth one) and combines them in a single plot.
- visualize-magnetization.sh: Creates a VMD visualisation state file for the magnetization denisty by splitting the CHGCAR (by running chgsplit.pl), converting it to a cube file (by running chgcar2cube.sh) and then creating representations for VMD.
- viewMode.py: Shows a graphical preview of a MODECAR file using ase gui
- plotIRC: Tool that creates a plot of VASP IRC calculations in both direction and is compatible with shifts in the starting structure.
- replace_potcar_symlinks.sh: Searches for POTCARS in subdirs and replaces them with symlinks. CAREFUL!
