cobre-core 0.15.0

Power system data model — buses, branches, generators, loads, and network topology
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

//! # cobre-core
//!
//! Shared data model for the [Cobre](https://github.com/cobre-rs/cobre) power systems ecosystem.
//!
//! This crate defines the fundamental types used across all Cobre tools:
//! buses, branches, generators (hydro, thermal, renewable), loads, network
//! topology, and the top-level [`system`] struct. A power system defined with
//! `cobre-core` types can be used for power flow analysis, optimization, dynamic
//! simulation, and any other analysis procedure in the ecosystem.
//!
//! ## Design principles
//!
//! - **Solver-agnostic**: no solver or algorithm dependencies.
//! - **Validate at construction**: invalid states are caught when building
//!   the system, not at solve time.
//! - **Shared types**: a `Hydro` is the same struct whether used in
//!   stochastic optimization or steady-state analysis.
//! - **Declaration-order invariance**: all entity collections are stored in
//!   canonical ID-sorted order so results are identical regardless of input ordering.
//!
//! ## Status
//!
//! This crate is in early development. The API **will** change.
//!
//! See the [repository](https://github.com/cobre-rs/cobre) for the current status.

// Internal (unpublished) workspace crate: public items intra-doc-link their
// pub(crate) collaborators as a maintainer aid (docs read with
// --document-private-items); the public-only doc gate flags these intentional links.
#![allow(rustdoc::private_intra_doc_links)]
#![cfg_attr(
    test,
    allow(
        clippy::unwrap_used,
        clippy::expect_used,
        clippy::float_cmp,
        clippy::panic,
        clippy::too_many_lines
    )
)]

pub mod commissioning;
pub mod constraints;
pub mod entities;
pub mod entity_id;
pub mod error;
pub mod model;
pub mod stats;
pub mod system;
pub mod topology;

// Crate-root module aliases so `cobre_core::<module>::Symbol` paths resolve for
// external consumers.
pub use model::{parameters, penalty, resolved, scenario, temporal};

pub use constraints::{generic_constraint, initial_conditions, training_event};

pub use constraints::generic_constraint::{
    AffineBound, ConstraintExpression, GenericConstraint, LinearTerm, SlackConfig, VariableRef,
};
pub use constraints::initial_conditions::{
    AnticipatedCommitmentHistory, HydroPastDefluence, HydroStorage, InitialConditions,
    RecentObservation,
};
pub use constraints::training_event::{
    StageRowSelectionRecord, StoppingRuleResult, TrainingEvent, WORKER_TIMING_SLOT_BWD_SETUP,
    WORKER_TIMING_SLOT_BWD_WALL, WORKER_TIMING_SLOT_COUNT, WORKER_TIMING_SLOT_FWD_SETUP,
    WORKER_TIMING_SLOT_FWD_WALL, WORKER_TIMING_SLOT_SCORING, WorkerPhaseTimings, WorkerTimingPhase,
};
pub use entities::{
    AnticipatedConfig, Bus, ContractType, DeficitSegment, DiversionChannel, EfficiencyModel,
    EnergyContract, FillingConfig, HydraulicLossesModel, Hydro, HydroGenerationModel,
    HydroPenalties, HydroUnitGroup, Line, NonControllableSource, PumpingStation, TailraceModel,
    TailracePoint, Thermal,
};
pub use entity_id::EntityId;
pub use error::ValidationError;
pub use model::horizon::HorizonGraph;
pub use model::parameters::{CoefficientRef, ComputedParameter, ParameterKind, ScalarParameter};
pub use model::penalty::{
    GlobalPenaltyDefaults, HydroPenaltyOverrides, resolve_bus_deficit_segments,
    resolve_bus_excess_cost, resolve_hydro_penalties, resolve_line_exchange_cost,
    resolve_ncs_curtailment_cost,
};
pub use model::post_study::{PostStudyStage, PostStudyStages, PostStudyThermalBound};
pub use model::resolved::{
    BlockBoundsCountsSpec, BoundsCountsSpec, BoundsDefaults, BusStagePenalties,
    ContractBlockBounds, ContractBlockOverride, HydroBlockBounds, HydroBlockOverride,
    HydroStageBounds, HydroStagePenalties, HydroUnitGroupBoundsCountsSpec, HydroUnitGroupOverride,
    LineBlockBounds, LineBlockOverride, LineStagePenalties, NcsStagePenalties, PenaltiesCountsSpec,
    PenaltiesDefaults, PumpingBlockBounds, PumpingBlockOverride, ResolvedBlockBounds,
    ResolvedBounds, ResolvedGenericConstraintBounds, ResolvedHydroUnitGroupBounds,
    ResolvedLoadFactors, ResolvedNcsBounds, ResolvedNcsFactors, ResolvedPenalties,
    ThermalBlockBounds, ThermalBlockOverride, ThermalStageBounds,
};
pub use model::scenario::{
    CorrelationEntity, CorrelationGroup, CorrelationModel, CorrelationProfile,
    CorrelationScheduleEntry, ExternalLoadRow, ExternalNcsRow, ExternalScenarioRow,
    HistoricalYears, InflowHistoryRow, InflowModel, LoadModel, NcsModel, SamplingScheme,
    ScenarioSource,
};
pub use model::temporal::{
    Block, BlockMode, CalendarMonth, Node, NoiseMethod, PolicyGraphType, ScenarioSourceConfig,
    SeasonCycleType, SeasonDefinition, SeasonMap, Stage, StageId, StageRiskConfig,
    StageStateConfig, StudyPos, Transition, month_of, window_period_overlaps,
};
pub use stats::welford::WelfordAccumulator;
pub use system::{System, SystemBuilder};
pub use topology::{BusGenerators, BusLineConnection, BusLoads, CascadeTopology, NetworkTopology};