PowerAnalytics Entity-Metric Redesign

Project.toml

@@ -1,7 +1,7 @@
 name = "PowerAnalytics"
 uuid = "56ce1300-00bc-47e4-ba8c-b166ccc19f51"
-authors = ["cbarrows <[email protected]>"]
-version = "0.6.1"
+authors = ["Gabriel Konar-Steenberg <[email protected]>", "cbarrows <[email protected]>"]
+version = "0.7.0"
 
 [deps]
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
@@ -11,13 +11,14 @@ InfrastructureSystems = "2cd47ed4-ca9b-11e9-27f2-ab636a7671f1"
 InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
 PowerSimulations = "e690365d-45e2-57bb-ac84-44ba829e73c4"
 PowerSystems = "bcd98974-b02a-5e2f-9ee0-a103f5c450dd"
+Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 TimeSeries = "9e3dc215-6440-5c97-bce1-76c03772f85e"
 YAML = "ddb6d928-2868-570f-bddf-ab3f9cf99eb6"
 
 [compat]
-Dates = "1"
 DataFrames = "1"
 DataStructures = "0.18"
+Dates = "1"
 InfrastructureSystems = "1"
 InteractiveUtils = "1"
 PowerSimulations = "^0.27.1"

src/PowerAnalytics.jl

@@ -7,13 +7,46 @@ export get_service_data
 export categorize_data
 export no_datetime
 
+export ComponentSelector, ComponentSelectorElement, ComponentSelectorSet
+export select_components, get_name, get_subselectors
+export Metric, TimedMetric, TimelessMetric, ComponentSelectorTimedMetric,
+    ComponentTimedMetric,
+    SystemTimedMetric, ResultsTimelessMetric, CustomTimedMetric
+export DATETIME_COL, META_COL_KEY, SYSTEM_COL, RESULTS_COL, AGG_META_KEY
+export is_col_meta, set_col_meta, set_col_meta!, time_df, time_vec, data_cols, data_df,
+    data_vec, data_mat, get_description, get_component_agg_fn, get_time_agg_fn,
+    with_component_agg_fn, with_time_agg_fn, metric_selector_to_string, get_agg_meta,
+    set_agg_meta!
+export compute, compute_set, compute_all, hcat_timed, aggregate_time, compose_metrics
+export create_problem_results_dict
+export load_component_selector, storage_component_selector, generator_selectors_by_fuel
+export calc_active_power, calc_production_cost, calc_startup_cost, calc_shutdown_cost,
+    calc_discharge_cycles, calc_system_slack_up, calc_load_forecast, calc_active_power_in,
+    calc_active_power_out, calc_stored_energy, calc_active_power_forecast, calc_curtailment,
+    calc_sum_objective_value, calc_sum_solve_time, calc_sum_bytes_alloc, calc_total_cost,
+    make_calc_is_slack_up, calc_is_slack_up, calc_system_load_forecast,
+    calc_net_load_forecast, calc_curtailment_frac, calc_load_from_storage,
+    calc_system_load_from_storage, calc_integration, calc_capacity_factor
+export mean, weighted_mean, unweighted_sum
+
 #I/O Imports
 import Dates
 import TimeSeries
+import Statistics
+import Statistics: mean
 import DataFrames
+import DataFrames: DataFrame, metadata, metadata!, colmetadata, colmetadata!
 import YAML
 import DataStructures: OrderedDict, SortedDict
 import PowerSystems
+import PowerSystems:
+    Component,
+    ComponentSelector, ComponentSelectorElement, ComponentSelectorSet,
+    select_components, get_name, get_subselectors,
+    get_component, get_components,
+    get_available,
+    NAME_DELIMETER
+
 import InfrastructureSystems
 import PowerSimulations
 import InteractiveUtils
@@ -26,6 +59,11 @@ include("definitions.jl")
 include("get_data.jl")
 include("fuel_results.jl")
 
+include("metrics.jl")
+include("input.jl")
+include("builtin_component_selectors.jl")
+include("builtin_metrics.jl")
+
 greet() = print("Hello World!")
 
 end # module PowerAnalytics

src/builtin_component_selectors.jl

@@ -0,0 +1,62 @@
+"A ComponentSelector representing all the electric load in a System"
+load_component_selector = select_components(PSY.ElectricLoad)
+
+"A ComponentSelector representing all the storage in a System"
+storage_component_selector = select_components(PSY.Storage)
+
+FUEL_TYPES_DATA_FILE =
+    joinpath(dirname(dirname(pathof(PowerAnalytics))), "deps", "generator_mapping.yaml")
+
+# Parse the strings in generator_mapping.yaml into types and enum items
+function parse_fuel_category(category_spec::Dict)
+    # Use reflection to look up the type corresponding the generator type string (this isn't a security risk, is it?)
+    gen_type = getproperty(PowerSystems, Symbol(get(category_spec, "gentype", Component)))
+    (gen_type === Any) && (gen_type = Component)
+    @assert gen_type <: Component
+
+    pm = get(category_spec, "primemover", nothing)
+    isnothing(pm) || (pm = PowerSystems.parse_enum_mapping(PowerSystems.PrimeMovers, pm))
+
+    fc = get(category_spec, "fuel", nothing)
+    isnothing(fc) || (fc = PowerSystems.parse_enum_mapping(PowerSystems.ThermalFuels, fc))
+
+    return gen_type, pm, fc
+end
+
+function make_fuel_component_selector(category_spec::Dict)
+    parse_results = parse_fuel_category(category_spec)
+    (gen_type, prime_mover, fuel_category) = parse_results
+
+    function filter_closure(comp::Component)
+        comp_sig = Tuple{typeof(comp)}
+        if !isnothing(prime_mover)
+            hasmethod(PowerSystems.get_prime_mover_type, comp_sig) || return false
+            (PowerSystems.get_prime_mover_type(comp) == prime_mover) || return false
+        end
+        if !isnothing(fuel_category)
+            hasmethod(PowerSystems.get_fuel, comp_sig) || return false
+            (PowerSystems.get_fuel(comp) == fuel_category) || return false
+        end
+        return true
+    end
+
+    # Create a nice name that is guaranteed to never collide with fully-qualified component names
+    selector_name = join(ifelse.(isnothing.(parse_results), "", string.(parse_results)),
+        NAME_DELIMETER)
+
+    return select_components(filter_closure, gen_type, selector_name)
+end
+
+# Based on old PowerAnalytics' get_generator_mapping
+function load_generator_fuel_mappings(filename = FUEL_TYPES_DATA_FILE)
+    in_data = open(YAML.load, filename)
+    mappings = OrderedDict{String, ComponentSelector}()
+    for top_level in in_data |> keys |> collect |> sort
+        subselectors = make_fuel_component_selector.(in_data[top_level])
+        mappings[top_level] = select_components(subselectors...; name = top_level)
+    end
+    return mappings
+end
+
+"A dictionary of nested `ComponentSelector`s representing all the generators in a System categorized by fuel type"
+generator_selectors_by_fuel = load_generator_fuel_mappings()