Skip to main content

xtalforge

xtalforge (Python)

Python bindings for xtalforge, the pure Rust library for building, manipulating, analysing and exporting crystal structures. The same engine powers the Rust API, the CLI and the WebAssembly package.

Install

pip install xtalforge

The wheel is abi3 (CPython 3.9+) and ships NumPy arrays for positions, fractional positions, the cell matrix and atomic numbers.

Quick start

import xtalforge

structure = xtalforge.Structure.from_cif(cif_text)
print(structure.formula, structure.n_sites)
print(structure.positions)          # NumPy (n, 3), Angstrom
print(structure.cell)               # NumPy (3, 3), rows a, b, c

slab = structure.supercell(2, 2, 1).slab(0, 0, 1, layers=2, vacuum=10.0)
slab.write("slab.cif")

dataset = xtalforge.detect_symmetry(structure)
pattern = xtalforge.pxrd(structure)
print(dataset["hm_symbol"], pattern["points"][:3])

Structure also accepts the free-function wrappers: functions whose first argument is structure text accept a Structure handle and avoid reparsing. The 1.x text/dict API remains available; typed results (SymmetryDataset, PxrdPattern, PorosityReport, OptimizeResult) are dict-compatible.

Batch helpers

import xtalforge.batch

structures = xtalforge.batch.read(["a.cif", "b.cif"])
texts = [structure.to_json() for structure in structures]
datasets = xtalforge.batch.detect_symmetry(texts)
patterns = xtalforge.batch.pxrd(texts)

Results keep input order. See the object API guide for the full list of methods, arrays and batch helpers.

License

MIT OR Apache-2.0.

Metadata

Release files for xtalforge 1.11.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for xtalforge 1.11.0
File Size Uploaded Provenance Actions
xtalforge-1.11.0.tar.gz 2.0 MB Without provenance Details for xtalforge-1.11.0.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for xtalforge 1.11.0
File Actions
xtalforge-1.11.0-cp39-abi3-win_amd64.whl CPython 3.9 abi3 Windows x86-64 Details for xtalforge-1.11.0-cp39-abi3-win_amd64.whl
xtalforge-1.11.0-cp39-abi3-musllinux_1_1_x86_64.whl CPython 3.9 abi3 Linux musl 1.1+ x86-64 Details for xtalforge-1.11.0-cp39-abi3-musllinux_1_1_x86_64.whl
xtalforge-1.11.0-cp39-abi3-musllinux_1_1_aarch64.whl CPython 3.9 abi3 Linux musl 1.1+ ARM64 Details for xtalforge-1.11.0-cp39-abi3-musllinux_1_1_aarch64.whl
xtalforge-1.11.0-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl CPython 3.9 abi3 Linux glibc 2.17+ x86-64 Details for xtalforge-1.11.0-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
xtalforge-1.11.0-cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl CPython 3.9 abi3 Linux glibc 2.17+ ARM64 Details for xtalforge-1.11.0-cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
xtalforge-1.11.0-cp39-abi3-macosx_11_0_arm64.whl CPython 3.9 abi3 macOS 11.0+ ARM64 Details for xtalforge-1.11.0-cp39-abi3-macosx_11_0_arm64.whl
xtalforge-1.11.0-cp39-abi3-macosx_10_12_x86_64.whl CPython 3.9 abi3 macOS 10.12+ x86-64 Details for xtalforge-1.11.0-cp39-abi3-macosx_10_12_x86_64.whl

Total release size: 34.2 MB

Release files / xtalforge-1.11.0.tar.gz

Download URL xtalforge-1.11.0.tar.gz
Size 2.0 MB
Tags Source
SHA-256 checksum
How to use checksums
bc544ffc8d2dc96b788bdb03ca109a232d4b763049dfc856f1dc2669e40fab4f
BLAKE2b-256 checksum
How to use checksums
ddb441d99ce7842e190bd136f29adb21f894ab29daa86e0ad30a2ce9ba1bd274
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.16

Release files / xtalforge-1.11.0-cp39-abi3-win_amd64.whl

Download URL xtalforge-1.11.0-cp39-abi3-win_amd64.whl
Size 4.7 MB
Tags CPython 3.9 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
9f0c7983902bd9cc41a1405c4b6240e0d4690fe0a0e020b1c524193414afdd56
BLAKE2b-256 checksum
How to use checksums
2c3491f58d51331640d3260b0348e1ae54161afd70716749b82dffb94dfb5a24
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.16

Release files / xtalforge-1.11.0-cp39-abi3-musllinux_1_1_x86_64.whl

Download URL xtalforge-1.11.0-cp39-abi3-musllinux_1_1_x86_64.whl
Size 5.0 MB
Tags CPython 3.9 Linux musl 1.1+ x86-64 abi3
SHA-256 checksum
How to use checksums
5ef3d86a711eb62c86ee2ba26c321b073770a776019b70ebf0cf8e20e32ea9fa
BLAKE2b-256 checksum
How to use checksums
372169c0cebabbbfe37e131a8ae9bf57ccf766cdef6261a5b9feb6aa7286f7bc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.16

Release files / xtalforge-1.11.0-cp39-abi3-musllinux_1_1_aarch64.whl

Download URL xtalforge-1.11.0-cp39-abi3-musllinux_1_1_aarch64.whl
Size 4.6 MB
Tags CPython 3.9 Linux musl 1.1+ ARM64 abi3
SHA-256 checksum
How to use checksums
75d5086241dbe2a71514898c938e0968b49635a619a65376b49bab72c8356d7e
BLAKE2b-256 checksum
How to use checksums
2af801b071bca76ec91cd5f9e6eb7e18b6dad08d25f1df7895e34a847e54f6c3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.16

Release files / xtalforge-1.11.0-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

Download URL xtalforge-1.11.0-cp39-abi3-manylinux2014_x86_64.manylinux_2_17_x86_64.whl
Size 4.8 MB
Tags CPython 3.9 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
3da32f391f1c1d59522bb3af2bf489178084afa9c5e5471694bdef386567edb4
BLAKE2b-256 checksum
How to use checksums
758d38fe2b414955f740176e0ce028b66a28aa2fa893707a4c6c18c58c562e5c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.16

Release files / xtalforge-1.11.0-cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl

Download URL xtalforge-1.11.0-cp39-abi3-manylinux2014_aarch64.manylinux_2_17_aarch64.whl
Size 4.4 MB
Tags CPython 3.9 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
ac5331f9105e1787fe734a7f7f706d564fe7f1b92cc852129d574408a4fc1470
BLAKE2b-256 checksum
How to use checksums
a1ca9b65ee8988f2655c51e46c482aa93c79d8f5b7da1530050af51ce154a0e9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.16

Release files / xtalforge-1.11.0-cp39-abi3-macosx_11_0_arm64.whl

Download URL xtalforge-1.11.0-cp39-abi3-macosx_11_0_arm64.whl
Size 4.3 MB
Tags CPython 3.9 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
518265ba5686824005a7f441468fd426647f3a2af8e67838ceee4f242d279a01
BLAKE2b-256 checksum
How to use checksums
1eec4f42471f8af3629833df7405860574f0fce99a3e88191030154fa5290bc6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.16

Release files / xtalforge-1.11.0-cp39-abi3-macosx_10_12_x86_64.whl

Download URL xtalforge-1.11.0-cp39-abi3-macosx_10_12_x86_64.whl
Size 4.6 MB
Tags CPython 3.9 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
5f82f3bf060eb5c5956135363e14aee3cc7a3563ca13d0cdb37ebb6135b7ad59
BLAKE2b-256 checksum
How to use checksums
53318ed83487471dc4c545d518e1b4701e6496158838c3770ff3e9e6bef8d841
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.16

Security for xtalforge 1.11.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page