Metadata-Version: 2.4
Name: poshcar
Version: 2.1.1
Summary: Crystal structure engine for VASP POSCAR files
Author-email: Andy Paul Chen <la.vache.qui.vit@gmail.com>
License: MIT License
        
        Copyright (c) 2020-2024 Andy Paul Chen
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Keywords: unit cell
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: ase
Requires-Dist: pyvis
Requires-Dist: rdkit
Requires-Dist: scipy
Requires-Dist: pymatgen
Requires-Dist: chgnet
Requires-Dist: nglview
Requires-Dist: pandas
Requires-Dist: networkx
Dynamic: license-file

<img src="graphics/POSHCAR-LOGO.png" width="400" align="center">

# Poshcar - VASP POSCAR text editor package<br>
Author: Andy Paul Chen (MSE, Nanyang Technological University)

## Introduction
POSHCAR started as a cabin fever project during the first COVID lockdowns in the United States. It is a simple and lightweight text-based engine for generating and editing files in VASP format, which is one of the simplest and most compact descriptions of a crystal structures currently in use. The development follows an organic and modular development model where new functions are written whenever a project-specific need arises, so expect many changes as I hop from project to project.

## How to use demo file
Demo notebooks are organised into 3 parts:<br>
**Core modules:** Basic operations<br>
**Cell-building modules:** Functions that lets you generate unit cells, e.g. supercells, organic molecules, slabs<br>
**Analytics:** Functions involving statistical analysis of a unit cell, e.g. bonding behaviour<br>

The output of the demo operations can be seen in the `tests/_demo/` folder.

## Modules
Interdependencies of modules are illustrated in the diagram below. The dependency relationship is marked with arrows (dependent -> core). Please use this graph for your reference if you would like to add to Poshcar!<br><br>
<img src="graphics/dependencygraph.png" width="700" align="center">

## Dependencies
ase, pyvis, rdkit, scipy, pymatgen, chgnet, pandas, networkx

## How to install
<b>PyPI release: </b>`pip install poshcar`<br>
<b>Current github instance: </b>`pip install git+https://github.com/andypaulchen/poshcar.git`<br>
<b>Developer install (FAFO) version: </b>Download the package, `cd` to the folder where `setup.py` is, and then run the edit mode pip install (`pip install -e .`).<br>

## Changelog
You can visit the changelog in `docs/changelog.txt` for a short summary of changes I made over the years. I'm a bit lazy in the documentation, though.<br>
**Current version:** 2.1.1<br>
**Last update:** 19 January 2026

