API reference
One page per domain, each showing the same operation in the four surfaces (Rust, CLI, Python, WebAssembly). The pages cover the stable public surface; the complete per-item Rust reference is the rustdoc generated by cargo doc --workspace (and docs.rs after the first release).
- Binding architecture
- Core API
- Elements
- Lattice
- Limits
- Structures and sites
- Structure schema
- P1 expansion
- Supercells and origin shifts
- Slabs
- Finite cells and transforms
- Neighbors
- Bonding
- CIF input and output
- POSCAR and XYZ
- Measures, scalars and descriptions
- Functional groups
- Rings
- Symmetry
- Typed parameters
- Projects and workspaces
- View data
- Core features (Phase 9)
- Carbon builders
- MOF builder
- Powder and porosity
- Powder refinement
- Force fields
- External engines and quantum adapter
- Selection and tracking
- Modules and workspace
- Commands and document
- Agent session
- Plugins and extension points
- Machine-learning potentials
- API stability and SemVer
- Surface parity matrix
- Hello-world API
The source of each surface is the same Rust engine:
| Section | Source |
|---|---|
| Rust | rustdoc comments and this API section |
| Python | crates/xtalforge-python/python/xtalforge/__init__.pyi |
| JavaScript / TypeScript | wasm-pack generated .d.ts |
| CLI | xtalforge --help and the JSON output of each command |