tkcrystal APIリファレンス

対象ソース: tklib2.zip（解析日: 2026-08-03）。この文書はソースコードを静的解析して生成しています。

APIの読み方

パッケージ公開APIは、原則としてトップレベルの __all__ に含まれる名前です。
モジュールAPIには、公開名（先頭が _ でない関数・クラス・メソッド）を列挙しています。
docstringがないAPIでは、シグネチャとソースパスを一次情報として扱ってください。
生成AIは、この文書に存在しない引数・戻り値・メソッドを推測で追加しないでください。

パッケージ公開API

from tkcrystal import (
    get_atom_inf,
    get_composition_inf_from_formula,
    get_xrd_inf,
    get_available_xray_wavelengths,
    get_crystal_inf,
    get_lattice_inf,
    get_composition_inf,
    get_density_inf,
    get_site_inf,
    get_neighbor_inf,
    get_spg_inf,
    get_symmetry_operations_inf,
    expand_coordinates_spg,
    symmetrize_structure,
)

名前	推奨用途
`get_atom_inf`	トップレベルから安定してimportできる公開API
`get_composition_inf_from_formula`	トップレベルから安定してimportできる公開API
`get_xrd_inf`	トップレベルから安定してimportできる公開API
`get_available_xray_wavelengths`	トップレベルから安定してimportできる公開API
`get_crystal_inf`	トップレベルから安定してimportできる公開API
`get_lattice_inf`	トップレベルから安定してimportできる公開API
`get_composition_inf`	トップレベルから安定してimportできる公開API
`get_density_inf`	トップレベルから安定してimportできる公開API
`get_site_inf`	トップレベルから安定してimportできる公開API
`get_neighbor_inf`	トップレベルから安定してimportできる公開API
`get_spg_inf`	トップレベルから安定してimportできる公開API
`get_symmetry_operations_inf`	トップレベルから安定してimportできる公開API
`expand_coordinates_spg`	トップレベルから安定してimportできる公開API
`symmetrize_structure`	トップレベルから安定してimportできる公開API

モジュール一覧

モジュール	ソース	関数	クラス
`tkcrystal`	`tkcrystal/__init__.py`	0	0
`tkcrystal.atom`	`tkcrystal/atom.py`	2	0
`tkcrystal.backends`	`tkcrystal/backends.py`	6	2
`tkcrystal.diffraction`	`tkcrystal/diffraction.py`	2	0
`tkcrystal.info`	`tkcrystal/info.py`	6	0
`tkcrystal.printer`	`tkcrystal/printer.py`	3	0
`tkcrystal.symmetry`	`tkcrystal/symmetry.py`	6	0

`tkcrystal`

ソース: tkcrystal/__init__.py

tkcrystal: simple dictionary wrappers for crystal-structure information.

このモジュールには静的解析で検出された公開関数・クラス・定数はありません。

`tkcrystal.atom`

ソース: tkcrystal/atom.py

function `get_atom_inf`

def get_atom_inf(atom: str | int | Any, *, backend: str = 'pymatgen') -> dict[str, Any]

ソース内docstringはありません。シグネチャと実装を参照してください。

function `get_composition_inf_from_formula`

def get_composition_inf_from_formula(formula: str, *, backend: str = 'pymatgen') -> dict[str, Any]

ソース内docstringはありません。シグネチャと実装を参照してください。

`tkcrystal.backends`

ソース: tkcrystal/backends.py

class `BackendError` — bases: `RuntimeError`

ソース内docstringはありません。シグネチャと実装を参照してください。

class `BackendNotAvailableError` — bases: `BackendError`

ソース内docstringはありません。シグネチャと実装を参照してください。

function `normalize_backend`

def normalize_backend(backend: str | None = 'auto') -> str

ソース内docstringはありません。シグネチャと実装を参照してください。

function `require_pymatgen`

def require_pymatgen() -> None

ソース内docstringはありません。シグネチャと実装を参照してください。

function `is_pymatgen_structure`

def is_pymatgen_structure(obj: Any) -> bool

ソース内docstringはありません。シグネチャと実装を参照してください。

function `dispatch_structure_backend`

def dispatch_structure_backend(structure: Any, backend: str | None = 'auto') -> str

ソース内docstringはありません。シグネチャと実装を参照してください。

function `safe_float`

def safe_float(x: Any, default = None)

ソース内docstringはありません。シグネチャと実装を参照してください。

function `to_builtin`

def to_builtin(obj: Any) -> Any

ソース内docstringはありません。シグネチャと実装を参照してください。

`tkcrystal.diffraction`

ソース: tkcrystal/diffraction.py

function `get_available_xray_wavelengths`

def get_available_xray_wavelengths(*, backend: str = 'pymatgen') -> dict[str, Any]

ソース内docstringはありません。シグネチャと実装を参照してください。

function `get_xrd_inf`

def get_xrd_inf(structure: Any, *, backend: str = 'auto', wavelength: str | float = 'CuKa1', two_theta_range = (10.0, 80.0), symprec: float = 0.0, max_peaks: int | None = None) -> dict[str, Any]

ソース内docstringはありません。シグネチャと実装を参照してください。

`tkcrystal.info`

ソース: tkcrystal/info.py

公開定数・モジュール変数

名前	型/値
`AMU_TO_G`	`1.6605390666e-24`
`ANG3_TO_CM3`	`1e-24`

function `get_lattice_inf`

def get_lattice_inf(structure: Any, *, backend: str = 'auto') -> dict[str, Any]

ソース内docstringはありません。シグネチャと実装を参照してください。

function `get_site_inf`

def get_site_inf(structure: Any, *, backend: str = 'auto', max_sites: int | None = None, include_cartesian = True) -> dict[str, Any]

ソース内docstringはありません。シグネチャと実装を参照してください。

function `get_composition_inf`

def get_composition_inf(structure: Any, *, backend: str = 'auto') -> dict[str, Any]

ソース内docstringはありません。シグネチャと実装を参照してください。

function `get_density_inf`

def get_density_inf(structure: Any, *, backend: str = 'auto') -> dict[str, Any]

ソース内docstringはありません。シグネチャと実装を参照してください。

function `get_crystal_inf`

def get_crystal_inf(structure: Any, *, backend: str = 'auto', include_sites = True, max_sites: int | None = None, include_symmetry = True, symprec: float = 0.001) -> dict[str, Any]

ソース内docstringはありません。シグネチャと実装を参照してください。

function `get_neighbor_inf`

def get_neighbor_inf(structure: Any, *, site_index: int = 0, radius: float = 5.0, backend: str = 'auto') -> dict[str, Any]

ソース内docstringはありません。シグネチャと実装を参照してください。

`tkcrystal.printer`

ソース: tkcrystal/printer.py

function `print_inf`

def print_inf(data: dict[str, Any], *, mode: str = 'pprint') -> None

ソース内docstringはありません。シグネチャと実装を参照してください。

function `crystal_inf_to_text`

def crystal_inf_to_text(data: dict[str, Any]) -> str

ソース内docstringはありません。シグネチャと実装を参照してください。

function `print_crystal_inf`

def print_crystal_inf(data: dict[str, Any]) -> None

ソース内docstringはありません。シグネチャと実装を参照してください。

`tkcrystal.symmetry`

ソース: tkcrystal/symmetry.py

function `get_spg_inf`

def get_spg_inf(structure: Any, *, backend: str = 'auto', symprec: float = 0.001, angle_tolerance: float = 5.0) -> dict[str, Any]

ソース内docstringはありません。シグネチャと実装を参照してください。

function `classify_symop`

def classify_symop(op: Any, tol: float = 1e-05) -> str

ソース内docstringはありません。シグネチャと実装を参照してください。

function `format_symop_xyz`

def format_symop_xyz(op: Any) -> str

ソース内docstringはありません。シグネチャと実装を参照してください。

function `get_symmetry_operations_inf`

def get_symmetry_operations_inf(structure: Any, *, backend: str = 'auto', symprec: float = 0.001, angle_tolerance: float = 5.0, max_ops: int | None = None) -> dict[str, Any]

ソース内docstringはありません。シグネチャと実装を参照してください。

function `symmetrize_structure`

def symmetrize_structure(structure: Any, *, backend: str = 'auto', symprec: float = 0.001, angle_tolerance: float = 5.0, mode: str = 'symmetrized') -> Any

ソース内docstringはありません。シグネチャと実装を参照してください。

function `expand_coordinates_spg`

def expand_coordinates_spg(ispg: int, xyz: str | list[float] | tuple[float, float, float], *, backend: str = 'pymatgen', rmin: float = 1e-05, max_ops: int | None = None) -> dict[str, Any]

ソース内docstringはありません。シグネチャと実装を参照してください。

tkcrystal APIリファレンス

APIの読み方

パッケージ公開API

モジュール一覧

tkcrystal

tkcrystal.atom

function get_atom_inf

function get_composition_inf_from_formula

tkcrystal.backends

class BackendError — bases: RuntimeError

class BackendNotAvailableError — bases: BackendError

function normalize_backend

function require_pymatgen

function is_pymatgen_structure

function dispatch_structure_backend

function safe_float

function to_builtin

tkcrystal.diffraction

function get_available_xray_wavelengths

function get_xrd_inf

tkcrystal.info

公開定数・モジュール変数

function get_lattice_inf

function get_site_inf

function get_composition_inf

function get_density_inf

function get_crystal_inf

function get_neighbor_inf

tkcrystal.printer

function print_inf

function crystal_inf_to_text

function print_crystal_inf

tkcrystal.symmetry

function get_spg_inf

function classify_symop

function format_symop_xyz

function get_symmetry_operations_inf

function symmetrize_structure

function expand_coordinates_spg

`tkcrystal`

`tkcrystal.atom`

function `get_atom_inf`

function `get_composition_inf_from_formula`

`tkcrystal.backends`

class `BackendError` — bases: `RuntimeError`

class `BackendNotAvailableError` — bases: `BackendError`

function `normalize_backend`

function `require_pymatgen`

function `is_pymatgen_structure`

function `dispatch_structure_backend`

function `safe_float`

function `to_builtin`

`tkcrystal.diffraction`

function `get_available_xray_wavelengths`

function `get_xrd_inf`

`tkcrystal.info`

function `get_lattice_inf`

function `get_site_inf`

function `get_composition_inf`

function `get_density_inf`

function `get_crystal_inf`

function `get_neighbor_inf`

`tkcrystal.printer`

function `print_inf`

function `crystal_inf_to_text`

function `print_crystal_inf`

`tkcrystal.symmetry`

function `get_spg_inf`

function `classify_symop`

function `format_symop_xyz`

function `get_symmetry_operations_inf`

function `symmetrize_structure`

function `expand_coordinates_spg`