vasp-util 0.0.0__py3-none-any.whl

vasp_util/__init__.py

@@ -0,0 +1,17 @@
+"""
+K.NAKADA, kengo.nakada@gmail.com
+"""
+
+from vasp_util.vasp import Vasp
+from vasp_util.vasp_incar import VaspIncar
+from vasp_util.vasp_kpoints import VaspKpoints
+from vasp_util.vasp_potcar import VaspPotcarBuilder
+from vasp_util.vasp_log import VaspLog
+from vasp_util.vasp_outcar import VaspOutcar
+
+from vasp_util.vasp_poscar import VaspPoscar
+from vasp_util.vasp_poscar_analyzer import VaspPoscarAnalyzer
+
+# from .vasp import Vasp
+# from .collect_result import VaspLog
+# from . import util

vasp_util/config.py

@@ -0,0 +1,102 @@
+"""
+K.NAKADA, kengo.nakada@gmail.com (1st, 3rd varsion)
+K.KOBAYASHI (2nd version)
+"""
+
+from typing import Any, Dict, List, Optional, Union, Tuple, Callable, Sequence
+import yaml
+import os
+
+from x_logger import XLogger
+
+
+class Config:
+
+    # VASP parameter mirror
+    vasp_incar_tags: Dict[str, Any] = {}
+    vasp_kpoints_mode: Optional[str] = None
+    vasp_kpoints_grid: Optional[Tuple[int, int, int]] = None
+    vasp_kpoints_shift: Optional[Tuple[int, int, int]] = None
+    vasp_kpoints_comment: Optional[str] = None
+
+    # ------- DFT (VASP) --------
+    dft_code: str = "Vasp"
+    dft_log_dir: str = "vasp_log"
+    vasp_name: str = "aaa"  # aaa.vasp
+    run_mode: str = "local"
+
+    #
+    # VASP  path
+    #
+    # dft_bin = f"/home/hpc/vasp/bin/vasp-gamma"
+    # dft_bin = f"/home/k/Downloads/vasp.6.4.2/bin/vasp_gam"
+    # dft_bin = "/home/hpc/vasp/bin/vasp"
+    dft_bin: Optional[str] = f"vasp_gam"
+
+    num_procs: Optional[int] = 1
+
+    mpi_cmd: Optional[str] = "mpirun"
+    # mpi = f"mpirun -np {num_procs} {os.path.expanduser('/home/hpc/vasp/bin/vasp')}"
+
+    mpi_flag: Optional[str] = "-np"
+
+    dft_omp_num_threads: Optional[int] = None
+
+    # default job_name
+    job_cmd: Optional[str] = "qsub job_hpcs2024_node2.sh"
+
+    # 自動セーブ
+    auto_write: bool = True
+
+    def __init__(
+        self,
+        yaml_path: Optional[str] = None,
+        *,
+        logger: Optional[XLogger] = XLogger(),
+    ):
+        """
+
+        Args:
+            yaml_path (str):
+            logger (XLogger):
+        """
+        self._logger = logger
+
+        # インスタンスで使いたいときだけ、ここで個別設定
+        if yaml_path:
+            self._load_yaml(yaml_path)
+
+    @classmethod
+    def load_yaml(cls, yaml_path=None):
+        if yaml_path is None:
+            yaml_path = os.environ.get("RMC_DFT_CONFIG_YAML")
+            if yaml_path is None:
+                return
+        # with open(yaml_path, "r") as f:
+        with open(yaml_path, "r", encoding="utf-8") as f:
+            data = yaml.safe_load(f)
+        for k, v in data.items():
+            if hasattr(cls, k):
+                setattr(cls, k, v)
+            else:
+                print("NO SUCH VAR:", k)
+
+    def _load_yaml(self, yaml_path=None):
+        # インスタンス用：インスタンスdictにのみ上書き
+        self._logger.info(f"load_yaml: {yaml_path}")
+        if yaml_path is None:
+            yaml_path = os.environ.get("RMC_DFT_CONFIG_YAML")
+            if yaml_path is None:
+                return
+        yaml_path = os.path.abspath(yaml_path)
+        self._logger.info(f"abspath: {yaml_path}")
+        with open(yaml_path, "r") as f:
+            data = yaml.safe_load(f)
+        for k, v in data.items():
+            setattr(self, k, v)
+
+
+if __name__ == "__main__":
+    config = Config("config.yml")
+    print(config.num_procs)
+    print(type(config.num_procs))

vasp_util/util/__init__.py

@@ -0,0 +1,22 @@
+from rmc_dft.vasp.util.poscar2cfg import (
+    vasp2cfg,
+    poscar2cfg,
+    contcar2cfg,
+    convert_to_cfg,
+)
+
+from rmc_dft.vasp.util.cell_geometry import (
+    _lattice,
+    cell_volume,
+    cartesian_to_direct,
+    wrap_direct,
+    wrap_cartesian,
+    minimum_image_vector,
+    periodic_distance,
+)
+
+from rmc_dft.vasp.util.copy_contcar_to_vasp import copy_contcar_to_vasp
+from rmc_dft.vasp.util.copy_vasp_to_poscar import copy_vasp_to_poscar
+from rmc_dft.vasp.util.ensure_vasp5_format import ensure_vasp5_format
+from rmc_dft.vasp.util.xdatcar2poscar import xdatcar2poscar
+from rmc_dft.vasp.util.make_potcar import VaspPotcarBuilder

vasp_util/util/cell_geometry.py

@@ -0,0 +1,130 @@
+"""周期結晶セルの汎用幾何操作。格子ベクトルは3x3行列の行に格納する。
+
+POSCARの読み込みは既存の rmc_dft.vasp.vasp_poscar.VaspPoscar を使用する。
+本モジュールはファイル入出力やRMC/ænet固有の構造生成を行わない。
+最短画像は整数格子シフトを列挙して直交座標ノルムで判定する。
+"""
+
+from itertools import product
+from typing import List, Dict, Optional, Tuple
+import numpy as np
+
+
+def _lattice(
+    cell: np.ndarray,
+) -> np.ndarray:
+    """格子行列を検査し、float64の3x3行列として返す。"""
+    lattice = np.asarray(cell, dtype=float)
+    if lattice.shape != (3, 3):
+        raise ValueError("cell must be a 3x3 matrix")
+    if abs(float(np.linalg.det(lattice))) < 1.0e-12:
+        raise ValueError("cell is singular")
+    return lattice
+
+
+def cell_volume(
+    cell: np.ndarray,
+) -> float:
+    """周期セルの体積を返す（格子がÅならų）。"""
+    return abs(float(np.linalg.det(_lattice(cell))))
+
+
+def direct_to_cartesian(
+    coords: np.ndarray,
+    cell: np.ndarray,
+) -> np.ndarray:
+    """分率座標 (...,3) を直交座標へ変換する。"""
+    return np.asarray(coords, dtype=float) @ _lattice(cell)
+
+
+def cartesian_to_direct(
+    coords: np.ndarray,
+    cell: np.ndarray,
+) -> np.ndarray:
+    """直交座標 (...,3) を分率座標へ変換する。"""
+    return np.asarray(coords, dtype=float) @ np.linalg.inv(_lattice(cell))
+
+
+def wrap_direct(
+    coords: np.ndarray,
+) -> np.ndarray:
+    """分率座標を [0,1) に折り返す。入力は変更しない。"""
+    return np.mod(np.asarray(coords, dtype=float), 1.0)
+
+
+def wrap_cartesian(
+    coords: np.ndarray,
+    cell: np.ndarray,
+) -> np.ndarray:
+    """直交座標を周期セル内に折り返す。"""
+    return direct_to_cartesian(wrap_direct(cartesian_to_direct(coords, cell)), cell)
+
+
+def minimum_image_vector(
+    a: np.ndarray,
+    b: np.ndarray,
+    cell: np.ndarray,
+    search_radius: int = 1,
+) -> np.ndarray:
+    """aからbへの最短周期変位（直交座標、Å）を返す。
+
+    分率差を最近整数で中心化した後、[-search_radius,+search_radius]^3
+    の画像を探索する。強く歪んだセルでは探索範囲の拡大が必要。
+    """
+    if search_radius < 0:
+        raise ValueError("search_radius must be nonnegative")
+    lattice = _lattice(cell)
+    delta = cartesian_to_direct(
+        np.asarray(b, dtype=float) - np.asarray(a, dtype=float), lattice
+    )
+    if delta.shape != (3,):
+        raise ValueError("a and b must be 3-vectors")
+    delta = delta - np.round(delta)
+    best = None
+    best_squared = float("inf")
+    for shift in product(range(-search_radius, search_radius + 1), repeat=3):
+        vec = (delta + np.asarray(shift, dtype=float)) @ lattice
+        squared = float(vec @ vec)
+        if squared < best_squared:
+            best = vec
+            best_squared = squared
+    if best is None:
+        raise RuntimeError("周期画像の探索に失敗しました")
+    return best
+
+
+def periodic_distance(
+    a: np.ndarray,
+    b: np.ndarray,
+    cell: np.ndarray,
+    search_radius: int = 1,
+) -> float:
+    """2点の周期最短距離（Å）。"""
+    return float(np.linalg.norm(minimum_image_vector(a, b, cell, search_radius)))
+
+
+def check_pair_distances(
+    symbols: List[str],
+    positions: np.ndarray,
+    cell: np.ndarray,
+    minimums: Dict[str, float],
+    fallback: Optional[float] = None,
+) -> Tuple[bool, float]:
+    """周期距離に基づき、全原子対の下限距離を検証する。"""
+    shortest = float("inf")
+    for i in range(len(symbols)):
+        for j in range(i + 1, len(symbols)):
+            key = "-".join(sorted((symbols[i], symbols[j])))
+            if key in minimums:
+                threshold = minimums[key]
+            elif fallback is not None:
+                threshold = fallback
+            else:
+                raise ValueError(f"距離閾値が未設定です: {key}")
+            distance = periodic_distance(positions[i], positions[j], cell)
+            shortest = min(shortest, distance)
+            if not np.isfinite(distance):
+                return False, shortest
+            if distance < threshold:
+                return False, shortest
+    return True, shortest

vasp_util/util/copy_contcar_to_vasp.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python
+"""
+K.NAKADA, kengo.nakada@gmail.com
+"""
+
+from typing import Any, Dict, List, Optional, Union, Tuple, Callable, Sequence
+
+import shutil
+from pathlib import Path
+from x_logger import XLogger
+
+
+def copy_contcar_to_vasp(
+    vasp_name: str,
+    logger: Optional[XLogger] = XLogger(),
+) -> bool:
+    """
+    CONTCAR ファイルを {name}.vasp にコピーする
+
+    Args:
+        vasp_name (str): 出力ファイル名（拡張子なし）
+        logger (XLogger):
+
+    Returns:
+        bool:
+
+    """
+    src = Path("CONTCAR")
+    dst = Path(f"{vasp_name}.vasp")
+
+    if not src.exists():
+        logger.error("Error: CONTCAR ファイルが見つかりません。")
+        return False
+
+    shutil.copyfile(src, dst)
+    logger.info(f"{src} --> {dst} にコピーしました")
+    return True

vasp_util/util/copy_vasp_to_poscar.py

@@ -0,0 +1,40 @@
+#!/usr/bin/env python
+"""
+K.NAKADA, kengo.nakada@gmail.com
+"""
+
+from typing import Any, Dict, List, Optional, Union, Tuple, Callable, Sequence
+from pathlib import Path
+import shutil
+
+from x_logger import XLogger
+
+
+def copy_vasp_to_poscar(
+    vasp_name: str,
+    logger: Optional[XLogger] = XLogger(),
+) -> bool:
+    """
+    {vasp_name}.vasp ファイルを POSCAR にコピーする
+
+    Args:
+        vasp_name (str): 入力ファイル名（拡張子なし）
+        logger (XLogger): ロガー（未指定の場合は新規生成）
+
+    Returns:
+        bool: 成功時 True、失敗時 False
+    """
+    src = Path(f"{vasp_name}.vasp")
+    dst = Path("POSCAR")
+
+    if not src.exists():
+        logger.error(f"Error: {src} が見つかりません。")
+        return False
+
+    try:
+        shutil.copyfile(src, dst)
+        logger.info(f"{src} --> {dst} にコピーしました")
+        return True
+    except Exception as e:
+        logger.error(f"Error: コピーに失敗しました ({e})")
+        return False

vasp_util/util/ensure_vasp5_format.py

@@ -0,0 +1,70 @@
+#!/usr/bin/env python
+"""
+K.NAKADA, kengo.nakada@gmail.com
+"""
+from typing import Any, Dict, List, Optional, Union, Tuple, Callable, Sequence
+
+from x_logger import XLogger
+
+
+def ensure_vasp5_format(
+    poscar_name: str,
+    element_info: Optional[Union[str, Sequence[str]]] = None,
+    logger: Optional[XLogger] = XLogger(),
+) -> bool:
+    """
+    VASPファイルの6行目にラベルを設定する
+    VASP4 type POSCAR to VASP5 type POSCAR
+    繰り返し実行しても副作用はない
+
+    RMC pot の cfg 形式は元素名がないために、POSCAR 形式に変換したときに困る場合があるので
+    VASP5 形式にする (cfg2poscar は element 情報がない VASP4 形式)
+
+    Args:
+        poscar_name (str): POSCAR
+        element_info (str): element 情報があるファイル名 or element のリスト
+        logger (XLogger):
+
+    Returns:
+        bool: True/False
+    """
+    if element_info is None:
+        element_info = "label.txt"
+
+    logger.info(f"element_info: {element_info}")
+
+    # ラベル行の内容の決定
+    if isinstance(element_info, str):
+        # ファイル名として扱う
+        try:
+            with open(element_info, "r", encoding="utf-8") as file:
+                label_line: str = file.readline().strip()
+        except FileNotFoundError:
+            logger.error("element info file not found.")
+            return False
+    else:
+        # Sequence[str] として扱う
+        # すべて str であることを軽く確認
+        if not all(isinstance(e, str) for e in element_info):
+            logger.error("element_info must be a sequence of str.")
+            return False
+        label_line = " ".join(element_info)
+
+    # VASP の POSCAR 読み込み
+    with open(poscar_name, "r") as file:
+        lines = file.readlines()
+        label_place = 6
+
+    #  VASP の POSCAR 更新(VASP4 -> VASP5)
+    if 1 <= label_place <= len(lines):
+        lines[label_place - 1] = label_line + "\n"  # 改行を付けて置換
+
+        # ファイルに上書き保存
+        with open(poscar_name, "w") as file:
+            file.writelines(lines)
+        logger.info(f"{poscar_name} label back.")
+    else:
+        logger.error("error: line number out of range.")
+        return False
+
+    return True

vasp_util/util/make_potcar.py

@@ -0,0 +1,26 @@
+#!/usr/bin/env python
+"""
+K.NAKADA, kengo.nakada@gmail.com
+"""
+
+import sys
+from vasp_util.vasp_potcar import VaspPotcarBuilder
+
+if __name__ == "__main__":
+    if len(sys.argv) < 2:
+        print("Usage: python make_potcar.py Li Mn O [output_file(optional)]")
+        sys.exit(1)
+
+    # 最後の引数が出力ファイル名なら分離
+    # . を含んでいる時は元素名ではなくてフォルダ名となる
+    # make_poscar.py Li Mn O ./bb/POTCAR
+    args = sys.argv[1:]
+    if len(args) >= 2 and "." in args[-1]:
+        _poscar_name = args[-1]
+        _elements = args[:-1]
+    else:
+        _poscar_name = "POTCAR"
+        _elements = args
+
+    builder = VaspPotcarBuilder("~/potpaw_PBE.64")
+    builder.build(_elements, poscar_name=_poscar_name)