packmol_util package

Submodules

packmol_util.builder module

packmol_util/builder.py

詳細なファイルのバケツリレーを隠蔽し、数行でアモルファス構造を作成するための高レベル統合モジュール。

以下の 3 点を外部入力の基準とする：

化学量論比（整数比）
密度 [g/cm^3] または数密度 [1/Å^3] のいずれか一方
セル内の総原子数 total_atom_count

【重要】指定した total_atom_count が ratios の合計で割り切れない（組成比を維持できない）場合、プログラムが破綻するのを防ぐため、指定された原子数に最も近い「割り切れる総原子数」へ自動補正を行う。内部で計算された全体のスケール倍率（multiplier）を外部に公開（プロパティ化）することで、利用側のスクリプトがユニット構成単位でのパッキング個数を一元管理できるように設計されている。

class packmol_util.builder.AmorphousBuilder(symbols, ratios, total_atom_count, minimum_separation, mass_density=None, number_density=None, packmol_bin='packmol')[source]

Bases: object

Parameters:

symbols (List[str])
ratios (List[int])
total_atom_count (int)
minimum_separation (float)
mass_density (float | None)
number_density (float | None)
packmol_bin (str)

add_template(xyz_file, number, packing_radii=None, fnc_pairs_in_template=None, fnc_distance_ranges=None, fnc_output_constraint_types=None)[source]

Packmol の 1 つの structure ブロックに対応するテンプレート情報を登録する。

引数の説明：

xyz_file: Packmol に渡す単原子または分子ユニットテンプレートの座標ファイル名 (.xyz) number: そのテンプレートを何個複製して配置するかを指定する [int] packing_radii: Packmol 配置時に使う元素記号別の排除半径の辞書（任意）。

分子ユニット内部の結合距離や形状を作る値ではない。

fnc_pairs_in_template: テンプレート内の局所原子番号で指定した FNC ペア。: (local_i, local_j, constraint_type) のリストで指定する。
fnc_distance_ranges: FNC constraint type ごとの距離範囲。: {type: (rmin, rmax)} で指定する。
fnc_output_constraint_types: .fnc に実際に出力する constraint type のリスト。: None の場合は全 type を出力する。例: [1] を指定すると type 1 のペアだけを出力する。 Packmol 用 XYZ テンプレートの形状や配置には影響しない。

Parameters:

xyz_file (str)
number (int)
packing_radii (Dict[str, float] | None)
fnc_pairs_in_template (List[Tuple[int, int, int]] | None)
fnc_distance_ranges (Dict[int, Tuple[float, float]] | None)
fnc_output_constraint_types (List[int] | None)

build(output_prefix, fnc_file=None)[source]

Parameters:

output_prefix (str)
fnc_file (str | None)

property multiplier: int: 全体の化学量論比に対するセルのスケール倍率を返す。利用側のスクリプトは、この倍率をユニットの1式あたり構成比に乗算することで、 Packmol に引き渡すべき実際の複製個数（number）を算出する。

packmol_util.config module

packmol_util の設定保持クラス。

class packmol_util.config.Config(yaml_path=None, logger=None)[source]

Bases: object

packmol_util 用の設定値を保持する。

Parameters:

yaml_path (str | None)
logger (x_logger.XLogger | None)

N_tot: int = 2000

element_info: str | Sequence[str] = ['Fe', 'Si', 'B']

classmethod load_yaml(yaml_path=None)[source]

YAML の内容でクラス変数を上書きする。

Parameters:: yaml_path (str | None)
Return type:: None

mass_density_g_cm3: float = 7.3336

minimum_separation: float = 2.0

number_density_A3: float = 0.09119

output_prefix: str = 'amorphous'

packmol_bin: str = 'packmol'

ratios: Sequence[int] = [82, 4, 14]

packmol_util.install module

packmol_util に付属するスクリプトとサンプルの配置機能。

packmol_util.install.install(kind, *, destination='.', force=False)[source]

配布ファイルをカレントディレクトリへ再帰的にコピーする。

同名ファイルは既定で保持する。force=True の場合のみ上書きする。既存のディレクトリは削除せず、ファイル単位で判定する。

Parameters:

kind (str)
destination (str | Path)
force (bool)

Return type:

tuple[int, int]

packmol_util.install.main(argv=None)[source]

Parameters:: argv (list[str] | None)
Return type:: int

packmol_util.model module

材料非依存の構造テンプレートと Packmol 用レシピを準備する共通モジュールである。

このファイルには、Li3PO4 や FeSiB のような物質固有の数値を置かない。物質固有の原子数、密度、分子内距離、packing 半径は make_*.py 側で与える。

ここで行うことは、次の二つである。

Packmol に渡す単原子テンプレートまたは分子ユニットテンプレートの XYZ を作る。
make_*.py 側で決めたテンプレートと個数を、Packmol 入力用のレシピにまとめる。

class packmol_util.model.MaterialRecipe(total_atom_count, symbols, ratios, structures)[source]

Bases: object

make_*.py 側で定義した構造作成条件を Packmol 入力生成へ渡すためのレシピである。

total_atom_count は、セル内に最終的に入る総原子数である。 Li3PO4 で Li 原子 192 個と PO4 ユニット 64 個を置く場合、総原子数は 192 + 64 * 5 = 512 である。

symbols と ratios は、最終的な POSCAR 変換や密度計算で使う元素順序と組成比である。 structures は、Packmol に渡す structure ブロックの列である。

Parameters:

total_atom_count (int)
symbols (List[str])
ratios (List[int])
structures (List[StructureSpec])

ratios: List[int]

structures: List[StructureSpec]

symbols: List[str]

total_atom_count: int

class packmol_util.model.StructureSpec(xyz_file, number, packing_radii_by_atom_symbol=None)[source]

Bases: object

Packmol の 1 つの structure ブロックに対応する情報である。

xyz_file は、Packmol に渡す 1 個の単原子テンプレートまたは 1 個の分子ユニットテンプレートの座標ファイル名である。

number は、そのテンプレートを Packmol がセル内に何個配置するかを表す。例えば Li.xyz の number が 192 なら、Li 単原子テンプレートを 192 個配置する。 PO4.xyz の number が 64 なら、PO4 ユニットを 64 個配置する。

packing_radii_by_atom_symbol は、Packmol の atoms … radius … end atoms 指定へ変換するための情報である。キーは元素記号であり、Packmol の atom index ではない。 Packmol 入力ファイルに書くときに、packmol_inp.py が XYZ 内の原子順を読んで、元素記号から atom index へ変換する。

この packing 半径は分子ユニット内部の結合距離ではない。分子ユニット内部の距離は、write_tetrahedral_unit_xyz() などのテンプレート生成関数で決める。

Parameters:

xyz_file (str)
number (int)
packing_radii_by_atom_symbol (Dict[str, float] | None)

number: int

packing_radii_by_atom_symbol: Dict[str, float] | None = None

xyz_file: str

class packmol_util.model.TetrahedralUnitFncSpec(center_vertex_distance, vertex_vertex_distance, fnc_pairs_in_template, fnc_distance_ranges)[source]

Bases: object

正四面体ユニットの FNC 指定と Packmol 用代表距離をまとめた仕様である。

FNC の rmin/rmax を一次情報とし、その中央値から Packmol に渡すテンプレート構造用の代表距離を派生させる。

Parameters:

center_vertex_distance (float)
vertex_vertex_distance (float)
fnc_pairs_in_template (List[Tuple[int, int, int]])
fnc_distance_ranges (Dict[int, Tuple[float, float]])

center_vertex_distance: float

fnc_distance_ranges: Dict[int, Tuple[float, float]]

fnc_pairs_in_template: List[Tuple[int, int, int]]

vertex_vertex_distance: float

packmol_util.model.make_atomic_mixture_recipe(symbols, ratios, total_atom_count, xyz_files=None)[source]

複数元素の単原子テンプレートを作り、Packmol 用レシピを返す。

FeSiB のように、分子ユニットを使わず、Fe、Si、B の単原子をそれぞれ指定数だけランダム配置する場合に使う。

total_atom_count は、最終セルに入れる総原子数である。 ratios の比に従い、各元素の原子数を決める。例えば total_atom_count=100、ratios=[80, 9, 11] なら、Fe 80 個、Si 9 個、 B 11 個の単原子テンプレートを Packmol に配置させる recipe を作る。

Parameters:

symbols (Sequence[str])
ratios (Sequence[int])
total_atom_count (int)
xyz_files (Sequence[str] | None)

Return type:

MaterialRecipe

packmol_util.model.make_material_recipe(symbols, ratios, structures)[source]

make_*.py 側で作った structure 指定を Packmol 用レシピにまとめる。

この関数は分子構造を作らない。Packmol 入力ファイルも書かない。すでに作られた XYZ テンプレートと、それぞれを何個配置するかという情報を、 MaterialRecipe として一つにまとめる。

Li3PO4 では、Li.xyz を何個置くか、PO4.xyz を何個置くかを structures に渡す。 FeSiB では、Fe.xyz、Si.xyz、B.xyz をそれぞれ何個置くかを structures に渡す。

Parameters:

symbols (Sequence[str])
ratios (Sequence[int])
structures (Sequence[StructureSpec])

Return type:

MaterialRecipe

packmol_util.model.make_tetrahedral_unit_fnc_pairs(center_index=1, vertex_indices=None, center_vertex_constraint_type=1, vertex_vertex_constraint_type=2)[source]

正四面体ユニット用の FNC 局所ペアを作る。

返り値は、テンプレート内の 1 始まり局所原子番号で表した (local_i, local_j, constraint_type) のリストである。 PO4.xyz が P, O, O, O, O の順なら、P-O 4 本と O-O 6 本を返す。実際の Packmol XYZ 番号や POSCAR/cfg 番号への変換は builder 側で行う。

Parameters:

center_index (int)
vertex_indices (Sequence[int] | None)
center_vertex_constraint_type (int)
vertex_vertex_constraint_type (int)

Return type:

List[Tuple[int, int, int]]

packmol_util.model.make_tetrahedral_unit_fnc_spec_from_ranges(center_vertex_range, vertex_vertex_range, center_index=1, vertex_indices=None, center_vertex_constraint_type=1, vertex_vertex_constraint_type=2, geometry_distance_tolerance=0.05)[source]

FNC の rmin/rmax を一次情報として、正四面体ユニットの仕様を作る。

center_vertex_range は中心原子-頂点原子の FNC 距離範囲である。 vertex_vertex_range は頂点原子-頂点原子の FNC 距離範囲である。

Packmol に渡す PO4 などのテンプレート XYZ 用距離は、これらの範囲の中央値から派生させる。したがって、Packmol 用距離と FNC 用距離範囲を利用側で二重管理しない。

geometry_distance_tolerance は FNC の許容幅ではない。 FNC range の中央値から作った中心-頂点距離と頂点-頂点距離が、正四面体として幾何学的に整合しているかを検査するためだけに使う。

Parameters:

center_vertex_range (Tuple[float, float])
vertex_vertex_range (Tuple[float, float])
center_index (int)
vertex_indices (Sequence[int] | None)
center_vertex_constraint_type (int)
vertex_vertex_constraint_type (int)
geometry_distance_tolerance (float)

Return type:

TetrahedralUnitFncSpec

packmol_util.model.solve_packing_radii_from_pair_distances(symbols, minimum_distances_by_pair, pair_distance_tolerance=0.0)[source]

希望する元素ペア距離を Packmol の原子半径モデルへ近似変換する。

Packmol は Li-O=1.55, P-O=1.30 のような元素ペア距離表を直接受け取らない。 Packmol が受け取れるのは atom index ごとの radius であり、実効距離は radius_i + radius_j として扱われる。

この関数は、make_*.py 側で書いた元素ペア距離表を、Packmol に渡せる元素ごとの packing radius に変換するための補助関数である。

ただし、任意の元素ペア距離表が半径和で完全に表せるわけではない。例えば Li-Li, Li-P, Li-O, P-P, P-O, O-O をすべて独立に与えると、半径和モデルでは矛盾する場合がある。

pair_distance_tolerance は、その矛盾をどの程度まで短い距離側へ緩めて許すかを表す。この値は Packmol の tolerance ではない。元素ペア距離表を packing radius に近似変換するための内部的な許容幅である。

戻り値は {“Li”: r_Li, “P”: r_P, “O”: r_O} のような辞書である。この辞書は StructureSpec.packing_radii_by_atom_symbol に渡し、 packmol_inp.py 側で atom index 指定へ変換される。

注意：この変換で得られる半径は、分子ユニット内部の距離を決めるものではない。例えば PO4 の P-O / O-O 距離は write_tetrahedral_unit_xyz() が作る XYZ 座標で決まる。この関数が扱うのは、Packmol が複数ユニットを配置するときに使う半径和モデルである。

Parameters:

symbols (Sequence[str])
minimum_distances_by_pair (Dict[Tuple[str, str], float])
pair_distance_tolerance (float)

Return type:

Dict[str, float]

packmol_util.model.write_single_atom_xyz(filename, element)[source]

Packmol に単原子を配置させるための 1 原子 XYZ テンプレートを書き出す。

これは FeSiB の Fe、Si、B のように、分子ユニットを作らず、元素ごとの単原子をランダム配置したい場合に使う。

Parameters:

filename (str)
element (str)

Return type:

None

packmol_util.model.write_tetrahedral_unit_xyz(filename, center_element, vertex_element, center_vertex_distance, vertex_vertex_distance, distance_tolerance=0.05)[source]

中心原子 1 個と頂点原子 4 個からなる正四面体ユニットを書き出す。

PO4 の場合、center_element は P、vertex_element は O である。 center_vertex_distance は P-O 距離である。 vertex_vertex_distance は O-O 距離である。

この関数で作る XYZ が、Packmol に渡す「1 個の PO4 ユニット」の形になる。 Packmol はこの XYZ を読み、PO4 ユニットの内部形状を保ったまま、指定個数をセル内に配置する。

packing 半径や最小分離距離はここでは扱わない。それらは、すでに作ったユニット同士、またはユニットと単原子が配置時に近づきすぎないようにするための Packmol 入力側の条件である。

Parameters:

filename (str)
center_element (str)
vertex_element (str)
center_vertex_distance (float)
vertex_vertex_distance (float)
distance_tolerance (float)

Return type:

None

packmol_util.model.write_xyz_template(filename, atoms, comment='template')[source]

任意のテンプレート構造を XYZ として書き出す。

atoms には、1 個の単原子テンプレートまたは 1 個の分子ユニットテンプレートの原子座標を渡す。ここで書かれた原子順が、Packmol の atom index の順番になる。

Parameters:

filename (str)
atoms (Sequence[Tuple[str, float, float, float]])
comment (str)

Return type:

None

packmol_util.packmol module

K.NAKADA, kengo.nakada@gmail.com make_amorphous.py

アモルファス初期構造を Packmol により生成するための入力ファイル (packmol.inp) を作成するスクリプト。

本スクリプトは、以下の 3 点を外部入力とする：

化学量論比（整数比）

密度 [g/cm^3] または数密度 [1/Å^3] のいずれか一方

セル内の総原子数 total_atom_count

Packmol は密度・化学量論比の概念を持たないため、本スクリプト側で原子数とセル一辺長 L を計算し、Packmol 形式の inside box 指定に変換する。

class packmol_util.packmol.Packmol(input_file=None, output_xyz=None, output_log=None, packmol_bin=None, logger=None)[source]

Bases: object

Packmol 実行と、密度・セル長・POSCAR 変換をまとめる補助クラスである。

このクラスは分子ユニットの形を作らない。 PO4 のようなテンプレート形状は model.py が作る。

このクラスが担当するのは、密度からセル長を決めること、Packmol を実行すること、 Packmol が出力した XYZ を POSCAR へ変換することである。

Parameters:

input_file (str | None)
output_xyz (str | None)
output_log (str | None)
packmol_bin (str | None)
logger (x_logger.XLogger | None)

average_atomic_weight(symbols, ratios)[source]

汎用

化学量論比から平均原子量を計算する。

Parameters:

symbols (Sequence[str])
ratios (Sequence[int])

Return type:

float

cell_length_from_number_density(total_atom_count, number_density_A3)[source]

汎用

総原子数と数密度から立方体セル長 L [Å] を計算する。

Parameters:

total_atom_count (int)
number_density_A3 (float)

Return type:

float

compute_cell_sizes(ratios, max_atom_count)[source]

汎用

化学量論比を厳密に保つセル原子数を列挙する。

Parameters:

ratios (Sequence[int])
max_atom_count (int)

Return type:

List[int]

compute_element_counts(symbols, ratios, total_atom_count)[source]

化学量論比と total_atom_count から各元素の原子数を決める。

total_atom_count が ratios の整数倍でない場合でも、端数の大きい元素へ残りの原子を割り当て、総原子数が total_atom_count になるようにする。厳密な組成比だけを許す用途では、make_atomic_mixture_recipe() のように整数倍を要求する関数を使う。

Parameters:

symbols (Sequence[str])
ratios (Sequence[int])
total_atom_count (int)

Return type:

Dict[str, int]

count_atoms_in_xyz(xyz_file)[source]

XYZ ファイル先頭行から原子数を読む。

Parameters:: xyz_file (str)
Return type:: int

static get_atomic_weight(element)[source]

元素記号から原子量を取得する。

Parameters:: element (str)
Return type:: float

get_unit_atom_count(ratios)[source]

化学量論比 1 単位あたりの原子数を返す。

Fe80Si9B11 なら 80 + 9 + 11 = 100 である。 Li3PO4 なら 3 + 1 + 4 = 8 である。この値は、組成比を保ったまま総原子数候補を列挙するときに使う。

Parameters:: ratios (Sequence[int])
Return type:: int

mass_density_from_number_density(symbols, ratios, number_density_A3)[source]

汎用

数密度 n [1/Å^3] から質量密度 ρ [g/cm^3] を計算する。

Parameters:

symbols (Sequence[str])
ratios (Sequence[int])
number_density_A3 (float)

Return type:

float

number_density_from_mass_density(symbols, ratios, mass_density_g_cm3)[source]

汎用

質量密度から数密度 n [1/Å^3] を計算する。

Parameters:

symbols (Sequence[str])
ratios (Sequence[int])
mass_density_g_cm3 (float)

Return type:

float

run_packmol(input_file=None, output_log=None, packmol_bin=None)[source]

Packmol を実行する。

Packmol はコマンドライン引数で入力ファイル名を受け取るのではなく、標準入力から .inp を読む使い方を前提にしている。そのため、このメソッドでは input_file を stdin に接続する。

Parameters:

input_file (str | None)
output_log (str | None)
packmol_bin (str | None)

Return type:

None

write_fnc_file(fnc_file, total_atom_count, fnc_pairs, distance_ranges_by_type, title='Fixed neighbours constraints generated from Packmol mapping')[source]

RMC_POT の通常 FNC 用 *.fnc ファイルを書き出す。

fnc_pairs は、すでに最終 POSCAR/cfg の 1 始まり原子番号へ変換済みの (atom_i, atom_j, constraint_type) で指定する。 RMC_POT の通常 FNC は、各原子について FNC neighbour の index と constraint type を列挙する形式なので、ここで対称な neighbour list へ展開する。

Parameters:

fnc_file (str)
total_atom_count (int)
fnc_pairs (Sequence[Tuple[int, int, int]])
distance_ranges_by_type (Dict[int, Tuple[float, float]])
title (str)

Return type:

None

write_single_atom_xyz(filename, element)[source]

単一原子のみを含む XYZ ファイルを生成する。

Parameters:

filename (str)
element (str)

Return type:

None

xyz_to_poscar(xyz_file, poscar_file='POSCAR', packmol_inp='packmol.inp', comment='packmol', elements=None)[source]

Packmol が出力した XYZ を VASP POSCAR へ変換する。

Packmol 出力は元素が混在した Cartesian XYZ である。 VASP POSCAR では元素ごとに座標をまとめ、Direct 座標で書くため、ここで元素順に並べ替えてセル長で割る。

セル長は packmol.inp の inside box 行から読む。

Returns:

Packmol XYZ の 1 始まり原子番号から、POSCAR の: 1 始まり原子番号への対応表。FNC を最終 POSCAR/cfg 番号で書くために使う。

Return type:

Dict[int, int]

Parameters:

xyz_file (str)
poscar_file (str)
packmol_inp (str)
comment (str)
elements (List[str] | None)

packmol_util.packmol_inp module

Packmol の入力ファイルを構築するための共通クラスである。

このファイルは、物質固有の構造を知らない。 make_*.py 側から渡された structure 情報を、Packmol の .inp 形式へ変換する。

class packmol_util.packmol_inp.PackmolInp(minimum_separation_distance, output_xyz, box_length, use_pbc=False)[source]

Bases: object

Packmol の .inp ファイルを構築するためのクラスである。

minimum_separation_distance は、Packmol 入力ファイル先頭の tolerance に対応する。これは、配置時に原子や分子ユニットが近づきすぎないようにする全体条件である。

add_structure() で登録する 1 件が、Packmol 入力の structure … end structure ブロック 1 個に対応する。

Parameters:

minimum_separation_distance (float)
output_xyz (str)
box_length (float)
use_pbc (bool)

add_structure(xyz_file, number, packing_radii_by_atom_symbol=None)[source]

1 つの単原子テンプレートまたは分子ユニットテンプレートを登録する。

xyz_file は、Li.xyz、Fe.xyz、PO4.xyz などのテンプレート座標である。 number は、そのテンプレートを Packmol が何個配置するかである。

packing_radii_by_atom_symbol は、必要な場合だけ指定する配置用の排除半径である。これは分子内距離ではない。例えば PO4 の P-O 距離や O-O 距離は、PO4.xyz を作る段階で決まる。ここで与える半径は、Packmol が複数の structure を箱の中へ置くときの重なり回避に使う。

Parameters:

xyz_file (str)
number (int)
packing_radii_by_atom_symbol (Dict[str, float] | None)

Return type:

None

write(inp_file)[source]

Packmol の .inp ファイルを書き出す。

ここで、make_*.py 側で作った recipe が、Packmol の具体的な入力形式になる。 structure ブロックは、1 種類の単原子テンプレートまたは 1 種類の分子ユニットを Packmol に何個配置させるかを表す。

Parameters:: inp_file (str)
Return type:: None

packmol_util.param module

定数定義。