{"library":"seekpath","title":"Seekpath: Brillouin Zone Paths","description":"Seekpath is a Python module designed to obtain and visualize k-vector coefficients and automatically generate high-symmetry band paths in the Brillouin zone of crystal structures. It integrates with spglib for symmetry analysis and is widely used in materials science for electronic structure calculations. The current version is 2.2.1, with minor releases typically occurring every few months to address bug fixes and improve compatibility.","language":"python","status":"active","last_verified":"Mon May 18","install":{"commands":["pip install seekpath"],"cli":null},"imports":["from seekpath import get_path"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import numpy as np\nfrom seekpath import get_path\n\n# Define a crystal structure (e.g., Silicon)\n# lattice: Bravais lattice vectors in Angstrom\nlattice = np.array([\n    [0.0, 2.715, 2.715],\n    [2.715, 0.0, 2.715],\n    [2.715, 2.715, 0.0],\n])\n# positions: fractional coordinates of atoms in the unit cell\npositions = np.array([\n    [0.0, 0.0, 0.0],\n    [0.25, 0.25, 0.25],\n])\n# numbers: atomic numbers\nnumbers = [14, 14] # Silicon\n\n# Get the recommended path and high-symmetry k-points\npath_data = get_path(lattice, positions, numbers)\n\nprint(f\"Points in reciprocal space: {path_data['point_coords'].keys()}\")\nprint(f\"Path segments: {path_data['path']}\")\n\n# Example: Accessing coordinates of a specific high-symmetry point\nprint(f\"Gamma point coordinates: {path_data['point_coords'].get('GAMMA')}\")","lang":"python","description":"This example demonstrates how to define a simple crystal structure (Silicon) and use `seekpath.get_path` to obtain the high-symmetry k-point path and coordinates in the Brillouin zone. The output `path_data` dictionary contains essential information for band structure calculations.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":{"tag":null,"tag_description":null,"last_tested":"2026-05-18","installed_version":"2.2.1","pypi_latest":"2.2.1","is_stale":false,"summary":{"python_range":"3.10–3.9","success_rate":50,"avg_install_s":3.9,"avg_import_s":null,"wheel_type":"wheel"},"results":[{"runtime":"python:3.10-alpine","python_version":"3.10","os_libc":"alpine (musl)","variant":"seekpath","exit_code":1,"wheel_type":null,"failure_reason":"build_error","import_side_effects":null,"install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":null},{"runtime":"python:3.10-slim","python_version":"3.10","os_libc":"slim (glibc)","variant":"seekpath","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":3.9,"import_time_s":null,"mem_mb":null,"disk_size":"93M"},{"runtime":"python:3.11-alpine","python_version":"3.11","os_libc":"alpine (musl)","variant":"seekpath","exit_code":1,"wheel_type":null,"failure_reason":"build_error","import_side_effects":null,"install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":null},{"runtime":"python:3.11-slim","python_version":"3.11","os_libc":"slim (glibc)","variant":"seekpath","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":3.8,"import_time_s":null,"mem_mb":null,"disk_size":"100M"},{"runtime":"python:3.12-alpine","python_version":"3.12","os_libc":"alpine (musl)","variant":"seekpath","exit_code":1,"wheel_type":null,"failure_reason":"build_error","import_side_effects":null,"install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":null},{"runtime":"python:3.12-slim","python_version":"3.12","os_libc":"slim (glibc)","variant":"seekpath","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":3.6,"import_time_s":null,"mem_mb":null,"disk_size":"88M"},{"runtime":"python:3.13-alpine","python_version":"3.13","os_libc":"alpine (musl)","variant":"seekpath","exit_code":1,"wheel_type":null,"failure_reason":"build_error","import_side_effects":null,"install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":null},{"runtime":"python:3.13-slim","python_version":"3.13","os_libc":"slim (glibc)","variant":"seekpath","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":3.5,"import_time_s":null,"mem_mb":null,"disk_size":"87M"},{"runtime":"python:3.9-alpine","python_version":"3.9","os_libc":"alpine (musl)","variant":"seekpath","exit_code":1,"wheel_type":null,"failure_reason":"build_error","import_side_effects":null,"install_time_s":null,"import_time_s":null,"mem_mb":null,"disk_size":null},{"runtime":"python:3.9-slim","python_version":"3.9","os_libc":"slim (glibc)","variant":"seekpath","exit_code":0,"wheel_type":"wheel","failure_reason":null,"import_side_effects":"broken","install_time_s":4.8,"import_time_s":null,"mem_mb":null,"disk_size":"103M"}]}}