Skip to content

Tidy the investment graph module #1576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tsmbland merged 6 commits into from
Nov 9, 2026
Merged

Tidy the investment graph module #1576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
90be113
Tidy the investment graph module (Claude Opus)
tsmbland Nov 3, 2026
22bcd9d
Small improvements
tsmbland Nov 3, 2026
c0efc7a
Address comments from #1569
tsmbland Nov 6, 2026
5e8ab34
Address some reviewer comments
tsmbland Nov 9, 2026
f89b122
Return errors rather than warnings
tsmbland Nov 9, 2026
cb2826f
Use solve_optimal
tsmbland Nov 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/model/commodity_graphs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ The investment order is worked out from the commodity graph for each year as fol

Markets within a circularity cannot be put into an order that respects every dependency, as each
market in the loop depends on the others. MUSE2 chooses an order for them by solving a small
optimisation problem; see the [API documentation for `order_sccs`][order-sccs] for details. For how
optimisation problem; see the [API documentation for `order_scc`][order-scc] for details. For how
investment then proceeds within a circularity, see [Circularities][investment-circularities].

### Example investment order
Expand Down Expand Up @@ -218,7 +218,7 @@ When reading these graphs, note that:
[prices]: ./prices.md
[topological sort]: https://en.wikipedia.org/wiki/Topological_sorting
[partial-dispatch]: ./investment.md#partial-system-dispatch
[order-sccs]: ../api/muse2/graph/investment/fn.order_sccs.html
[order-scc]: ../api/muse2/graph/investment/fn.order_scc.html
[investment-circularities]: ./investment.md#circularities
[pricing-circularities]: ./prices.md#circularities
[log level]: ../user_guide.md#setting-the-log-level
Expand Down
12 changes: 8 additions & 4 deletions src/graph.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ pub type CommoditiesGraph = Graph<GraphNode, GraphEdge, Directed>;
pub enum GraphNode {
/// A node representing a commodity in a specific region
#[display("{_0} | {_1}")]
Commodity(CommodityID, RegionID),
CommodityMarket(CommodityID, RegionID),
/// A source node for processes that have no inputs
#[display("SOURCE")]
Source,
Expand Down Expand Up @@ -115,15 +115,19 @@ fn create_commodities_graph_for_year(
let mut outputs: Vec<_> = flows
.values()
.filter(|flow| flow.direction() == FlowDirection::Output)
.map(|flow| GraphNode::Commodity(flow.commodity.id.clone(), region_id.clone()))
.map(|flow| {
GraphNode::CommodityMarket(flow.commodity.id.clone(), region_id.clone())
})
.collect();

// Get input nodes for the process
// For now, we assume processes always input commodities in their own region
let mut inputs: Vec<_> = flows
.values()
.filter(|flow| flow.direction() == FlowDirection::Input)
.map(|flow| GraphNode::Commodity(flow.commodity.id.clone(), region_id.clone()))
.map(|flow| {
GraphNode::CommodityMarket(flow.commodity.id.clone(), region_id.clone())
})
.collect();

// Use `Source` node if no inputs, `Sink` node if no outputs
Expand All @@ -148,7 +152,7 @@ fn create_commodities_graph_for_year(
.entry(output.clone())
.or_insert_with(|| graph.add_node(output.clone()));
let is_primary = match &output {
GraphNode::Commodity(commodity_id, _) => {
GraphNode::CommodityMarket(commodity_id, _) => {
primary_output.as_ref() == Some(commodity_id)
}
_ => false,
Expand Down
Loading