chematic_crystal/lib.rs
1#![forbid(unsafe_code)]
2//! `chematic-crystal` — periodic (crystal) structure representation and
3//! geometry for the chematic ecosystem.
4//!
5//! This crate is a pure structural/geometric foundation: [`Lattice`],
6//! fractional/Cartesian coordinates, [`PeriodicSite`]/[`PeriodicStructure`],
7//! periodic-boundary-condition displacement and distance, periodic neighbor
8//! enumeration, and diagonal supercells. It is deliberately **not** an
9//! extension of `chematic_core::Molecule` -- see the crate README and
10//! `docs/rfcs/chematic_crystal_foundation.md` for why a periodic crystal
11//! and a molecular bond graph are kept as distinct first-class types.
12//!
13//! # Scope
14//!
15//! No symmetry (space groups, Wyckoff positions, Niggli reduction), no CIF
16//! parser, no XRD, no DFT, no materials-property prediction. See
17//! `docs/crystal_scope.md` for the full non-goal list.
18//!
19//! # Design principles
20//!
21//! - Pure Rust, `#![forbid(unsafe_code)]`, zero required dependencies
22//! beyond `chematic-core` (optional `serde`).
23//! - Compiles to `wasm32-unknown-unknown` without modification.
24//! - Public constructors reject `NaN`/`Infinity` rather than propagate them.
25//! - Deterministic output ordering everywhere (no float-keyed sorts).
26
27pub mod error;
28pub mod fingerprint;
29pub mod lattice;
30pub mod neighbor;
31pub mod periodic;
32pub mod poscar;
33pub mod site;
34pub mod structure;
35pub mod supercell;
36pub mod validation;
37
38pub use error::CrystalError;
39pub use fingerprint::{
40 FingerprintError, FingerprintLimits, GeometryFingerprint, geometry_fingerprint,
41};
42pub use lattice::Lattice;
43pub use neighbor::PeriodicNeighbor;
44pub use periodic::{PeriodicDisplacement, minimum_image};
45pub use poscar::{
46 PoscarDocument, PoscarError, PredictorCorrector, parse_contcar, parse_poscar, write_poscar,
47};
48pub use site::{CartesianCoord, FractionalCoord, Occupancy, PeriodicSite, SiteSpecies};
49pub use structure::{CompositionSummary, PeriodicStructure};
50
51#[cfg(test)]
52mod poscar_boundary_contract_tests;