muse2 2.1.0

A tool for running simulations of energy systems
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

//! Agents drive the economy of the MUSE2 simulation, through relative investment in different
//! assets.
use crate::commodity::CommodityID;
use crate::id::define_id_type;
use crate::process::{FlowDirection, Process};
use crate::region::RegionID;
use crate::units::Dimensionless;
use indexmap::{IndexMap, IndexSet};
use serde_string_enum::DeserializeLabeledStringEnum;
use std::collections::HashMap;
use std::rc::Rc;

define_id_type! {AgentID}

/// A map of [`Agent`]s, keyed by agent ID
pub type AgentMap = IndexMap<AgentID, Agent>;

/// A map of commodity portions for an agent, keyed by commodity and year
pub type AgentCommodityPortionsMap = HashMap<(CommodityID, u32), Dimensionless>;

/// A map for the agent's search space, keyed by commodity and year
pub type AgentSearchSpaceMap = HashMap<(CommodityID, u32), Rc<Vec<Rc<Process>>>>;

/// A map of objectives for an agent, keyed by year.
///
/// NB: As we currently only support the "single" decision rule, the only parameter we need for
/// objectives is the type.
pub type AgentObjectiveMap = HashMap<u32, ObjectiveType>;

/// An agent in the simulation
#[derive(Debug, Clone, PartialEq)]
pub struct Agent {
    /// A unique identifier for the agent.
    pub id: AgentID,
    /// A text description of the agent.
    pub description: String,
    /// The proportion of the commodity production that the agent is responsible for.
    pub commodity_portions: AgentCommodityPortionsMap,
    /// The processes that the agent will consider investing in.
    pub search_space: AgentSearchSpaceMap,
    /// The decision rule that the agent uses to decide investment.
    pub decision_rule: DecisionRule,
    /// The regions in which this agent operates.
    pub regions: IndexSet<RegionID>,
    /// The agent's objectives.
    pub objectives: AgentObjectiveMap,
}

impl Agent {
    /// Get all the processes in this agent's search space which produce the commodity in the given
    /// year
    pub fn iter_possible_producers_of<'a>(
        &'a self,
        region_id: &RegionID,
        commodity_id: &'a CommodityID,
        year: u32,
    ) -> impl Iterator<Item = &'a Rc<Process>> + use<'a> {
        let flows_key = (region_id.clone(), year);
        self.search_space[&(commodity_id.clone(), year)]
            .iter()
            .filter(move |process| {
                process.flows[&flows_key][commodity_id].direction() == FlowDirection::Output
            })
    }
}

/// The decision rule for a particular objective
#[derive(Debug, Clone, PartialEq)]
pub enum DecisionRule {
    /// Used when there is only a single objective
    Single,
    /// A simple weighting of objectives
    Weighted,
    /// Objectives are considered in a specific order
    Lexicographical {
        /// The tolerance around the main objective to consider secondary objectives. This is an absolute value of maximum deviation in the units of the main objective.
        tolerance: f64,
    },
}

/// The type of objective for the agent
#[derive(Debug, Clone, Copy, PartialEq, DeserializeLabeledStringEnum)]
pub enum ObjectiveType {
    /// Average cost of one unit of output commodity over its lifetime
    #[string = "lcox"]
    LevelisedCostOfX,
    /// Net present value
    #[string = "npv"]
    NetPresentValue,
}