powerio 0.11.5

//! PowerIO: compiler infrastructure for power system data.
//!
//! The short `powerio` name is the entry facade over the component crates:
//! `powerio-core` (sources, diagnostics, errors, modules), `powerio-tx`
//! (the balanced transmission model and its format parsing and emission),
//! `powerio-dist` (the multiconductor distribution model), and `powerio-prob`
//! (operating points, problem instances, and solutions). The facade owns the
//! dynamic value boundary: [`PioValue`], [`parse`], [`emit`], [`serialize`],
//! and [`deserialize`].
//!
//! [`parse`] compiles one input into `PioModule<PioValue>`, routing to
//! whichever built in family claims it. Inspect the value with ordinary enum
//! matching and emit the module without discarding its input or diagnostics:
//!
//! ```no_run
//! let module = powerio::parse("case9.m")?;
//! match module.value() {
//!     powerio::PioValue::BalancedNetwork(network) => {
//!         println!("{} buses", network.buses().len());
//!     }
//!     other => println!("parsed {}", other.type_name()),
//! }
//! powerio::emit(&module, "matpower", "copy.m")?;
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```
//!
//! A file name, a directory name, and content already in memory all reach the
//! same operation, so it does not multiply into name-, text-, and
//! byte-specific verbs:
//!
//! ```no_run
//! let from_file = powerio::parse("case9.m")?;
//! let from_directory = powerio::parse("pypsa_case/")?;
//! let from_memory = powerio::parse(std::fs::read("case9.egret.json")?)?;
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```
//!
//! Content in memory carries the name `<memory>`, which identifies no format,
//! so a format detected from a file extension rather than from the document
//! itself is either declared or named:
//!
//! ```no_run
//! let declared = powerio::parse_with_options(
//!     std::fs::read("case9.m")?,
//!     &powerio::ParseOptions::default().format("matpower")?,
//! )?;
//! let named = powerio::parse(powerio::Source::from_memory(
//!     "case9.m",
//!     std::fs::read("case9.m")?,
//! )?)?;
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```
//!
//! A geographic layer is a value like any other: the canonical `.geo.json`,
//! GeoJSON, aliased CSV or JSON records, headerless buscoords CSV, and a
//! PowerWorld `.pwd` display all parse to [`PioValue::GeoLayer`], `emit`
//! writes one as `geo-json`, and [`apply_geo_layer`] places one onto a case.
//!
//! The three files a PSS/E contingency analysis reads are values of the same
//! kind. A `.con` parses to [`PioValue::ContingencySet`], a `.sub` to
//! [`PioValue::SubsystemSet`], and a `.mon` to [`PioValue::MonitoredSet`];
//! `emit` writes each back under its own token, and `ContingencySet::resolve`,
//! `Subsystem::select_buses`, and `MonitoredSet::resolve` bind one to a
//! network.
//!
//! [`parse_with_options`] selects the parser explicitly and widens the
//! directory a format may refer to further files beneath. [`Source`] and
//! [`Destination`] remain the advanced input and output: a source carrying
//! named buffers for a multi-file case in memory, and a memory destination
//! with its artifact root name.
//!
//! ```no_run
//! let module = powerio::parse_with_options(
//!     "case.data",
//!     &powerio::ParseOptions::default().format("psse")?,
//! )?;
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```

/// The facade version recorded on producers and stored modules.
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

/// The `schema` discriminator of every PowerIO IR document.
pub const IR_SCHEMA_NAME: &str = "pio-ir";

/// The PowerIO IR version this build writes.
///
/// The IR version is an integer that advances only when the serialized
/// representation changes incompatibly for an existing value type. It is
/// independent of the PowerIO release, which the `producer` record of a
/// document names, and of the C ABI version.
///
/// | IR version | First release | Change |
/// |---|---|---|
/// | 1 | v0.10.0 | the `PioModule` serialization, under the identity `powerio.module` |
/// | 2 | v0.11.0 | the identity `pio-ir`; the producer release recorded apart from the IR version; retained source bytes left out |
///
/// Additive structural types keep the IR version unchanged. A reader accepts
/// the types it implements; an unknown type requires a newer reader.
/// [`IR_MIN_VERSION`] is the oldest IR version this build reads.
pub const IR_VERSION: u64 = 2;

/// The oldest PowerIO IR version this build reads.
///
/// The floor rises only at a minor release boundary. PowerIO 0.11 writes and
/// reads IR version 2.
pub const IR_MIN_VERSION: u64 = 2;

/// The `$id` of the schema snapshot describing this build's structural types.
/// The release in the path identifies the catalog, not a new IR version.
pub const IR_SCHEMA_ID: &str = "https://powerio.dev/schema/pio-ir/2/0.11.5/schema.json";

use powerio_tx::format;
pub use powerio_tx::{
    Area, AutomaticOrder, AutomaticSpec, AutomaticTarget, BalancedNetwork, Branch, BranchCharging,
    BranchCurrentRatings, BranchRatingSet, BranchRef, BranchSolution, BranchSusceptanceFormula,
    Bus, BusId, BusType, Canvas, Change, ChangeOp, ChangeUnit, ContingencyAction, ContingencyCase,
    ContingencyParsed, ContingencyResolution, ContingencySet, CoordinateSpace, CoordsKind,
    DEFAULT_BASE_FREQUENCY, Detection, ElementKey, Expanded, Extras, GenCaps, GenCost, Generator,
    GeoApplyReport, GeoFeature, GeoGeometry, GeoLayer, GeoMeta, GeoParsed, GeoTarget, Hvdc,
    Impedance, IndexCore, IndexedNetwork, InterfaceMember, JSON_CLASSES, JoinName, JsonClass, Load,
    LoadVoltageModel, Location, MonitorScope, MonitorStatement, MonitoredParsed,
    MonitoredResolution, MonitoredSet, PsseEquipmentIndex, PwdDisplay, PwdSubstation, ResolvedCase,
    ResolvedComponent, ResolvedInterface, ResolvedVoltageScope, RetainedStatement, Selector,
    SelectorGroup, Shunt, ShuntBlock, SkipRule, SolverParams, SourceFormat, Storage, Subsystem,
    SubsystemParsed, SubsystemSelector, SubsystemSet, Switch, SwitchedShuntControl,
    SwitchedShuntMode, Transformer3W, TransformerControl, TransformerControlMode, UnresolvedAction,
    UnresolvedMonitor, UnresolvedMonitorReason, UnresolvedReason, Winding, apply_substation_points,
    calc_series_admittance_of, classify_json_bytes, classify_json_text, repair_values,
    to_geo_layer_from_pwd, to_lonlat_from_pwd_mercator,
};
/// Balanced network records and the public network and geographic submodules.
/// Derived indexes, normalization data, solver tables, and component error
/// types remain available from `powerio-tx` rather than being duplicated at
/// the facade root.
pub use powerio_tx::{contingency, geo, network, version};

pub use powerio_core::diagnostic_codes;
/// The common module records and containers. These explicit facade exports
/// keep ordinary callers out of the component crate paths.
pub use powerio_core::{
    ArtifactPath, ComponentId, Destination, Diagnostic, DiagnosticCode, DiagnosticId,
    DiagnosticInfo, DiagnosticSeverity, DiagnosticStage, Digest, DigestAlgorithm, EmitResult,
    EmittedOutput, Fidelity, FormatId, HistoryEntry, HistoryId, HistoryKind, MemoryArtifact,
    OutputLayout, PioModule, Producer, Scenario, ScenarioId, ScenarioSet, Source, SourceBuffer,
    SourceDescriptor, SourceId, SourceMapEntry, SourceRelation, SourceSpan, StagedEdit, TimePoint,
    TimeSeries,
};

/// The facade error covers source acquisition, routing, stored modules, and
/// component failures converted at their boundary.
pub use powerio_core::Error;
pub type Result<T> = std::result::Result<T, powerio_core::Error>;

/// Distribution types remain grouped under `powerio::dist` where their names
/// overlap with balanced network types. Common unambiguous records are also
/// available at the facade root.
pub use powerio_dist as dist;
pub use powerio_dist::{
    BmopfEmitOptions, BmopfSchemaVersion, ConductorMatrix, DistGeoMeta, DistGraphEdgeKind,
    MulticonductorNetwork, NeutralKronOptions, NeutralKronReport,
};

pub use powerio_prob::solution::{SocwrOpfDuals, SocwrOpfSolution, SocwrOpfValues};
/// The calculation types used by solver consumers. The full problem
/// vocabulary lives in [`powerio_prob`]; these types sit at the facade root so
/// a consumer does not need a second PowerIO dependency to name its boundary.
pub use powerio_prob::{
    AcBusSpecification, AcOpfInstance, AcOpfSolution, AcPfInstance, AcPfSolution, AcScucInstance,
    AcScucSolution, ActivePower, ActivePowerUnit, ApparentPower, ApparentPowerUnit,
    BalancedCalculationInstance, CalculationUpdate, DcBusSpecification, DcOpfInstance,
    DcOpfSolution, DcPfInstance, DcPfSolution, LinDist3FlowApplicability,
    LinDist3FlowApplicabilityStatus, LinDist3FlowBuildOptions, LinDist3FlowLimitCheck,
    LinDist3FlowLimitKind, LinDist3FlowNode, LinDist3FlowOpfInstance, LinDist3FlowOpfSolution,
    LinDist3FlowOpfValues, LinDist3FlowPfInstance, LinDist3FlowPfSolution,
    LinDist3FlowPreparationAction, LinDist3FlowPreparationActionKind,
    LinDist3FlowPreparationReport, LinDist3FlowReferencePolicy, LinDist3FlowReferenceProvenance,
    LinDist3FlowReferenceState, LinDist3FlowTopology, LinDist3FlowUnsupported, LoadAllocation,
    McAcOpfInstance, McAcOpfSolution, McAcPfInstance, McAcPfSolution, NetworkUpdate,
    OperatingPointUpdate, ReactivePower, ReactivePowerUnit, Termination,
    ThreeWindingTransformerTerminalActivePower, ThreeWindingTransformerTerminalPower, UpdateChange,
    UpdateReport, UpdatedField, apply_bus_load_active_power, apply_updates,
    evaluate_lindist3flow_pf_limits,
};

/// Matrix and graph data, re-exported from `powerio-matrix` under the
/// `matrix` feature. Matrix construction is never a parse result, so the
/// facade's automatic parsing and [`PioValue`] do not change with this
/// feature.
#[cfg(feature = "matrix")]
pub use powerio_matrix as matrix;

#[cfg(feature = "gridfm")]
#[doc(hidden)]
#[path = "gridfm.rs"]
pub mod __gridfm;
pub mod codes;
mod formats;
pub use formats::{FormatInfo, resolve_format};
#[cfg(feature = "gridfm")]
mod collect;
pub mod dist_geo;
#[cfg(feature = "gridfm")]
pub use __gridfm::codes as gridfm_codes;
mod stored;
mod write;
pub use write::emit;
mod ir;
#[cfg(feature = "schema")]
pub use ir::generate_ir_schema;
pub use ir::{deserialize, serialize, serialize_diagnostics};
pub mod transform;
pub use transform::{
    apply_geo_layer, network_with_operating_point, neutral_kron, neutral_kron_with_options,
    to_ac_opf_instance, to_ac_pf_instance, to_dc_opf_instance, to_dc_pf_instance,
    to_lindist3flow_opf_instance, to_lindist3flow_opf_instance_with_options,
    to_lindist3flow_pf_instance, to_lindist3flow_pf_instance_with_options, to_mc_ac_opf_instance,
    to_mc_ac_pf_instance,
};

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
enum Goc3DataFileKind {
    Problem,
    Solution,
}

#[derive(Default)]
struct Goc3DataFiles {
    problem: Option<SourceBuffer>,
    solution: Option<SourceBuffer>,
}

impl Goc3DataFiles {
    fn insert(&mut self, kind: Goc3DataFileKind, buffer: SourceBuffer) -> Result<()> {
        let slot = match kind {
            Goc3DataFileKind::Problem => &mut self.problem,
            Goc3DataFileKind::Solution => &mut self.solution,
        };
        if let Some(existing) = slot {
            return Err(Error::new(
                &powerio_tx::diagnostics::codes::READ_GOC3_AMBIGUOUS_DOCUMENTS,
                format!(
                    "GO Challenge 3 source contains both `{}` and `{}` as {} data files",
                    existing.name(),
                    buffer.name(),
                    match kind {
                        Goc3DataFileKind::Problem => "problem",
                        Goc3DataFileKind::Solution => "solution",
                    }
                ),
            ));
        }
        *slot = Some(buffer);
        Ok(())
    }
}

/// The GO Challenge 3 root keys, read without building a document tree.
#[derive(Default, serde::Deserialize)]
struct Goc3Roots {
    #[serde(default)]
    network: Option<serde::de::IgnoredAny>,
    #[serde(default)]
    time_series_input: Option<serde::de::IgnoredAny>,
    #[serde(default)]
    reliability: Option<serde::de::IgnoredAny>,
    #[serde(default)]
    time_series_output: Option<serde::de::IgnoredAny>,
}

impl Goc3Roots {
    fn is_problem(&self) -> bool {
        self.network.is_some() && self.time_series_input.is_some() && self.reliability.is_some()
    }

    fn is_solution(&self) -> bool {
        self.time_series_output.is_some()
    }
}

/// The GO Challenge 3 root keys of a JSON document, or `None` for a well
/// formed document whose root is not an object.
fn goc3_roots(buffer: &SourceBuffer) -> Result<Option<Goc3Roots>> {
    match serde_json::from_slice::<Goc3Roots>(buffer.content_bytes()) {
        Ok(roots) => Ok(Some(roots)),
        Err(error) if error.classify() == serde_json::error::Category::Data => Ok(None),
        Err(error) => Err(Error::new(
            &powerio_tx::diagnostics::codes::PARSE_GOC3_MALFORMED,
            format!("{}: {error}", buffer.name()),
        )),
    }
}

fn goc3_file_kind(buffer: &SourceBuffer) -> Result<Option<Goc3DataFileKind>> {
    let Some(roots) = goc3_roots(buffer)? else {
        return Ok(None);
    };
    match (roots.is_problem(), roots.is_solution()) {
        (true, false) => Ok(Some(Goc3DataFileKind::Problem)),
        (false, true) => Ok(Some(Goc3DataFileKind::Solution)),
        (false, false) => Ok(None),
        (true, true) => Err(Error::new(
            &powerio_tx::diagnostics::codes::READ_GOC3_AMBIGUOUS_DOCUMENTS,
            format!(
                "{} contains both the GO Challenge 3 problem and solution roots",
                buffer.name()
            ),
        )),
    }
}

fn goc3_data_files(source: &Source) -> Result<Goc3DataFiles> {
    let mut buffers = if source.is_directory() {
        let mut buffers = Vec::new();
        for name in source.entry_names()? {
            if std::path::Path::new(name.as_str())
                .extension()
                .and_then(|extension| extension.to_str())
                .is_some_and(|extension| extension.eq_ignore_ascii_case("json"))
            {
                buffers.push(source.buffer(&name)?);
            }
        }
        buffers
    } else {
        let mut buffers = vec![source.primary_buffer()?];
        // `entry_names` succeeds here only for an in-memory source with named
        // buffers. A file source never searches sibling files.
        if let Ok(names) = source.entry_names() {
            for name in names {
                buffers.push(source.root_buffer(name.as_str())?);
            }
        }
        buffers
    };
    buffers.sort_by(|left, right| left.name().cmp(right.name()));

    let mut files = Goc3DataFiles::default();
    for buffer in buffers {
        if let Some(kind) = goc3_file_kind(&buffer)? {
            files.insert(kind, buffer)?;
        }
    }
    Ok(files)
}

fn directory_has_goc3_data(source: &Source) -> bool {
    source.entry_names().is_ok_and(|names| {
        names.into_iter().any(|name| {
            std::path::Path::new(name.as_str())
                .extension()
                .and_then(|extension| extension.to_str())
                .is_some_and(|extension| extension.eq_ignore_ascii_case("json"))
                && source.buffer(&name).is_ok_and(|buffer| {
                    goc3_roots(&buffer).is_ok_and(|roots| {
                        roots.is_some_and(|roots| roots.is_solution() || roots.is_problem())
                    })
                })
        })
    })
}

/// Transform the `Substation` table in PowerWorld AUX text into a geographic
/// layer without exposing the component parser's borrowed `AuxFile` type.
///
/// Rows without a finite number, latitude, and longitude are skipped. A valid
/// AUX document with no usable substation coordinates returns an empty layer.
///
/// # Errors
/// The AUX section syntax is malformed.
pub fn to_geo_layer_from_aux_text(text: &str) -> Result<GeoLayer> {
    let aux = powerio_tx::format::powerworld::aux_sections(text)
        .map_err(|error| Error::new(error.code(), error.to_string()).with_cause(error))?;
    Ok(powerio_tx::to_geo_layer_from_aux_substations(&aux))
}

/// A possibly partial assignment of instantaneous operating quantities over
/// one network's fixed equipment identities.
pub use powerio_prob::OperatingPoint;
mod value;
pub use value::{PioScenarioSet, PioTimeSeries, PioValue};

/// Optional configuration for [`parse_with_options`]. Every field defaults to
/// inference, so [`ParseOptions::default`] is what [`parse`] uses.
#[derive(Clone, Debug, Default)]
#[non_exhaustive]
pub struct ParseOptions {
    /// The parser selected by its stable format token rather than inferred
    /// from the input's name and content.
    pub format: Option<powerio_core::FormatId>,
    /// The directory beneath which a format may refer to further files,
    /// widening the default of the input file's own directory.
    pub acquisition_root: Option<std::path::PathBuf>,
}

impl ParseOptions {
    /// Select the parser by its stable format token.
    ///
    /// # Errors
    /// `REQUEST.FORMAT.INVALID_ID` when the token is not a format identifier.
    pub fn format(mut self, format: &str) -> std::result::Result<Self, powerio_core::Error> {
        self.format = Some(powerio_core::FormatId::new(format)?);
        Ok(self)
    }

    /// Select the parser by an already validated format identity.
    #[must_use]
    pub fn format_id(mut self, format: powerio_core::FormatId) -> Self {
        self.format = Some(format);
        self
    }

    /// Permit acquisition of files a format refers to beneath `root`.
    #[must_use]
    pub fn acquisition_root(mut self, root: impl Into<std::path::PathBuf>) -> Self {
        self.acquisition_root = Some(root.into());
        self
    }
}

/// Parse one source into a compiled module of whichever built in family
/// claims it. Balanced network formats produce
/// [`PioValue::BalancedNetwork`]; network only distribution formats (OpenDSS
/// `.dss`, PMD ENGINEERING JSON, and BMOPF JSON) produce
/// [`PioValue::MulticonductorNetwork`]. A source that defines a particular
/// calculation produces that calculation's value. One DOE GO Challenge 3
/// problem data file produces [`PioValue::AcScucInstance`]. One source that
/// contains a problem data file and its matching solution data file produces
/// [`PioValue::AcScucSolution`]; a solution data file alone is rejected because
/// its row identities and time axis come from the problem. DeepMind OPFData
/// JSON, which explicitly represents a solved AC OPF, produces
/// [`PioValue::AcOpfSolution`]. The parser's findings are the module's
/// diagnostics, and the module keeps the original input, so writing the same
/// format again returns the original file content.
///
/// The input is a file or directory name, content already in memory, or a
/// [`powerio_core::Source`] carrying named buffers or a widened acquisition
/// root. [`parse_with_options`] selects the parser explicitly. Content in
/// memory carries the name [`powerio_core::MEMORY_SOURCE_NAME`], which
/// identifies no format, so a format detected from a file extension rather
/// than from the document itself is either declared through the options or
/// named through [`powerio_core::Source::from_memory`].
///
/// The family comes from the input's declared format when one was selected,
/// and otherwise from the name and content: a `.dss` extension routes to the
/// distribution parser, a `.json` document routes by its top level markers
/// ([`format::routing::classify_json_text`]), a name with no recognized
/// extension whose content opens a JSON document (an in-memory source has no
/// extension) routes the same way, and every other name routes to
/// the balanced network hub, whose own detection and refusals apply.
///
/// PowerIO IR is not a grid exchange format: [`parse`] refuses it and
/// [`deserialize`] reads the current PowerIO IR document.
///
/// # Errors
/// The routed family's failure, carrying its findings and the retained
/// source.
pub fn parse(
    input: impl powerio_core::IntoSource,
) -> std::result::Result<powerio_core::PioModule<PioValue>, powerio_core::Error> {
    parse_with_options(input, &ParseOptions::default())
}

/// Parse one input under `options`, which selects the parser explicitly or
/// widens the directory a format may refer to further files beneath.
/// [`parse`] is this operation with the default options.
///
/// # Errors
/// The input cannot be acquired, the format cannot be selected, or the routed
/// family fails, each carrying its own diagnostic code.
pub fn parse_with_options(
    input: impl powerio_core::IntoSource,
    options: &ParseOptions,
) -> std::result::Result<powerio_core::PioModule<PioValue>, powerio_core::Error> {
    let mut source = input.into_source()?;
    if let Some(root) = &options.acquisition_root {
        source = source.with_acquisition_root(root.clone())?;
    }
    if let Some(format) = &options.format {
        source = source.with_format(format.clone());
    }
    match routed_family(&source)? {
        RoutedFamily::Goc3 => parse_goc3(source),
        RoutedFamily::OpfData => powerio_prob::__internal::__decode_opfdata_solution(source)
            .map(|module| module.map_value(PioValue::from)),
        RoutedFamily::Distribution(detected) => {
            let source = match (source.format(), detected) {
                (None, Some(format)) => {
                    source.with_format(powerio_core::FormatId::new(format.name())?)
                }
                _ => source,
            };
            powerio_dist::parse(source).map(|module| module.map_value(PioValue::from))
        }
        RoutedFamily::PypsaDirectory => parse_pypsa(source),
        #[cfg(feature = "gridfm")]
        RoutedFamily::Gridfm => parse_gridfm(source),
        RoutedFamily::Egret => parse_egret(source),
        RoutedFamily::Geo => parse_geo_layer(source),
        RoutedFamily::Contingency(kind) => parse_contingency_file(source, kind),
        RoutedFamily::Balanced(json_class) => format::parse_with_json_class(source, json_class)
            .map(|module| module.map_value(PioValue::from)),
    }
}

/// Parse the official GO Challenge 3 problem file, or a problem and its
/// matching solution file supplied by one directory or one memory source.
/// File roles come from the required top level JSON fields, not filenames.
/// A solution file alone is incomplete because it contains neither the
/// component definitions nor the time axis.
fn parse_goc3(
    source: powerio_core::Source,
) -> std::result::Result<powerio_core::PioModule<PioValue>, powerio_core::Error> {
    let source = source.with_format(powerio_core::FormatId::new("goc3-json")?);
    let files = match goc3_data_files(&source) {
        Ok(files) => files,
        Err(error) => return Err(error.with_source(source)),
    };
    let Some(problem) = files.problem else {
        let message = if files.solution.is_some() {
            "a GO Challenge 3 solution file requires the matching problem file in the same source"
        } else {
            "the source contains neither a GO Challenge 3 problem file nor a solution file"
        };
        return Err(Error::new(
            &powerio_tx::diagnostics::codes::READ_GOC3_PROBLEM_REQUIRED,
            message,
        )
        .with_source(source));
    };

    let (instance, diagnostics) =
        match powerio_prob::__internal::__parse_goc3_problem_buffer(&problem) {
            Ok(parsed) => parsed,
            Err(error) => return Err(error.with_source(source)),
        };
    let value = match files.solution {
        Some(solution) => {
            let solution = match powerio_prob::__internal::__parse_goc3_output_buffer(
                std::sync::Arc::new(instance),
                &solution,
            ) {
                Ok(solution) => solution,
                Err(error) => return Err(error.with_source(source)),
            };
            PioValue::from(solution)
        }
        None => PioValue::from(instance),
    };
    powerio_core::PioModule::parsed(value, source, diagnostics)
}

/// Read one standalone geographic document into [`PioValue::GeoLayer`]. A
/// PowerWorld `.pwd` display lifts into a diagram space layer with substation
/// targets; every other supported document is already a layer. The reader's
/// notes on records it could not use become the module's diagnostics.
fn parse_geo_layer(
    source: powerio_core::Source,
) -> std::result::Result<powerio_core::PioModule<PioValue>, powerio_core::Error> {
    let name = source.name().to_owned();
    let declared = source.format().map(|format| format.as_str().to_owned());
    let is_display = declared.as_deref().is_some_and(is_pwd_display_token)
        || std::path::Path::new(&name)
            .extension()
            .and_then(|extension| extension.to_str())
            .is_some_and(|extension| extension.eq_ignore_ascii_case("pwd"));

    let buffer = match source.primary_buffer() {
        Ok(buffer) => buffer,
        Err(error) => return Err(error.with_source(source)),
    };
    let (layer, diagnostics) = if is_display {
        match powerio_tx::format::powerworld::__parse_pwd_layer(buffer.content_bytes()) {
            Ok(parsed) => (parsed.layer, parsed.diagnostics),
            Err(error) => {
                return Err(Error::new(error.code(), error.to_string())
                    .with_cause(error)
                    .with_source(source));
            }
        }
    } else {
        let text = match std::str::from_utf8(buffer.content_bytes()) {
            Ok(text) => text,
            Err(cause) => {
                return Err(Error::new(
                    &powerio_tx::diagnostics::codes::READ_GEO_NOT_TEXT,
                    format!("a geographic layer document is not valid UTF-8: {cause}"),
                )
                .with_source(source));
            }
        };
        match powerio_tx::geo::GeoLayer::parse(
            text,
            std::path::Path::new(&name)
                .file_name()
                .and_then(|name| name.to_str()),
        ) {
            Ok(parsed) => (parsed.layer, parsed.diagnostics),
            Err(error) => {
                return Err(Error::new(error.code(), error.to_string())
                    .with_cause(error)
                    .with_source(source));
            }
        }
    };
    let source = match declared {
        Some(_) => source,
        None => source.with_format(powerio_core::FormatId::new(if is_display {
            "powerworld-pwd"
        } else {
            "geo-json"
        })?),
    };
    powerio_core::PioModule::parsed(PioValue::from(layer), source, diagnostics)
}

/// Read one PSS/E contingency analysis file into its own value. The reader
/// keeps a statement outside its grammar as the original line and reports it;
/// those notes become the module's diagnostics, so nothing the file states is
/// lost between the text and the value.
fn parse_contingency_file(
    source: powerio_core::Source,
    kind: ContingencyFile,
) -> std::result::Result<powerio_core::PioModule<PioValue>, powerio_core::Error> {
    let buffer = match source.primary_buffer() {
        Ok(buffer) => buffer,
        Err(error) => return Err(error.with_source(source)),
    };
    let text = match std::str::from_utf8(buffer.content_bytes()) {
        Ok(text) => text,
        Err(cause) => {
            return Err(Error::new(
                kind.not_text_code(),
                format!("{} is not valid UTF-8: {cause}", kind.description()),
            )
            .with_source(source));
        }
    };
    let parsed = match kind {
        ContingencyFile::Con => powerio_tx::ContingencySet::parse(text)
            .map(|parsed| (PioValue::from(parsed.set), parsed.diagnostics)),
        ContingencyFile::Sub => powerio_tx::SubsystemSet::parse(text)
            .map(|parsed| (PioValue::from(parsed.set), parsed.diagnostics)),
        ContingencyFile::Mon => powerio_tx::MonitoredSet::parse(text)
            .map(|parsed| (PioValue::from(parsed.set), parsed.diagnostics)),
    };
    let (value, diagnostics) = match parsed {
        Ok(parsed) => parsed,
        Err(error) => {
            return Err(Error::new(error.code(), error.to_string())
                .with_cause(error)
                .with_source(source));
        }
    };
    let source = match source.format() {
        Some(_) => source,
        None => source.with_format(powerio_core::FormatId::new(kind.token())?),
    };
    powerio_core::PioModule::parsed(value, source, diagnostics)
}

/// PyPSA CSV dispatch: one snapshot with no series siblings is the scalar
/// profile through the balanced hub; a declared axis routes to the sequence
/// parser, producing a network series or, when only operating quantities
/// vary, an operating point series over one shared network.
fn parse_pypsa(
    source: powerio_core::Source,
) -> std::result::Result<powerio_core::PioModule<PioValue>, powerio_core::Error> {
    if !source.is_directory() {
        // A file claiming the PyPSA token gets the hub's own refusal wording.
        return format::parse(source).map(|module| module.map_value(PioValue::from));
    }
    // Directory routing identified the source before the typed reader runs.
    // Record that decision on an undeclared source so same format emission
    // can distinguish a PyPSA directory from the GridFM directory family.
    let source = match source.format() {
        Some(_) => source,
        None => source.with_format(powerio_core::FormatId::new("pypsa-csv")?),
    };
    let axis = match format::__pypsa_axis(&source) {
        Ok(axis) => axis,
        Err(error) => {
            let core = powerio_core::Error::new(error.code(), error.to_string());
            return Err(core.with_source(source));
        }
    };
    match axis {
        format::PypsaAxis::SingleSnapshot => {
            format::parse(source).map(|module| module.map_value(PioValue::from))
        }
        format::PypsaAxis::Series => {
            match powerio_prob::__internal::__decode_pypsa_sequence(&source) {
                Ok((sequence, diagnostics)) => {
                    let value = match sequence {
                        powerio_prob::__internal::PypsaSequence::Networks(series) => {
                            PioValue::from(series)
                        }
                        powerio_prob::__internal::PypsaSequence::OperatingPoints(points) => {
                            PioValue::from(points)
                        }
                    };
                    powerio_core::PioModule::parsed(value, source, diagnostics)
                }
                Err(error) => Err(error.with_source(source)),
            }
        }
    }
}

/// gridfm dispatch: every scenario of the Parquet dataset as one scenario
/// set over shared element identities.
#[cfg(feature = "gridfm")]
fn parse_gridfm(
    source: powerio_core::Source,
) -> std::result::Result<powerio_core::PioModule<PioValue>, powerio_core::Error> {
    if !source.is_directory() {
        // A file claiming the gridfm token gets the hub's own refusal wording.
        return format::parse(source).map(|module| module.map_value(PioValue::from));
    }
    let source = match source.format() {
        Some(_) => source,
        None => source.with_format(powerio_core::FormatId::new("gridfm")?),
    };
    match __gridfm::parse_gridfm_source(&source) {
        Ok((set, diagnostics)) => {
            powerio_core::PioModule::parsed(PioValue::from(set), source, diagnostics)
        }
        Err(error) => Err(error.with_source(source)),
    }
}

/// Egret dispatch: a document declaring `system.time_keys` routes to the
/// sequence parser and produces a balanced network time series; a scalar
/// document routes through the balanced hub.
fn parse_egret(
    source: powerio_core::Source,
) -> std::result::Result<powerio_core::PioModule<PioValue>, powerio_core::Error> {
    let declares_series = {
        let buffer = source.primary_buffer()?;
        std::str::from_utf8(buffer.content_bytes()).is_ok_and(format::__egret_declares_time_series)
    };
    if !declares_series {
        return format::parse(source).map(|module| module.map_value(PioValue::from));
    }
    let parsed = {
        let buffer = source.primary_buffer()?;
        let stem = std::path::Path::new(source.name())
            .file_stem()
            .and_then(|stem| stem.to_str())
            .map(str::to_owned);
        match std::str::from_utf8(buffer.content_bytes()) {
            Ok(text) => format::__parse_egret_time_series(text, stem.as_deref())
                .map_err(|error| powerio_core::Error::new(error.code(), error.to_string())),
            Err(error) => {
                let cause = powerio_tx::Error::FormatRead {
                    format: "case text",
                    message: format!("not valid UTF-8: {error}"),
                };
                Err(powerio_core::Error::new(cause.code(), cause.to_string()))
            }
        }
    };
    match parsed {
        Ok(series) => powerio_core::PioModule::parsed(PioValue::from(series), source, Vec::new()),
        Err(error) => Err(error.with_source(source)),
    }
}

/// The family a source routes to. The balanced hub is the default: it owns
/// the guidance for unknown names and refused shapes. `Balanced` carries the
/// JSON classification when routing here was itself the result of one (so
/// the balanced hub does not classify the same text a second time); `None`
/// when the source routed here by extension, by a declared token, or by a
/// directory shape, none of which run a JSON classification at all.
enum RoutedFamily {
    Balanced(Option<format::routing::JsonClass>),
    Distribution(Option<format::routing::DistributionFormat>),
    Goc3,
    OpfData,
    PypsaDirectory,
    Egret,
    /// A standalone geographic document: the canonical `.geo.json`, GeoJSON,
    /// aliased CSV or JSON records, headerless buscoords CSV, or a PowerWorld
    /// `.pwd` display lifted into a diagram space layer.
    Geo,
    /// One of the three text files a PSS/E contingency analysis reads.
    Contingency(ContingencyFile),
    #[cfg(feature = "gridfm")]
    Gridfm,
}

fn routed_family(
    source: &powerio_core::Source,
) -> std::result::Result<RoutedFamily, powerio_core::Error> {
    if let Some(declared) = source.format() {
        return Ok(family_of_token(declared.as_str()));
    }
    if source.is_directory() {
        // GOC3 pairs are identified by their official JSON roots rather than
        // filenames. The format parser performs the exact cardinality and
        // schema checks after routing.
        if directory_has_goc3_data(source) {
            return Ok(RoutedFamily::Goc3);
        }
        // PyPSA is a CSV folder containing network.csv. GridFM is a Parquet
        // dataset with bus_data.parquet at one of its documented locations.
        // Anything else falls to the balanced hub's refusal.
        let marker = powerio_core::ArtifactPath::new("network.csv")
            .expect("static name is a valid artifact path");
        if source.buffer(&marker).is_ok() {
            return Ok(RoutedFamily::PypsaDirectory);
        }
        #[cfg(feature = "gridfm")]
        if let Ok(entries) = source.entry_names()
            && entries.iter().any(|entry| {
                entry.as_str().ends_with("bus_data.parquet")
                    && matches!(entry.as_str().matches('/').count(), 0..=2)
            })
        {
            return Ok(RoutedFamily::Gridfm);
        }
        return Ok(RoutedFamily::Balanced(None));
    }
    let extension = std::path::Path::new(source.name())
        .extension()
        .and_then(|extension| extension.to_str())
        .unwrap_or_default()
        .to_ascii_lowercase();
    if has_geo_layer_extension(source.name()) {
        return Ok(RoutedFamily::Geo);
    }
    match extension.as_str() {
        "dss" => Ok(RoutedFamily::Distribution(Some(
            format::routing::DistributionFormat::Dss,
        ))),
        "json" => json_family(source),
        // Extensions with dedicated non-JSON readers keep them; anything
        // else (a nameless in-memory source above all) can still carry a
        // JSON document, so content that opens one routes by classification,
        // mirroring the balanced hub's own sniff.
        "pwd" | "geojson" => Ok(RoutedFamily::Geo),
        "con" => Ok(RoutedFamily::Contingency(ContingencyFile::Con)),
        "sub" => Ok(RoutedFamily::Contingency(ContingencyFile::Sub)),
        "mon" => Ok(RoutedFamily::Contingency(ContingencyFile::Mon)),
        "m" | "raw" | "aux" | "epc" | "pwb" | "uct" => Ok(RoutedFamily::Balanced(None)),
        _ => {
            let jsonish = source.primary_buffer().is_ok_and(|buffer| {
                std::str::from_utf8(buffer.content_bytes()).is_ok_and(|text| {
                    // Strip a UTF-8 BOM the way the JSON classifier does, so
                    // a BOM-prefixed nameless document routes the same as
                    // the identical content saved with a .json name.
                    text.trim_start_matches('\u{feff}')
                        .trim_start()
                        .starts_with(['{', '['])
                })
            });
            if jsonish {
                json_family(source)
            } else {
                Ok(RoutedFamily::Balanced(None))
            }
        }
    }
}

/// Whether `name` carries the compound `geo.json` extension: the whole name,
/// or the name after a separator, so `layer.geo.json`, `layer_geo.json`, and
/// `layer-geo.json` all state a layer. A stem that merely ends in the same
/// letters (`apogeo.json`) does not, and keeps its JSON classification, which
/// matters because JSON content classification has no layer verdict and would
/// refuse the file as an unrecognized case.
fn has_geo_layer_extension(name: &str) -> bool {
    let name = name.to_ascii_lowercase();
    let extension = powerio_tx::geo::GEO_LAYER_EXTENSION;
    name == extension
        || name
            .strip_suffix(extension)
            .is_some_and(|stem| stem.ends_with(['.', '_', '-', '/', '\\']))
}

/// Whether `token` names the standalone geographic layer document.
pub(crate) fn is_geo_layer_token(token: &str) -> bool {
    matches!(
        token.to_ascii_lowercase().replace(['-', '_'], "").as_str(),
        "geojson" | "geo" | "geolayer"
    )
}

/// Whether `token` names a PowerWorld display file, which reads as a diagram
/// space layer.
pub(crate) fn is_pwd_display_token(token: &str) -> bool {
    matches!(
        token.to_ascii_lowercase().replace(['-', '_'], "").as_str(),
        "pwd" | "powerworldpwd" | "powerworlddisplay"
    )
}

/// Whether `token` names a document that reads into [`PioValue::GeoLayer`].
fn is_geo_token(token: &str) -> bool {
    is_geo_layer_token(token) || is_pwd_display_token(token)
}

/// Which of the three PSS/E contingency analysis files a source holds. Each
/// is its own format token, its own value type, and its own writer; the three
/// never cross.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub(crate) enum ContingencyFile {
    /// The contingency description file, `.con`.
    Con,
    /// The subsystem description file, `.sub`.
    Sub,
    /// The monitored element file, `.mon`.
    Mon,
}

impl ContingencyFile {
    /// The canonical format token.
    pub(crate) const fn token(self) -> &'static str {
        match self {
            Self::Con => "psse-con",
            Self::Sub => "psse-sub",
            Self::Mon => "psse-mon",
        }
    }

    /// The conventional filename suffix, without a leading dot.
    pub(crate) const fn extension(self) -> &'static str {
        match self {
            Self::Con => "con",
            Self::Sub => "sub",
            Self::Mon => "mon",
        }
    }

    /// The name of the one artifact an emission writes. A path destination
    /// uses the caller's own path; a memory destination uses its root name.
    /// `con` alone is a reserved device name on Windows, so every name here
    /// carries a stem.
    pub(crate) const fn artifact_name(self) -> &'static str {
        match self {
            Self::Con => "contingency.con",
            Self::Sub => "subsystem.sub",
            Self::Mon => "monitored.mon",
        }
    }

    /// The structural type name the file reads into.
    pub(crate) const fn type_name(self) -> &'static str {
        match self {
            Self::Con => "powerio.ContingencySet",
            Self::Sub => "powerio.SubsystemSet",
            Self::Mon => "powerio.MonitoredSet",
        }
    }

    /// The code for input that is not UTF-8 text.
    const fn not_text_code(self) -> &'static powerio_core::DiagnosticInfo {
        use powerio_tx::diagnostics::codes;
        match self {
            Self::Con => &codes::READ_CON_NOT_TEXT,
            Self::Sub => &codes::READ_SUB_NOT_TEXT,
            Self::Mon => &codes::READ_MON_NOT_TEXT,
        }
    }

    /// How the refusal names the file, in prose.
    const fn description(self) -> &'static str {
        match self {
            Self::Con => "a PSS/E contingency description file",
            Self::Sub => "a PSS/E subsystem description file",
            Self::Mon => "a PSS/E monitored element file",
        }
    }
}

/// The PSS/E contingency analysis file a format token names, or `None` for
/// every other token. Case, hyphens, and underscores do not distinguish
/// spellings, so `psse-con`, `psse_con`, `PSSECon`, and `con` are one name.
pub(crate) fn contingency_file_of_token(token: &str) -> Option<ContingencyFile> {
    match token.to_ascii_lowercase().replace(['-', '_'], "").as_str() {
        "con" | "pssecon" | "contingency" => Some(ContingencyFile::Con),
        "sub" | "pssesub" | "subsystem" => Some(ContingencyFile::Sub),
        "mon" | "pssemon" | "monitored" => Some(ContingencyFile::Mon),
        _ => None,
    }
}

/// The family a JSON document's content markers select.
fn json_family(
    source: &powerio_core::Source,
) -> std::result::Result<RoutedFamily, powerio_core::Error> {
    use format::routing::{Detection, JsonClass, SourceFormat, TransmissionFormat};

    let buffer = source.primary_buffer()?;
    // Family routing needs decoded text; a non-UTF-8 `.json` fails in
    // the balanced hub with its own wording. Classification never ran, so
    // the balanced hub gets no hint and classifies it itself.
    let Ok(text) = std::str::from_utf8(buffer.content_bytes()) else {
        return Ok(RoutedFamily::Balanced(None));
    };
    let class = format::routing::classify_json_text(text);
    match class {
        JsonClass::Case(Detection::Known(SourceFormat::Transmission(
            TransmissionFormat::Goc3Json,
        ))) => Ok(RoutedFamily::Goc3),
        JsonClass::Case(Detection::Known(SourceFormat::Transmission(
            TransmissionFormat::DeepMindOpfDataJson,
        ))) => Ok(RoutedFamily::OpfData),
        JsonClass::Case(Detection::Known(SourceFormat::Transmission(
            TransmissionFormat::EgretJson,
        ))) => Ok(RoutedFamily::Egret),
        JsonClass::Case(Detection::Known(SourceFormat::Distribution(format))) => {
            Ok(RoutedFamily::Distribution(Some(format)))
        }
        JsonClass::Module => Err(powerio_core::Error::new(
            &codes::REQUEST_PARSE_POWERIO_IR,
            "PowerIO IR is not a grid exchange format; call deserialize(source)",
        )),
        // The balanced hub owns the refusal wording for unrecognized or
        // ambiguous documents. Pass the classification through so it does not
        // inspect the same bytes twice.
        JsonClass::Case(Detection::Known(_) | Detection::Ambiguous | Detection::Unknown) => {
            Ok(RoutedFamily::Balanced(Some(class)))
        }
    }
}

/// The family a declared format token selects. Unknown tokens fall to the
/// balanced hub, which owns the refusal wording and the accepted name list.
fn family_of_token(token: &str) -> RoutedFamily {
    use format::TargetFormat;

    if is_geo_token(token) {
        return RoutedFamily::Geo;
    }
    if let Some(kind) = contingency_file_of_token(token) {
        return RoutedFamily::Contingency(kind);
    }

    if powerio_dist::parse_dist_target_format(token).is_some() {
        return RoutedFamily::Distribution(None);
    }
    if format::is_pypsa_csv_name(token) {
        return RoutedFamily::PypsaDirectory;
    }
    #[cfg(feature = "gridfm")]
    if token.eq_ignore_ascii_case("gridfm") {
        return RoutedFamily::Gridfm;
    }
    match format::parse_target_format(token) {
        Some(TargetFormat::Goc3Json) => RoutedFamily::Goc3,
        Some(TargetFormat::DeepMindOpfDataJson) => RoutedFamily::OpfData,
        Some(TargetFormat::EgretJson) => RoutedFamily::Egret,
        _ => RoutedFamily::Balanced(None),
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn memory(name: &str, text: &str) -> powerio_core::Source {
        powerio_core::Source::from_memory(name, text.as_bytes().to_vec()).expect("memory source")
    }

    fn parse(
        source: powerio_core::Source,
    ) -> std::result::Result<powerio_core::PioModule<PioValue>, powerio_core::Error> {
        super::parse(source)
    }

    fn options(format: Option<&str>) -> ParseOptions {
        match format {
            Some(format) => ParseOptions::default().format(format).unwrap(),
            None => ParseOptions::default(),
        }
    }

    fn assert_value_type(module: &powerio_core::PioModule<PioValue>, expected: &str) {
        assert_eq!(module.value().type_name(), expected);
    }

    #[test]
    fn a_matpower_source_parses_to_a_balanced_network() {
        let case = "function mpc = case\n\
                    mpc.version = '2';\n\
                    mpc.baseMVA = 100;\n\
                    mpc.bus = [1 3 0 0 0 0 1 1 0 230 1 1.1 0.9;];\n\
                    mpc.gen = [1 0 0 10 -10 1 100 1 10 0;];\n\
                    mpc.branch = [];\n";
        let module = parse(
            memory("case.m", case).with_format(powerio_core::FormatId::new("matpower").unwrap()),
        )
        .expect("matpower parses");
        assert_value_type(&module, "powerio.BalancedNetwork");
    }

    #[test]
    fn memory_parse_retains_its_name_and_optional_format() {
        let case = "function mpc = inline\n\
                    mpc.version = '2';\n\
                    mpc.baseMVA = 100;\n\
                    mpc.bus = [1 3 0 0 0 0 1 1 0 230 1 1.1 0.9;];\n\
                    mpc.gen = [1 0 0 10 -10 1 100 1 10 0;];\n\
                    mpc.branch = [];\n";

        let detected = super::parse(memory("inline-case.m", case)).expect("name detects MATPOWER");
        assert_eq!(detected.source().unwrap().name(), "inline-case.m");
        assert_eq!(
            detected.source().unwrap().format().map(FormatId::as_str),
            Some("matpower")
        );

        let declared = super::parse_with_options(
            memory("consumer-input", case),
            &ParseOptions::default().format("matpower").unwrap(),
        )
        .expect("declared MATPOWER");
        let source = declared.source().expect("source retained");
        assert_eq!(source.name(), "consumer-input");
        assert_eq!(source.format().map(FormatId::as_str), Some("matpower"));
    }

    #[test]
    fn universal_parse_reads_declared_iso_8859_1_xiidm_and_retains_exact_bytes() {
        let text = r#"<?xml version="1.0" encoding="ISO-8859-1"?>
<iidm:network xmlns:iidm="http://www.powsybl.org/schema/iidm/1_17" id="case" caseDate="2026-01-01T00:00:00Z" forecastDistance="0" sourceFormat="Réseau PowSybl" minimumValidationLevel="STEADY_STATE_HYPOTHESIS">
  <iidm:voltageLevel id="VL" nominalV="225" topologyKind="BUS_BREAKER">
    <iidm:busBreakerTopology><iidm:bus id="B" v="225" angle="0"/></iidm:busBreakerTopology>
    <iidm:generator id="G" energySource="OTHER" minP="0" maxP="100" voltageRegulatorOn="true" targetP="50" targetV="225" bus="B" connectableBus="B"><iidm:minMaxReactiveLimits minQ="-20" maxQ="20"/></iidm:generator>
  </iidm:voltageLevel>
</iidm:network>"#;
        let bytes: Vec<u8> = text
            .chars()
            .map(|value| u8::try_from(u32::from(value)).expect("fixture is ISO-8859-1"))
            .collect();
        assert!(std::str::from_utf8(&bytes).is_err());

        for (name, format) in [
            ("case.xiidm", None),
            ("case.xml", None),
            ("memory", Some("xiidm")),
        ] {
            let source = Source::from_memory(name, bytes.clone()).unwrap();
            let module = super::parse_with_options(source, &options(format)).unwrap();
            let PioValue::BalancedNetwork(network) = &module.value() else {
                panic!(
                    "expected BalancedNetwork, got {}",
                    module.value().type_name()
                );
            };
            assert_eq!(
                network.case_metadata().source_model_format.as_deref(),
                Some("Réseau PowSybl")
            );
            let retained = module.source().unwrap();
            assert_eq!(retained.format().map(FormatId::as_str), Some("xiidm"));
            assert_eq!(retained.primary_buffer().unwrap().bytes(), bytes);

            let emitted =
                emit(&module, "xiidm", Destination::memory("copy.xiidm").unwrap()).unwrap();
            assert_eq!(emitted.fidelity(), Fidelity::ExactSameFormat);
            let EmittedOutput::Memory { artifacts } = emitted.into_output() else {
                panic!("memory destination returned a path output");
            };
            assert_eq!(artifacts.len(), 1);
            assert_eq!(artifacts[0].bytes(), bytes);
        }
    }

    #[test]
    fn a_dss_source_parses_to_a_multiconductor_network() {
        let module = parse(memory(
            "feeder.dss",
            "New Circuit.c basekv=12.47 bus1=src\n",
        ))
        .expect("dss parses");
        let PioValue::MulticonductorNetwork(network) = &module.value() else {
            panic!(
                "expected multiconductor network, got {}",
                module.value().type_name()
            );
        };
        assert_eq!(network.name().as_deref(), Some("c"));
    }

    #[test]
    fn a_declared_distribution_format_routes_without_an_extension() {
        let module = parse(
            memory("<memory>", "New Circuit.c basekv=12.47 bus1=src\n")
                .with_format(powerio_core::FormatId::new("dss").unwrap()),
        )
        .expect("declared dss parses");
        assert_value_type(&module, "powerio.MulticonductorNetwork");
    }

    #[test]
    fn json_routes_by_top_level_markers() {
        // A PMD document carries `data_model`, which no balanced format does.
        let module = parse(memory(
            "feeder.json",
            r#"{"data_model": "ENGINEERING", "bus": {}}"#,
        ))
        .expect("pmd parses");
        assert_value_type(&module, "powerio.MulticonductorNetwork");
    }

    #[test]
    fn a_bare_network_object_is_not_powerio_ir_or_a_case_format() {
        let error = parse(memory(
            "net.json",
            r#"{"name":"network","base_mva":100.0,"buses":[],"branches":[]}"#,
        ))
        .expect_err("an unmarked network object must not parse");
        assert!(error.to_string().contains("cannot infer JSON format"));
    }

    #[test]
    fn the_error_path_retains_the_source() {
        let error = parse(memory("case.m", "not matpower at all")).expect_err("malformed");
        assert!(error.retained_source().is_some());
    }

    fn fixture(path: &str) -> String {
        let root = std::path::Path::new(env!("CARGO_MANIFEST_DIR"));
        std::fs::read_to_string(root.join(path)).unwrap()
    }

    #[test]
    fn goc3_parses_to_an_scuc_instance() {
        // A calculation defining source produces its calculation's value,
        // never the bare network its data could also build.
        let text = fixture("../powerio-prob/tests/data/goc3_small.json");
        let module = parse(memory("goc3_small.json", &text)).expect("goc3 parses");
        assert_value_type(&module, "powerio.AcScucInstance");
        assert!(module.source().is_some());
        let PioValue::AcScucInstance(instance) = &module.value() else {
            unreachable!();
        };
        assert_eq!(instance.network().buses().len(), 2);
    }

    #[test]
    fn goc3_problem_and_solution_parse_with_the_one_public_operation() {
        let problem = fixture("../tests/data/goc3/goc3_small.json");
        let solution = fixture("../tests/data/goc3/goc3_small_solution.json");
        let source = powerio_core::Source::from_memory("problem.json", problem.into_bytes())
            .unwrap()
            .with_named_buffer("solution.json", solution.into_bytes())
            .unwrap();
        let module = parse(source).expect("problem and solution parse together");
        let PioValue::AcScucSolution(solution) = &module.value() else {
            panic!(
                "expected AC SCUC solution, got {}",
                module.value().type_name()
            );
        };
        assert_eq!(solution.instance().network().buses().len(), 2);
        assert_eq!(
            solution.network_outputs().shunt_step,
            vec![vec![1], vec![2]]
        );
        assert_eq!(module.sources().len(), 2);

        let emitted = emit(
            &module,
            "goc3-json",
            Destination::memory("solution.json").unwrap(),
        )
        .expect("solution emits as official GOC3 output");
        let EmittedOutput::Memory { artifacts } = emitted.output() else {
            unreachable!();
        };
        assert_eq!(artifacts.len(), 1);
        let document: serde_json::Value = serde_json::from_slice(artifacts[0].bytes()).unwrap();
        assert!(document.get("time_series_output").is_some());
        assert!(document.get("network").is_none());
    }

    #[test]
    fn goc3_solution_alone_names_the_missing_problem() {
        let solution = fixture("../tests/data/goc3/goc3_small_solution.json");
        let error = parse(memory("solution.json", &solution))
            .expect_err("a solution without its problem is incomplete");
        assert!(error.to_string().contains("matching problem file"));
        assert!(error.retained_source().is_some());
    }

    #[test]
    fn opfdata_parses_to_an_ac_opf_solution() {
        let text = fixture("../tests/data/opfdataset/example_0.json");
        let module = parse(memory("example_0.json", &text)).expect("opfdata parses");
        let PioValue::AcOpfSolution(solution) = &module.value() else {
            panic!(
                "expected AC OPF solution, got {}",
                module.value().type_name()
            );
        };
        assert_eq!(
            module
                .sources()
                .first()
                .and_then(|source| source.format())
                .map(powerio_core::FormatId::as_str),
            Some("opfdata-json")
        );
        assert_eq!(
            *solution.termination(),
            powerio_prob::Termination::NotReported
        );
        assert!((solution.objective() - 2_265.953_939_003_096).abs() < 1e-9);

        let instance = solution.instance();
        assert_eq!(instance.network().buses().len(), 14);
        assert_eq!(instance.network().generators().len(), 5);
        let initial = instance.initial_point().expect("OPFData includes initials");
        let generator_id = instance.network().generators()[0]
            .uid
            .as_deref()
            .expect("parsed generators have stable identities");
        assert!((initial.generator_active_power(generator_id).unwrap() - 170.0).abs() < 1e-9);
        assert!((initial.generator_voltage_setpoint(generator_id).unwrap() - 1.0).abs() < 1e-12);
        assert!(solution.residuals().max_active_power_mismatch.unwrap() < 1.0);
        assert!(solution.residuals().max_reactive_power_mismatch.unwrap() < 1.0);
    }

    #[test]
    fn malformed_opfdata_uses_the_universal_parse_error_path() {
        let error = parse(
            memory("broken.json", "{\"grid\": {}}")
                .with_format(powerio_core::FormatId::new("opfdata-json").unwrap()),
        )
        .expect_err("malformed OPFData");
        assert!(error.retained_source().is_some());
    }

    const BMOPF_TINY: &str = r#"{
      "bus": {"a": {"terminal_names": ["1", "2", "3", "n"],
        "perfectly_grounded_terminals": ["n"]}},
      "voltage_source": {"s": {"bus": "a", "terminal_map": ["1", "2", "3"],
        "v_magnitude": [240.0, 240.0, 240.0], "v_angle": [0.0, -2.0944, 2.0944]}}
    }"#;

    #[test]
    fn bmopf_parses_to_a_multiconductor_network() {
        // BMOPF shares the multiconductor network model. Callers construct a
        // power flow or optimal power flow instance explicitly afterward.
        let module = parse(memory("feeder.json", BMOPF_TINY)).expect("sniffed bmopf parses");
        assert_value_type(&module, "powerio.MulticonductorNetwork");

        let module = parse(
            memory("<memory>", BMOPF_TINY)
                .with_format(powerio_core::FormatId::new("bmopf-json").unwrap()),
        )
        .expect("declared bmopf parses");
        assert_value_type(&module, "powerio.MulticonductorNetwork");
    }

    #[test]
    fn nameless_json_text_routes_by_content() {
        // An in-memory source has no extension, so the family comes
        // from the document's own markers. Calculation and distribution
        // formats dispatch the same way they would from a `.json` file.
        let goc3 = fixture("../powerio-prob/tests/data/goc3_small.json");
        let module = parse(memory("<memory>", &goc3)).expect("nameless goc3 parses");
        assert_value_type(&module, "powerio.AcScucInstance");

        let module = parse(memory("<memory>", BMOPF_TINY)).expect("nameless bmopf parses");
        assert_value_type(&module, "powerio.MulticonductorNetwork");
    }

    #[test]
    fn a_declared_problem_format_that_fails_retains_the_source() {
        let error = parse(
            memory("broken.json", "{\"network\": {}}")
                .with_format(powerio_core::FormatId::new("goc3-json").unwrap()),
        )
        .expect_err("malformed goc3");
        assert!(error.retained_source().is_some());
    }

    const PYPSA_STATIC: [(&str, &str); 4] = [
        ("network.csv", "name\nseq\n"),
        ("buses.csv", "name,v_nom\nB1,138.0\nB2,138.0\n"),
        ("loads.csv", "name,bus,p_set,q_set\nL1,B2,5.0,1.0\n"),
        (
            "generators.csv",
            "name,bus,control,p_nom,p_set\nG1,B1,Slack,100.0,12.0\n",
        ),
    ];

    fn pypsa_folder(extra: &[(&str, &str)]) -> tempfile::TempDir {
        let temp = tempfile::tempdir().unwrap();
        for (name, content) in PYPSA_STATIC.iter().chain(extra) {
            std::fs::write(temp.path().join(name), content).unwrap();
        }
        temp
    }

    #[test]
    fn a_pypsa_snapshot_parses_to_a_balanced_network() {
        let dir = pypsa_folder(&[("snapshots.csv", ",snapshot\n0,now\n")]);
        let module =
            parse(powerio_core::Source::open(dir.path()).unwrap()).expect("snapshot parses");
        assert_value_type(&module, "powerio.BalancedNetwork");
    }

    #[test]
    fn a_pypsa_input_series_parses_to_a_network_time_series() {
        let dir = pypsa_folder(&[
            ("snapshots.csv", ",snapshot\n0,now\n1,later\n"),
            ("loads-p_set.csv", "snapshot,L1\nnow,10.0\nlater,20.0\n"),
        ]);
        let module = parse(powerio_core::Source::open(dir.path()).unwrap()).expect("series parses");
        assert_value_type(&module, "powerio.TimeSeries<powerio.BalancedNetwork>");
        assert!(module.source().is_some());
        let PioValue::TimeSeries(series) = &module.value() else {
            unreachable!();
        };
        assert_eq!(series.len(), 2);
        let PioValue::BalancedNetwork(later) = series.get(1).unwrap() else {
            unreachable!();
        };
        assert!((later.loads()[0].p - 20.0).abs() < 1e-12);
    }

    #[test]
    fn a_pypsa_voltage_series_parses_to_operating_points() {
        let dir = pypsa_folder(&[
            ("snapshots.csv", ",snapshot\n0,now\n1,later\n"),
            (
                "buses-v_mag_pu.csv",
                "snapshot,B1,B2\nnow,1.0,0.99\nlater,1.0,0.97\n",
            ),
            (
                "buses-v_ang.csv",
                "snapshot,B1,B2\nnow,0.0,-0.017453292519943295\nlater,0.0,-0.03490658503988659\n",
            ),
        ]);
        let module = parse(powerio_core::Source::open(dir.path()).unwrap()).expect("series parses");
        assert_value_type(
            &module,
            "powerio.TimeSeries<powerio.OperatingPoint<powerio.BalancedNetwork>>",
        );
        let PioValue::TimeSeries(series) = &module.value() else {
            unreachable!();
        };
        let PioValue::BalancedOperatingPoint(later) = series.get(1).unwrap() else {
            unreachable!();
        };
        assert!((later.bus_voltage_magnitude(powerio_tx::BusId(2)).unwrap() - 0.97).abs() < 1e-12);
    }

    #[test]
    fn a_pypsa_axis_with_no_series_stays_a_network_time_series() {
        // Several declared snapshots and nothing varying preserve the axis
        // as networks sharing every table; nothing here is an operating
        // point series.
        let dir = pypsa_folder(&[("snapshots.csv", ",snapshot\n0,now\n1,later\n")]);
        let module = parse(powerio_core::Source::open(dir.path()).unwrap()).expect("axis parses");
        assert_value_type(&module, "powerio.TimeSeries<powerio.BalancedNetwork>");
    }

    const EGRET_SERIES: &str = r#"{
        "model_name": "uc2",
        "elements": {
            "bus": {"1": {"matpower_bustype": "ref", "base_kv": 138.0},
                    "2": {"matpower_bustype": "PQ", "base_kv": 138.0}},
            "load": {"load_1": {"bus": "2",
                "p_load": {"data_type": "time_series", "values": [10.0, 20.0]},
                "q_load": 3.0}},
            "generator": {"1": {"bus": "1", "pg": 12.0, "qg": 0.0,
                "p_min": 0.0, "p_max": 50.0, "q_min": -10.0, "q_max": 10.0}},
            "branch": {"1": {"from_bus": "1", "to_bus": "2",
                "resistance": 0.01, "reactance": 0.1, "charging_susceptance": 0.0,
                "rating_long_term": 100.0, "rating_short_term": 100.0,
                "rating_emergency": 100.0, "transformer_phase_shift": 0.0}}
        },
        "system": {"baseMVA": 100.0, "time_keys": ["t1", "t2"]}
    }"#;

    #[test]
    fn egret_time_keys_parse_to_a_network_time_series() {
        let module = parse(
            memory("uc2.json", EGRET_SERIES)
                .with_format(powerio_core::FormatId::new("egret-json").unwrap()),
        )
        .expect("egret series parses");
        assert_value_type(&module, "powerio.TimeSeries<powerio.BalancedNetwork>");
        assert!(module.source().is_some());

        // The sniffed route agrees with the declared one.
        let module = parse(memory("uc2.json", EGRET_SERIES)).expect("sniffed egret parses");
        assert_value_type(&module, "powerio.TimeSeries<powerio.BalancedNetwork>");
    }

    #[cfg(feature = "gridfm")]
    #[test]
    fn powerio_ir_uses_deserialize_not_parse() {
        use powerio_tx::{Bus, BusId, BusType};
        let network = powerio_tx::BalancedNetwork::in_memory(
            "stored",
            100.0,
            vec![Bus::new(BusId(1), BusType::Ref, 230.0)],
            vec![],
        );
        let original = powerio_core::PioModule::new(PioValue::BalancedNetwork(network));
        let emitted = serialize(&original, Destination::memory("case.pio.json").unwrap())
            .expect("module serializes");
        let EmittedOutput::Memory { artifacts } = emitted.into_output() else {
            unreachable!();
        };
        let module = deserialize(
            Source::from_memory("case.pio.json", artifacts[0].bytes().to_vec()).unwrap(),
        )
        .expect("module deserializes");
        assert_value_type(&module, "powerio.BalancedNetwork");
        assert!(module.source().is_some());
    }

    #[cfg(feature = "gridfm")]
    #[test]
    fn a_gridfm_dataset_parses_to_a_scenario_set() {
        // Write a two scenario dataset with the matrix writer, then parse the
        // directory through the universal parse.
        let case = concat!(env!("CARGO_MANIFEST_DIR"), "/../tests/data/case9.m");
        let base = powerio_tx::parse(powerio_core::Source::open(case).unwrap())
            .expect("case9 parses")
            .into_value();
        let mut varied = base.clone();
        varied.loads_mut()[0].p += 5.0;
        let out = tempfile::tempdir().unwrap();
        let snapshots = [
            powerio_matrix::GridfmSnapshot::new(&base, 0),
            powerio_matrix::GridfmSnapshot::new(&varied, 1),
        ];
        powerio_matrix::emit_gridfm_batch(
            &snapshots,
            out.path(),
            &powerio_matrix::GridfmOptions::default(),
        )
        .expect("dataset writes");

        let module =
            parse(powerio_core::Source::open(out.path()).unwrap()).expect("dataset parses");
        assert_value_type(&module, "powerio.ScenarioSet<powerio.BalancedNetwork>");
        assert!(module.source().is_some());
        let PioValue::ScenarioSet(set) = &module.value() else {
            unreachable!();
        };
        assert_eq!(set.len(), 2);
        assert!(set.get("0").is_some());
        assert!(set.get("1").is_some());
    }

    #[test]
    fn an_unrecognized_directory_is_refused_with_the_hub_wording() {
        let dir = tempfile::tempdir().unwrap();
        std::fs::write(dir.path().join("notes.txt"), "not a case").unwrap();
        let error =
            parse(powerio_core::Source::open(dir.path()).unwrap()).expect_err("refused directory");
        assert!(error.to_string().contains("directory"), "{error}");
    }

    #[test]
    fn a_scalar_egret_document_stays_a_balanced_network() {
        let scalar = EGRET_SERIES
            .replace(r#", "time_keys": ["t1", "t2"]"#, "")
            .replace(
                r#"{"data_type": "time_series", "values": [10.0, 20.0]}"#,
                "10.0",
            );
        let module = parse(
            memory("uc2.json", &scalar)
                .with_format(powerio_core::FormatId::new("egret-json").unwrap()),
        )
        .expect("scalar egret parses");
        assert_value_type(&module, "powerio.BalancedNetwork");
    }
}