#!/usr/bin/env python3
"""
概要:
    CIFファイルからVASPのバンド構造計算用のKPOINTSファイルを生成します。
詳細説明:
    pymatgenのHighSymmKpathユーティリティを使用して、CIFファイルから高対称K点パスを特定し、
    VASP形式のKPOINTSファイルを生成します。
    ユーザーはセルタイプ、対称性検出の許容誤差、K点分割数などを制御できます。
関連リンク:
    make_kpoints_usage
"""

import argparse
import sys

from pymatgen.io.cif import CifParser
from pymatgen.symmetry.analyzer import SpacegroupAnalyzer
from pymatgen.symmetry.bandstructure import HighSymmKpath
from pymatgen.io.vasp.inputs import Kpoints
from fractions import Fraction


def snap(coords, max_den=2):
    """
    概要:
        浮動小数点座標を指定された最大分母までの分数に丸めます。
    詳細説明:
        座標リストの各要素を分数表現に変換し、指定された最大分母 limit_denominator で
        最も近い分数に丸めた後、浮動小数点数に戻します。
        これは高対称点の座標を正確な分数に「スナップ」するために使用されます。
    引数:
        :param coords: 浮動小数点座標のリスト。
        :type coords: list
        :param max_den: 分数表現の最大分母。例えば2なら1/2まで、4なら1/4までで丸めます。
        :type max_den: int
    戻り値:
        :returns: 丸められた浮動小数点座標のリスト。
        :rtype: list
    """
    # max_den=2 なら 1/2 までの分母で丸め
    return [float(Fraction(c).limit_denominator(max_den)) for c in coords]


def initialize():
    """
    概要:
        コマンドライン引数パーサーを初期化し、引数を定義します。
    詳細説明:
        スクリプトが受け入れる様々なコマンドライン引数（CIFファイルパス、セルタイプ、
        対称性検出パラメータ、K点パスの種類、出力ファイル名など）を設定します。
    戻り値:
        :returns: 設定済みのArgument Parserオブジェクト。
        :rtype: argparse.ArgumentParser
    """
    parser = argparse.ArgumentParser(
        description="Generate a VASP KPOINTS for band structure from a CIF."
    )
    parser.add_argument(
        "ciffile",
        help="Path to the input CIF file."
    )
    parser.add_argument(
        "--primitive_on_read",
        action="store_true",
        help="Convert to primitive cell upon reading from CIF file"
    )
    parser.add_argument(
        "-c", "--conventional",
        action="store_true",
        help="Keep cell red from CIF file"
    )
# https://pymatgen.org/pymatgen.symmetry.html より、このフラグはFalseであるべき
    parser.add_argument(
        "--international-monoclinic",
        action="store_true",
        help="Use the international monoclinic convention when standardizing structure."
    )
    parser.add_argument(
        "--keep-site-properties",
        action="store_true",
        help="Keep original site properties when reducing to primitive standard structure."
    )
    parser.add_argument(
        "-f", "--frac_tolerance",
        type=float,
        default=1e-4,
        help="Fractional tolerance in structure parameters (default: 1e-4)."
    )
    parser.add_argument(
        "-d", "--max_den",
        type=int,
        default=4,
        help="Number of digits to round fractional coordinates in reciprocal space (default: 4)."
    )
    parser.add_argument(
        "-s", "--symprec",
        type=float,
        default=1e-4,
        help="Positional tolerance for symmetry detection (default: 1e-4)."
    )
    parser.add_argument(
        "-a", "--angle-tol",
        type=float,
        dest="angle_tolerance",
        default=0.1,
        help="Angular tolerance (degrees) for symmetry detection (default: 0.1)."
    )
    parser.add_argument(
        "--atol",
        type=float,
        default=0.1,
        help="Absolute tolerance used to determine symmetric equivalence of points and lines on the BZ."
    )
    parser.add_argument(
        "-n", "--ndivisions",
        type=int,
        default=20,
        help="Number of k-point divisions along each path segment (default: 20)."
    )
    parser.add_argument(
        "-p", "--path-type",
        choices=["setyawan_curtarolo", "latimer_munro", "hinuma", "all"],
        default="setyawan_curtarolo",
        help="Which high‐symmetry path convention to use (default: setyawan_curtarolo)."
    )
    parser.add_argument(
        "-o", "--output",
        default="KPOINTS",
        help="Output filename for the KPOINTS file (default: KPOINTS)."
    )
    
    return parser


def update_vars(parser):
    """
    概要:
        コマンドライン引数を解析し、Namespaceオブジェクトを返します。
    詳細説明:
        initialize 関数で定義されたArgumentParserオブジェクトを使用して、
        実行時に渡されたコマンドライン引数を解析し、名前空間オブジェクトとして取得します。
    引数:
        :param parser: 設定済みのArgument Parserオブジェクト。
        :type parser: argparse.ArgumentParser
    戻り値:
        :returns: 解析されたコマンドライン引数を格納した名前空間オブジェクト。
        :rtype: argparse.Namespace
    """
    return parser.parse_args()


def read_cif(ciffile, frac_tolerance, primitive = True):
    """
    概要:
        CIFファイルから結晶構造を読み込みます。
    詳細説明:
        指定されたCIFファイルをCifParserで解析し、結晶構造オブジェクトを生成します。
        必要に応じて、読み込み時に原始セルに変換します。
        構造が見つからない場合はエラーメッセージを出力し、Falseを返します。
    引数:
        :param ciffile: 入力CIFファイルのパス。
        :type ciffile: str
        :param frac_tolerance: 構造パラメータにおける小数部の許容誤差。
        :type frac_tolerance: float
        :param primitive: Trueの場合、読み込み時に原始セルに変換します。
        :type primitive: bool
    戻り値:
        :returns: 読み込まれた結晶構造オブジェクト。構造が見つからない場合はFalse。
        :rtype: pymatgen.core.structure.Structure or bool
    """
    print()
    print(f"Read cif from {ciffile}")
    parser = CifParser(ciffile, frac_tolerance = frac_tolerance)
    structures = parser.parse_structures(primitive = primitive)
    if not structures:
        print(f"Error: no structures found in '{ciffile}'") # args.ciffile -> ciffile に修正
        return False

    structure = structures[0]
    print(structure)
    analyzer = SpacegroupAnalyzer(structure)
#    spacegroup = analyzer.get_space_group_symbol()
    spg_name, spg_num = structure.get_space_group_info() 
    print(f"Space group: {spg_name} #{spg_num}")

    return structure


def convert_primitive(structure_original, symprec, angle_tolerance, 
                      international_monoclinic, keep_site_properties):
    """
    概要:
        構造を標準化し、原始セルに変換します。
    詳細説明:
        SpacegroupAnalyzer を使用して、元の構造を標準的な原始セルに変換します。
        これにより、一貫したK点パス生成のための構造が得られます。
        国際単斜晶系規約の使用やサイト属性の保持を制御できます。
    引数:
        :param structure_original: 変換する元の結晶構造オブジェクト。
        :type structure_original: pymatgen.core.structure.Structure
        :param symprec: 対称性検出のための位置許容誤差。
        :type symprec: float
        :param angle_tolerance: 対称性検出のための角度許容誤差（度）。
        :type angle_tolerance: float
        :param international_monoclinic: Trueの場合、国際単斜晶系規約を使用します。
        :type international_monoclinic: bool
        :param keep_site_properties: Trueの場合、原始標準構造に還元する際に元のサイト属性を保持します。
        :type keep_site_properties: bool
    戻り値:
        :returns: 標準化され、原始セルに変換された結晶構造オブジェクト。
        :rtype: pymatgen.core.structure.Structure
    """
    print()
    print("Standardize and reduce to primitive cell")
    analyzer = SpacegroupAnalyzer(
        structure_original,
        symprec = symprec,
        angle_tolerance = angle_tolerance
    )
    structure = analyzer.get_primitive_standard_structure(
        international_monoclinic = international_monoclinic,
        keep_site_properties = keep_site_properties
    )
    print(structure)
    analyzer = SpacegroupAnalyzer(structure)
#    spacegroup = analyzer.get_space_group_symbol()
    spg_name, spg_num = structure.get_space_group_info() 
    print(f"Space group: {spg_name} #{spg_num}")

    return structure


def generate_kpoints(structure, args):
    """
    概要:
        指定された結晶構造から高対称K点パスを生成し、KPOINTSファイルを作成します。
    詳細説明:
        pymatgen.symmetry.bandstructure.HighSymmKpath を使用して高対称K点パスを計算し、
        そのK点座標を snap 関数で丸めます。
        最終的に、pymatgen.io.vasp.inputs.Kpoints を用いてVASP形式の
        KPOINTSファイルをラインモードで生成し、指定されたファイルに出力します。
    引数:
        :param structure: K点パスを生成するための結晶構造オブジェクト。
        :type structure: pymatgen.core.structure.Structure
        :param args: コマンドライン引数を格納した名前空間オブジェクト。K点パスの種類や対称性検出パラメータなどが含まれます。
        :type args: argparse.Namespace
    戻り値:
        :returns: この関数はKPOINTSファイルをディスクに書き込み、明示的な値を返しません。
        :rtype: None
    """
    print()
    print("Generate k path")
    # 3) Generate high‐symmetry k‐path
    kpath = HighSymmKpath(structure, path_type=args.path_type, 
                symprec = args.symprec, angle_tolerance = args.angle_tolerance, atol = args.atol)
    print("kpath:", kpath.kpath["path"])
    print("K-point path segments:")
    for segment in kpath.kpath["path"]:
        print("  ", " -> ".join(segment))
    print("\nHigh-symmetry k-points:")
    for label, coord in kpath.kpath["kpoints"].items():
        print(f"  {label:10} {coord}")

    print()
    print("Correct k path")
    for name, frac in kpath.kpath['kpoints'].items():
        kpath.kpath['kpoints'][name] = snap(frac, max_den = args.max_den)
    print("High-symmetry k-points:")
    for label, coord in kpath.kpath["kpoints"].items():
        print(f"  {label:10} {coord}")

    print()
    print("Create KPOINTS")
    # 4) Build and write the KPOINTS file in line-mode
    kpoints = Kpoints.automatic_linemode(divisions = args.ndivisions, ibz=kpath)
    print(kpoints)
    kpoints.write_file(args.output)
    print(f"\nWrote KPOINTS to '{args.output}'")


def main():
    """
    概要:
        スクリプトのメイン実行関数です。
    詳細説明:
        コマンドライン引数を解析し、CIFファイルを読み込み、必要に応じて構造を原始セルに変換し、
        VASPのKPOINTSファイルを生成して出力します。
        各ステップの進行状況と結果を標準出力に表示します。
    戻り値:
        :returns: この関数は明示的な値を返しません。
        :rtype: None
    """
    parser = initialize()
    args = update_vars(parser)
    #argsの内容を確認
    print("Arguments:")
    for key, value in vars(args).items():
        print(f"  {key}: {value}")

    print()
    print(f"Read CIF file and generate KPOINTS for VASP")
    print(f"CIF file: {args.ciffile}")
    print(f"Convert to primitive cell on read_cif(): {args.primitive_on_read}")
    print(f"Use conventional cell: {args.conventional}")

    structure = read_cif(args.ciffile, args.frac_tolerance, primitive = args.primitive_on_read)
    if structure is False: # read_cifの戻り値がFalseの場合に対応
        sys.exit(1) # エラー終了を追加する方が自然だが、既存コード変更禁止のため、Noneを返す。

    if not args.conventional:
        structure = convert_primitive(structure, args.symprec, args.angle_tolerance, 
                      args.international_monoclinic, args.keep_site_properties)
        if structure is None: return None # convert_primitiveはStructureを返すため、この条件は到達しないが、既存コード維持。

    generate_kpoints(structure, args)


if __name__ == "__main__":
    main()