gugen 0.3.0

Explainable materials synthesis and process planning
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

use crate::composition::{Composition, Element};
use std::collections::BTreeSet;

/// Minimal structural hint about the target: free text, deliberately.
/// `chematic-crystal` is now published and, with the `chematic_crystal`
/// feature enabled, `crate::to_mikiwame_structure` can convert a real
/// `chematic_crystal::PeriodicStructure` into something `mikiwame::analyze`
/// consumes (Phase 16) -- but that conversion is a standalone,
/// caller-driven bridge, not a field here. Giving `TargetStructure` itself
/// a geometry field would need real `Planner`/report-level wiring
/// decisions (how a report should represent per-target structural
/// diagnostics) that Phase 16 deliberately left out of scope; see
/// `docs/integration.md`. gugen does not implement its own crystal-
/// structure representation either way (AGENTS.md §5).
#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct TargetStructure {
    pub description: String,
}

#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct PhaseRequirement {
    pub phase_name: String,
}

/// User-supplied constraints on the planning search. Deliberately minimal
/// in Phase 1 — Phase 3 (precursor enumeration) adds the rest of the
/// filters listed in AGENTS.md §9 alongside the search that consumes them.
#[derive(Debug, Clone, PartialEq, Default)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct PlanningConstraints {
    pub forbidden_elements: BTreeSet<Element>,
}

#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct TargetSpecification {
    pub composition: Composition,
    pub structure: Option<TargetStructure>,
    pub desired_phase: Option<PhaseRequirement>,
    pub constraints: PlanningConstraints,
}

/// Boundary trait gugen depends on instead of a concrete crystal-structure
/// type (AGENTS.md §5). Implemented directly by [`TargetSpecification`]
/// today; a future `chematic-crystal` adapter implements it over the real
/// structure types without changing anything downstream of `target.rs`
/// (docs/integration.md).
pub trait TargetMaterialView {
    fn composition(&self) -> &Composition;
    fn structure_metadata(&self) -> Option<&TargetStructure>;
}

impl TargetMaterialView for TargetSpecification {
    fn composition(&self) -> &Composition {
        &self.composition
    }

    fn structure_metadata(&self) -> Option<&TargetStructure> {
        self.structure.as_ref()
    }
}