COGITO - Crystal Orbital Guided Iteration To atomic-Orbitals
This repository hosts the code for COGITO, a tool for obtaining quantum chemistry from plane wave DFT calculations. The main codes modules are COGITO, COGITOpost, COGITOanalyze, and COGITOico.
Installation
pip install --upgrade pip
pip install cogito-dft
To install optional dependences (scikit-image, dash, dash-ag-grid) that are used in some COGITOpost functions:
pip install "cogito-dft[plot]"
Running on HPC
As of verison 0.3.2, compute heavy sections of COGITO.py are parallelized. Control the number of jobs and avoid thread oversubscription with:
#SBATCH -N 1
#SBATCH -n 1
#SBATCH --cpus-per-task=4
export OMP_NUM_THREADS=1
Quick Start
Visit the live website: cogito-dft.readthedocs.io
| Section | Description |
|---|---|
| Tutorial | Step-by-step analysis workflow |
| File Guide | Interactive guide of inputs and outputs |
| API Docs | Complete function reference |
Basic Workflow:
- Run VASP - Static calculation with saved wavefunctions and high NBANDS
- Generate COGITO model - Creates COGITO basis functions and tight binding parameters
- Verify quality - Check convergence, charge spilling, orbital mixing, and band interpolation
- Analyze chemistry - COHP, bonding, charge analysis
# Run VASP
vasp_std
# See 'COGITO --help' for variable options
COGITO --dir './'
# Check that quality metrics are within range (check band interpolation after COGITOpost)
COGITOanalyze --dir './'
# Generate atom and bond partition of charge / band energies, make bond plots, and more
COGITOpost --dir './'
# Customize a runTBmodel.py file to get specific plots
python runTBmodel.py
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file cogito_dft-0.3.3.tar.gz.
File metadata
- Download URL: cogito_dft-0.3.3.tar.gz
- Upload date:
- Size: 253.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c49e219b8c7e2701f9f52bb9b3c16ed8c845ce4d1a6f2a6c3571d232daf5161b
|
|
| MD5 |
3a0b140d428abe2021e1e3283af39594
|
|
| BLAKE2b-256 |
9f96be4861f390bfe8e51bffc8f60060e6bd6dc76feac9d79a69b5b83bde5afb
|
File details
Details for the file cogito_dft-0.3.3-py3-none-any.whl.
File metadata
- Download URL: cogito_dft-0.3.3-py3-none-any.whl
- Upload date:
- Size: 257.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.10.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
16bcbb6c65a8d95dab38981217ebb56cd0cf342dc85b2169dc6cbc73e2612a98
|
|
| MD5 |
0103b4b1cb8f6973d3a1577b424ef022
|
|
| BLAKE2b-256 |
8f8eb33d46fbea6d1ce78e083c1fed66a7f58745a1569a9bcb3efe387cead0e1
|
