MUSE
Contents:
1. Glossary
2. Getting Help
3. Installing MUSE
4. Running MUSE
5. MUSE Overview
6. Application Flow
7. Key MUSE Components
8. Customising MUSE Tutorials
9. Input Files
10. Advanced guide
11. FAQs
12. API
13. Release notes
MUSE
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
W
|
Y
_
_housekeeping (Agent attribute)
A
AbstractAgent (class in muse.agents.agent)
AbstractSector (class in muse.sectors)
,
[1]
(class in muse.sectors.abstract)
add_investments() (InvestingAgent method)
adjust_bounds() (in module muse.carbon_budget)
Agent (class in muse.agents.agent)
agent_concatenation() (in module muse.utilities)
agents (Sector property)
,
[1]
,
[2]
agents_factory() (in module muse.agents.factories)
aggregate_enduses() (in module muse.sectors.subsector)
aggregate_lp() (Subsector method)
Anaconda
Anaconda Prompt
asset_housekeeping() (Agent method)
asset_merge_factory() (in module muse.hooks)
assets (AbstractAgent attribute)
avoid_repetitions() (in module muse.utilities)
B
Benchmark years
bisect_bounds() (in module muse.carbon_budget)
bisect_bounds_inverted() (in module muse.carbon_budget)
bisection() (in module muse.carbon_budget)
broadcast_over_assets() (in module muse.utilities)
broadcast_timeslice() (in module muse.timeslices)
C
cache() (OutputCache method)
cache_quantity() (in module muse.outputs.cache)
CACHE_TOPIC_CHANNEL (in module muse.outputs.cache)
camel_to_snake() (in module muse.readers)
capacity (Sector property)
,
[1]
,
[2]
capacity() (in module muse.outputs.cache)
(in module muse.outputs.mca)
(in module muse.outputs.sector)
,
[1]
capacity_in_use() (in module muse.quantities)
capacity_to_service_demand() (in module muse.objectives)
(in module muse.quantities)
capital_costs() (in module muse.objectives)
CARBON_BUDGET_FITTERS (in module muse.carbon_budget)
CARBON_BUDGET_FITTERS_SIGNATURE (in module muse.carbon_budget)
CARBON_BUDGET_METHODS (in module muse.carbon_budget)
CARBON_BUDGET_METHODS_SIGNATURE (in module muse.carbon_budget)
category (AbstractAgent attribute)
check_demand_fulfillment() (in module muse.mca)
check_dimensions() (in module muse.utilities)
check_equilibrium() (in module muse.mca)
check_usage() (in module muse.commodities)
clean() (in module muse.hooks)
clean_assets() (in module muse.utilities)
cliff_retirement_profile() (in module muse.investments)
comfort() (in module muse.objectives)
CommodityUsage (class in muse.commodities)
compress() (in module muse.filters)
compress_timeslice() (in module muse.timeslices)
consolidate_cache() (OutputCache method)
consolidate_quantity() (in module muse.outputs.cache)
constraints (InvestingAgent attribute)
CONSUMABLE (CommodityUsage attribute)
consumption() (in module muse.outputs.mca)
(in module muse.outputs.sector)
,
[1]
(in module muse.quantities)
converged (FindEquilibriumResults attribute)
convert_to_global_timeslicing() (Sector method)
,
[1]
,
[2]
convert_to_sector_timeslicing() (Sector method)
,
[1]
,
[2]
coords_to_multiindex() (in module muse.utilities)
costs() (in module muse.outputs.sector)
,
[1]
create_newcapa_agent() (in module muse.agents.factories)
create_retrofit_agent() (in module muse.agents.factories)
create_sample() (in module muse.carbon_budget)
currently_existing_tech() (in module muse.filters)
currently_referenced_tech() (in module muse.filters)
D
decision (Agent attribute)
decrease_bounds() (in module muse.carbon_budget)
DEFAULT_SETTINGS_PATH (in module muse.readers)
demand() (in module muse.constraints)
demand_matching() (in module muse.demand_matching)
DEMAND_SHARE_SIGNATURE (in module muse.demand_share)
demand_threshold (Agent attribute)
distribute_timeslice() (in module muse.timeslices)
drop_timeslice() (in module muse.timeslices)
E
efficiency() (in module muse.objectives)
emission() (in module muse.quantities)
emission_cost() (in module muse.objectives)
EmissionsCache (class in muse.carbon_budget)
End-use demand
End-use technology
Endogenous quantity
endogenous_demand() (in module muse.regressions)
ENERGY (CommodityUsage attribute)
Energy service
Energy system
ENVIRONMENTAL (CommodityUsage attribute)
epsilon_constraints() (in module muse.decisions)
Equilibrium
equivalent_annual_cost() (in module muse.objectives)
Exogenous quantity
exp_guess_and_weights() (in module muse.carbon_budget)
expand_timeslice() (in module muse.timeslices)
Exponential (class in muse.regressions)
exponential() (in module muse.carbon_budget)
ExponentialAdj (class in muse.regressions)
extract_agents() (in module muse.outputs.cache)
extract_agents_internal() (in module muse.outputs.cache)
F
factory() (AbstractSector class method)
,
[1]
,
[2]
(in module muse.constraints)
(in module muse.decisions)
(in module muse.filters)
(in module muse.interactions)
(in module muse.objectives)
(in module muse.outputs.mca)
(in module muse.outputs.sector)
,
[1]
(in module muse.outputs.sinks)
(in module muse.regressions)
(MCA class method)
(PresetSector class method)
,
[1]
,
[2]
(Sector class method)
,
[1]
,
[2]
(Subsector class method)
filter_input() (AbstractAgent method)
find_equilibrium() (in module muse.mca)
(MCA method)
FindEquilibriumResults (class in muse.mca)
finite_resource_logger() (in module muse.outputs.sinks)
FiniteResourceException
,
[1]
fitting() (in module muse.carbon_budget)
fixed_costs() (in module muse.objectives)
fuel_consumption_cost() (in module muse.objectives)
future_propagation() (in module muse.utilities)
G
get_level() (in module muse.timeslices)
H
housekeeping_factory() (in module muse.hooks)
I
identity() (in module muse.filters)
Imperfect information
increase_bounds() (in module muse.carbon_budget)
initialize_from_technologies() (in module muse.filters)
interactions (Sector attribute)
,
[1]
,
[2]
interpolate_capacity() (in module muse.utilities)
interpolation_mode (PresetSector attribute)
,
[1]
,
[2]
invest (InvestingAgent attribute)
invest() (Subsector method)
InvestingAgent (class in muse.agents.agent)
INVESTMENT_SIGNATURE (in module muse.investments)
is_consumable() (in module muse.commodities)
is_enduse() (in module muse.commodities)
is_fuel() (in module muse.commodities)
is_material() (in module muse.commodities)
is_other() (in module muse.commodities)
is_pollutant() (in module muse.commodities)
L
lcoe() (in module muse.outputs.cache)
Levelised cost of electricity
lexical_comparison() (in module muse.decisions)
(in module muse.utilities)
lifetime_levelized_cost_of_energy() (in module muse.objectives)
Limited foresight
Linear (class in muse.regressions)
linear() (in module muse.carbon_budget)
linear_guess_and_weights() (in module muse.carbon_budget)
Logistic (class in muse.regressions)
LogisticSigmoid (class in muse.regressions)
Loglog (class in muse.regressions)
M
market (FindEquilibriumResults attribute)
(SingleYearIterationResult attribute)
market_quantity() (in module muse.outputs.sector)
market_variables() (Sector method)
,
[1]
,
[2]
match_quantities() (in module muse.outputs.cache)
maturity() (in module muse.filters)
max_capacity_expansion() (in module muse.constraints)
max_production() (in module muse.constraints)
maximum_production() (in module muse.production)
(in module muse.quantities)
MCA (class in muse.mca)
mean() (in module muse.decisions)
merge_assets() (in module muse.hooks)
(in module muse.utilities)
merge_transform (Agent attribute)
metric_capital_costs() (in module muse.outputs.mca)
metric_eac() (in module muse.outputs.mca)
metric_emission_costs() (in module muse.outputs.mca)
metric_fuel_costs() (in module muse.outputs.mca)
metric_lcoe() (in module muse.outputs.mca)
minimum_production() (in module muse.quantities)
model() (in module muse.examples)
module
muse
muse.agents.factories
muse.carbon_budget
muse.commodities
muse.constraints
muse.decisions
muse.decorators
muse.demand_matching
muse.demand_share
muse.examples
muse.filters
muse.hooks
muse.interactions
muse.investments
muse.mca
muse.objectives
muse.outputs
muse.outputs.cache
muse.outputs.mca
muse.outputs.sector
,
[1]
muse.outputs.sinks
,
[1]
muse.production
muse.quantities
muse.readers
muse.readers.csv
,
[1]
muse.readers.toml
,
[1]
muse.registration
muse.regressions
muse.sectors
,
[1]
muse.sectors.abstract
muse.sectors.preset_sector
muse.sectors.register
muse.sectors.sector
muse.sectors.subsector
muse.timeslices
muse.utilities
multiindex_to_coords() (in module muse.utilities)
muse
module
muse.agents.factories
module
muse.carbon_budget
module
muse.commodities
module
muse.constraints
module
muse.decisions
module
muse.decorators
module
muse.demand_matching
module
muse.demand_share
module
muse.examples
module
muse.filters
module
muse.hooks
module
muse.interactions
module
muse.investments
module
muse.mca
module
muse.objectives
module
muse.outputs
module
muse.outputs.cache
module
muse.outputs.mca
module
muse.outputs.sector
module
,
[1]
muse.outputs.sinks
module
,
[1]
muse.production
module
muse.quantities
module
muse.readers
module
muse.readers.csv
module
,
[1]
muse.readers.toml
module
,
[1]
muse.registration
module
muse.regressions
module
muse.sectors
module
,
[1]
muse.sectors.abstract
module
muse.sectors.preset_sector
module
muse.sectors.register
module
muse.sectors.sector
module
muse.sectors.subsector
module
muse.timeslices
module
muse.utilities
module
N
name (AbstractAgent attribute)
(CommodityUsage property)
(PresetSector attribute)
,
[1]
,
[2]
(Sector attribute)
,
[1]
,
[2]
nametuple_to_dict() (in module muse.utilities)
net_present_value() (in module muse.objectives)
new_and_retro() (in module muse.demand_share)
new_assets_only() (in module muse.hooks)
new_to_retro_net() (in module muse.interactions)
next() (AbstractAgent method)
(AbstractSector method)
,
[1]
,
[2]
(Agent method)
(InvestingAgent method)
(PresetSector method)
,
[1]
,
[2]
(Sector method)
,
[1]
,
[2]
noop() (in module muse.hooks)
O
objectives (Agent attribute)
old_assets_only() (in module muse.hooks)
Open-source
OTHER (CommodityUsage attribute)
output_data (Sector attribute)
,
[1]
OUTPUT_QUANTITIES (in module muse.outputs.cache)
(in module muse.outputs.mca)
(in module muse.outputs.sector)
,
[1]
OUTPUT_QUANTITY_SIGNATURE (in module muse.outputs.cache)
(in module muse.outputs.mca)
(in module muse.outputs.sector)
,
[1]
OUTPUT_SINK_SIGNATURE (in module muse.outputs.sinks)
,
[1]
OUTPUT_SINKS (in module muse.outputs.sinks)
,
[1]
OutputCache (class in muse.outputs.cache)
outputs (Sector attribute)
,
[1]
,
[2]
OUTPUTS_PARAMETERS (in module muse.outputs.mca)
(in module muse.outputs.sector)
,
[1]
P
Pandas
Petajoules (PJ)
presets (PresetSector attribute)
,
[1]
,
[2]
PresetSector (class in muse.sectors)
(class in muse.sectors.preset_sector)
,
[1]
prices() (in module muse.outputs.mca)
PRODUCT (CommodityUsage attribute)
production() (in module muse.outputs.cache)
production_amplitude() (in module muse.quantities)
PRODUCTION_SIGNATURE (in module muse.production)
Q
quantity (AbstractAgent attribute)
R
read_attribute_table() (in module muse.readers.csv)
,
[1]
read_csv_agent_parameters() (in module muse.readers.csv)
,
[1]
read_global_commodities() (in module muse.readers.csv)
,
[1]
read_initial_assets() (in module muse.readers.csv)
,
[1]
read_initial_market() (in module muse.readers.csv)
,
[1]
read_io_technodata() (in module muse.readers.csv)
,
[1]
read_macro_drivers() (in module muse.readers.csv)
,
[1]
read_presets() (in module muse.readers.csv)
,
[1]
read_regression_parameters() (in module muse.readers.csv)
,
[1]
read_settings() (in module muse.readers.toml)
,
[1]
read_technodictionary() (in module muse.readers.csv)
,
[1]
read_technologies() (in module muse.readers.csv)
,
[1]
read_timeslice_shares() (in module muse.readers.csv)
,
[1]
reduce_asset() (in module muse.filters)
reduce_assets() (in module muse.utilities)
region (AbstractAgent attribute)
register_agent_interaction() (in module muse.interactions)
register_cached_quantity() (in module muse.outputs.cache)
register_carbon_budget_fitter() (in module muse.carbon_budget)
register_carbon_budget_method() (in module muse.carbon_budget)
register_constraints() (in module muse.constraints)
register_decision() (in module muse.decisions)
register_demand_share() (in module muse.demand_share)
register_filter() (in module muse.filters)
register_final_asset_transform() (in module muse.hooks)
register_initial_asset_transform() (in module muse.hooks)
register_initializer() (in module muse.filters)
register_interaction_net() (in module muse.interactions)
register_investment() (in module muse.investments)
register_objective() (in module muse.objectives)
register_output_quantity() (in module muse.outputs.mca)
(in module muse.outputs.sector)
,
[1]
register_output_sink() (in module muse.outputs)
(in module muse.outputs.sinks)
,
[1]
register_production() (in module muse.production)
register_regression() (in module muse.regressions)
register_sector() (in module muse.sectors)
(in module muse.sectors.register)
,
[1]
register_settings_check() (in module muse.decorators)
registrator() (in module muse.registration)
retro_epsilon_constraints() (in module muse.decisions)
retro_lexical_comparison() (in module muse.decisions)
round_values() (in module muse.outputs.mca)
run() (MCA method)
S
same_enduse() (in module muse.filters)
same_fuels() (in module muse.filters)
save_outputs() (Sector method)
,
[1]
,
[2]
Scenario analysis
Seaborn
search_rules (Agent attribute)
search_space() (in module muse.constraints)
Sector (class in muse.sectors)
(class in muse.sectors.sector)
,
[1]
sector_capacity() (in module muse.outputs.mca)
sector_capital_costs() (in module muse.outputs.mca)
sector_eac() (in module muse.outputs.mca)
sector_emission_costs() (in module muse.outputs.mca)
sector_fuel_costs() (in module muse.outputs.mca)
sector_lcoe() (in module muse.outputs.mca)
sectors (FindEquilibriumResults attribute)
(SingleYearIterationResult attribute)
SECTORS_REGISTERED (in module muse.sectors.register)
SETTINGS_CHECKS (in module muse.decorators)
SETTINGS_CHECKS_SIGNATURE (in module muse.decorators)
setup_module() (in module muse.timeslices)
similar_technology() (in module muse.filters)
Simulation
single_objective() (in module muse.decisions)
single_year_iteration() (in module muse.mca)
SingleYearIterationResult (class in muse.mca)
sink_to_file() (in module muse.outputs.sinks)
,
[1]
solve_market() (in module muse.carbon_budget)
sort_timeslices() (in module muse.timeslices)
spend_limit (Agent attribute)
standardize_quantity() (in module muse.outputs.sinks)
,
[1]
Subsector (class in muse.sectors.subsector)
,
[1]
subsectors (Sector attribute)
,
[1]
,
[2]
supply() (in module muse.outputs.mca)
(in module muse.outputs.sector)
,
[1]
(in module muse.production)
(in module muse.quantities)
supply_prod (Sector attribute)
,
[1]
,
[2]
T
technodata() (in module muse.examples)
technologies (Sector attribute)
,
[1]
Timeslice
timeslice_level (AbstractAgent attribute)
(Sector attribute)
,
[1]
,
[2]
(Subsector attribute)
timeslice_max() (in module muse.timeslices)
to_csv() (in module muse.outputs.sinks)
,
[1]
to_excel() (in module muse.outputs.sinks)
,
[1]
to_netcdf() (in module muse.outputs.sinks)
,
[1]
tolerance (AbstractAgent attribute)
transfer_assets() (in module muse.interactions)
tupled_dimension() (in module muse.utilities)
U
unmet_demand() (in module muse.demand_share)
unmet_forecasted_demand() (in module muse.demand_share)
update_carbon_budget() (in module muse.carbon_budget)
(MCA method)
update_carbon_price() (MCA method)
uuid (AbstractAgent attribute)
W
weighted_sum() (in module muse.decisions)
with_asset_technology() (in module muse.filters)
Y
year (Agent attribute)
YearlyAggregate (class in muse.outputs.sinks)
,
[1]