Overview Documentation
Top
Main Readme
Concepts
Code
Tools Readme
API Documentation
((-))
((+))
model.adoptiondata
make_adoption_config
AdoptionData
adoption_sources
adoption_data_per_region
adoption_min_max_sd
adoption_low_med_high
adoption_trend
adoption_is_single_source
adoption_trend_per_region
model.advanced_controls
SOLUTION_CATEGORY
AdvancedControls
solution_category
vmas
vma_values
vma_statistics
name
description
creation_date
jsfile
pds_2014_cost
ref_2014_cost
conv_2014_cost
soln_first_cost_efficiency_rate
conv_first_cost_efficiency_rate
soln_first_cost_below_conv
soln_energy_efficiency_factor
conv_annual_energy_used
soln_annual_energy_used
conv_fuel_consumed_per_funit
soln_fuel_efficiency_factor
conv_fuel_emissions_factor
soln_fuel_emissions_factor
conv_emissions_per_funit
soln_emissions_per_funit
ch4_is_co2eq
n2o_is_co2eq
co2eq_conversion_source
ch4_co2_per_funit
n2o_co2_per_funit
soln_indirect_co2_per_iunit
conv_indirect_co2_per_unit
conv_indirect_co2_is_iunits
soln_lifetime_capacity
soln_avg_annual_use
conv_lifetime_capacity
conv_avg_annual_use
report_start_year
report_end_year
soln_var_oper_cost_per_funit
soln_fixed_oper_cost_per_iunit
soln_fuel_cost_per_funit
conv_var_oper_cost_per_funit
conv_fixed_oper_cost_per_iunit
conv_fuel_cost_per_funit
npv_discount_rate
emissions_use_co2eq
emissions_grid_source
emissions_grid_range
soln_ref_adoption_regional_data
soln_pds_adoption_regional_data
soln_ref_adoption_basis
soln_ref_adoption_custom_name
soln_pds_adoption_basis
soln_pds_adoption_custom_name
soln_pds_adoption_scenarios_included
soln_pds_adoption_custom_high_sd_mult
soln_pds_adoption_custom_low_sd_mult
soln_pds_adoption_prognostication_source
soln_pds_adoption_prognostication_trend
soln_pds_adoption_prognostication_growth
pds_source_post_2014
ref_source_post_2014
source_until_2014
ref_adoption_use_pds_years
pds_adoption_use_ref_years
ref_base_adoption
pds_adoption_final_percentage
pds_adoption_s_curve_innovation
pds_adoption_s_curve_imitation
tco2eq_reduced_per_land_unit
tco2eq_rplu_rate
tco2_rplu_rate
tn2o_co2_rplu_rate
tch4_co2_rplu_rate
tco2_reduced_per_land_unit
tn2o_co2_reduced_per_land_unit
tch4_co2_reduced_per_land_unit
emissions_use_agg_co2eq
seq_rate_global
seq_rate_per_regime
degradation_rate
disturbance_rate
global_multi_for_regrowth
soln_expected_lifetime
conv_expected_lifetime
yield_from_conv_practice
yield_gain_from_conv_to_soln
use_custom_tla
custom_tla_fixed_value
harvest_frequency
carbon_not_emitted_after_harvesting
avoided_deforest_with_intensification
delay_protection_1yr
delay_regrowth_1yr
include_unprotected_land_in_regrowth_calcs
land_annual_emissons_lifetime
tC_storage_in_protected_land_type
ref_tam_custom_source
pds_tam_custom_source
ref_adoption_custom_source
pds_adoption_custom_source
as_dict
explain_parameter
yield_coeff
has_var_costs
soln_first_cost_learning_rate
conv_first_cost_learning_rate
soln_fuel_learning_rate
soln_lifetime_replacement
soln_lifetime_replacement_rounded
conv_lifetime_replacement
conv_lifetime_replacement_rounded
lookup_vma
with_modifications
write_to_json_file
fill_missing_regions_from_world
load_scenarios_from_json
ac_from_dict
get_vma_for_param
get_param_for_vma_name
mangle_name_to_filename
solution_category_to_string
string_to_solution_category
model.aez
AEZ
world_land_alloc_dict
soln_land_dist_df
soln_land_alloc_df
applicable_zones
get_land_distribution
model.ch4calcs
CH4Calcs
ch4_co2eq_tons_reduced
ch4_tons_reduced
avoided_direct_emissions_ch4_co2eq_land
avoided_direct_emissions_ch4_land
ch4_megatons_avoided_or_reduced
ch4_ppb_calculator
model.co2calcs
C_TO_CO2EQ
NumpyEncoder
default
fair_scm_cached
fair_scm
co2_ppm_calculator_cached
CO2Calcs
co2_mmt_reduced
co2eq_mmt_reduced
co2only_mmt_reduced
co2_sequestered_global
co2_ppm_calculator
co2eq_ppm_calculator
co2_reduced_grid_emissions
co2_replaced_grid_emissions
co2_increased_grid_usage_emissions
co2eq_reduced_grid_emissions
co2eq_replaced_grid_emissions
co2eq_increased_grid_usage_emissions
co2eq_direct_reduced_emissions
co2only_direct_reduced_emissions
co2eq_reduced_fuel_emissions
co2eq_net_indirect_emissions
direct_emissions_from_harvesting
FaIR_CFT_baseline_co2eq
FaIR_CFT_Drawdown_co2eq
FaIR_CFT_baseline_RCP3
FaIR_CFT_baseline_RCP45
FaIR_CFT_baseline_RCP6
FaIR_CFT_baseline_RCP85
ghg_emissions_reductions_global_annual
ghg_emissions_reductions_global_cumulative
FaIR_CFT_Drawdown_RCP3
FaIR_CFT_Drawdown_RCP45
FaIR_CFT_Drawdown_RCP6
FaIR_CFT_Drawdown_RCP85
co2_rf
f
ch4_rf
co2eq_ppm
model.conversions
mha_to_ha
terawatt_to_kilowatt
EnergyConversion
accepted_names
conversion_rates
VolumeConversion
accepted_names
conversion_rates
MassConversion
accepted_names
conversion_rates
DistanceConversion
accepted_names
conversion_rates
model.customadoption
generate_df_template
inflate_csv_data
CustomAdoption
adoption_data_per_region
adoption_trend_per_region
report
model.data_handler
DataHandler
clean_nan
to_json
model.dd
model.decorators
data_func
model.dez
DEZ
get_ocean_distribution
model.emissionsfactors
CO2EQ_SOURCE
GRID_SOURCE
GRID_RANGE
CO2Equiv
string_to_conversion_source
string_to_emissions_grid_source
string_to_emissions_grid_range
ElectricityGenOnGrid
conv_ref_grid_CO2eq_per_KWh
conv_ref_grid_CO2_per_KWh
get_grid_emissions_data
model.excel_math
round_away
model.fairutil
baseline_emissions
fair_scm_kwargs
model.firstcost
FirstCost
soln_pds_install_cost_per_iunit
conv_ref_install_cost_per_iunit
soln_ref_install_cost_per_iunit
soln_pds_annual_world_first_cost
soln_ref_annual_world_first_cost
conv_ref_annual_world_first_cost
soln_pds_cumulative_install
ref_cumulative_install
model.helpertables
HelperTables
ref_adoption_type
pds_adoption_type
soln_ref_funits_adopted
soln_pds_funits_adopted
model.integration
integration_alt_file
integration_alt_name
integration_clean
model.interpolation
linear_trend
poly_degree2_trend
poly_degree3_trend
exponential_trend
single_trend
trend_algorithm
matching_data_sources
is_group_name
model.metaclass_cache
MetaclassCache
cache
hash_item
model.n2ocalcs
N2OCalcs
n2o_tons_reduced
avoided_direct_emissions_n2o_land
n2o_megatons_avoided_or_reduced
model.new_unit_adoption
NewUnitAdoption
description
disturbance_rate
sequestration_rate_all_ocean
get_area_units
get_skeleton
get_units_adopted
annual_breakout
get_operating_cost
get_incremental_units_per_period
get_install_cost_per_land_unit
get_annual_world_first_cost
get_lifetime_operating_savings
get_lifetime_cashflow_npv
get_net_profit_margin
set_area_units_linear
apply_linear_regression
apply_clip
get_cumulative_degraded_unprotected_area
get_total_at_risk_area
get_cumulative_degraded_area_under_protection
get_total_undegraded_area
get_annual_reduction_in_total_degraded_area
get_emissions_reduction_series
get_carbon_sequestration
model.ocean_scenario
OceanScenario
scenario_timestamp
scenario_description
conventional_first_cost
conventional_lifetime_capacity
conventional_average_annual_use
conventional_operating_cost
conventional_net_profit_margin
conventional_expected_lifetime
solution_first_cost
solution_lifetime_capacity
solution_average_annual_use
solution_operating_cost
solution_net_profit_margin
solution_expected_lifetime
unit_converting_factor
npv_discount_rate
emissions_reduced_per_unit_area
direct_emissions_are_annual
conventional_direct_emissions
conventional_indirect_emissions
solution_direct_emissions
solution_indirect_emissions
conventional_fuel_consumed
conventional_fuel_emissions_factor
solution_fuel_emissions_factor
solution_fuel_efficiency_factor
use_aggregate_CO2_equivalent_instead_of_individual_GHG
sequestration_rate_all_ocean
growth_rate_of_ocean_degradation
disturbance_rate
carbon_storage_in_protected_area_type
delay_impact_of_protection_by_one_year
delay_regrowth_of_degraded_land_by_one_year
use_adoption_for_carbon_sequestration_calculation
current_area_world
future_ref_area
future_pds_area
total_area_as_of_period
change_per_period
current_adoption_world
pds_scenario_name
ref_scenario_name
model.ocean_solution
OceanSolution
scenario
has_tam
has_grid_emissions_factors
set_up_area_units
load_scenario
get_scenario_names
get_loaded_scenario_name
get_adoption_unit_increase_pds_vs_ref_final_year
get_adoption_unit_increase_pds_final_year
get_global_percent_adoption_base_year
get_percent_adoption_start_year
get_percent_adoption_end_year
get_annual_world_first_cost_series
get_marginal_first_cost
get_cumulative_first_cost_solution
get_operating_cost_series
get_operating_cost
get_lifetime_operating_savings
get_lifetime_cashflow_npv_single_series
get_lifetime_cashflow_npv_single
get_lifetime_cashflow_npv_series
get_lifetime_cashflow_npv_all
get_payback_period_solution_only
get_payback_period_solution_only_npv
get_payback_period_solution_vs_conventional
get_payback_period_solution_vs_conventional_npv
get_abatement_cost
get_net_profit_margin_series
get_net_profit_margin
get_lifetime_profit_margin
get_emissions_reduction_series
get_total_emissions_reduction
get_max_annual_emissions_reduction
get_emissions_reduction_final_year
get_carbon_sequestration_series
get_total_co2_sequestered
get_max_annual_co2_sequestered
get_co2_sequestered_final_year
get_change_in_ppm_equivalent_series
get_change_in_ppm_equivalent
get_change_in_ppm_equivalent_final_year
get_reduced_area_degradation
get_carbon_under_protection_final_year
get_co2_under_protection_final_year
key_results
model.ocean_tam
OceanTam
set_tam_linear
apply_linear_regression
apply_3d_poly
apply_clip
get_tam_series
model.operatingcost
annual_breakout
OperatingCost
soln_pds_annual_operating_cost
soln_pds_cumulative_operating_cost
conv_ref_annual_operating_cost
conv_ref_cumulative_operating_cost
marginal_annual_operating_cost
soln_pds_new_funits_per_year
soln_pds_net_annual_iunits_reqd
soln_pds_new_annual_iunits_reqd
soln_pds_annual_breakout
soln_pds_annual_breakout_core
conv_ref_new_annual_iunits_reqd
conv_ref_annual_breakout
conv_ref_annual_breakout_core
soln_marginal_first_cost
soln_marginal_operating_cost_savings
soln_net_cash_flow
soln_net_present_value
soln_vs_conv_single_iunit_cashflow
soln_vs_conv_single_iunit_npv
soln_vs_conv_single_iunit_payback
soln_vs_conv_single_iunit_payback_discounted
soln_only_single_iunit_cashflow
soln_only_single_iunit_npv
soln_only_single_iunit_payback
soln_only_single_iunit_payback_discounted
model.s_curve
make_scurve_config
SCurve
logistic_adoption
bass_diffusion_adoption
model.scenario
Scenario
name
module_name
scenario
base_year
ac
ht
ad
pds_ca
ref_ca
sc
key_parameters
key_inputs
initialize_ac
pds_ca_overrides
pds_ad_overrides
pds_sc_overrides
initialize_adoption_bases
adoption_limit
adoption_unit_increase
marginal_first_cost
net_operating_savings
lifetime_operating_savings
cumulative_emissions_reduced
soln_net_energy_grid_impact
total_energy_saving
scenario_path
update_ac
update_adoptions
RRSScenario
tm
set_tam
adoption_limit
get_key_results
implementation_unit_adoption_increase
functional_unit_adoption_increase
LandScenario
tla_per_region
key_parameters
adoption_limit
get_key_results
total_additional_co2eq_sequestered
load_sources
write_sources
model.solution
Solution
model.tam
make_tam_config
TAM
forecast_data
forecast_min_max_sd
forecast_low_med_high
forecast_trend
ref_tam_per_region
pds_tam_per_region
model.tla
tla_per_region
CustomTLA
get_world_values
model.toa
toa_per_region
model.unitadoption
cumulative_degraded_land
UnitAdoption
ref_population
ref_gdp
ref_gdp_per_capita
ref_tam_per_capita
ref_tam_per_gdp_per_capita
ref_tam_growth
pds_population
pds_gdp
pds_gdp_per_capita
pds_tam_per_capita
pds_tam_per_gdp_per_capita
pds_tam_growth
cumulative_reduction_in_total_degraded_land
annual_reduction_in_total_degraded_land
pds_cumulative_degraded_land_unprotected
pds_cumulative_degraded_land_protected
pds_total_undegraded_land
ref_cumulative_degraded_land_unprotected
ref_cumulative_degraded_land_protected
ref_total_undegraded_land
soln_pds_cumulative_funits
soln_pds_tot_iunits_reqd
soln_pds_new_iunits_reqd
soln_pds_big4_iunits_reqd
soln_ref_cumulative_funits
soln_ref_tot_iunits_reqd
soln_ref_new_iunits_reqd_RRS
soln_ref_new_iunits_reqd_LAND
soln_ref_new_iunits_reqd
soln_net_annual_funits_adopted
net_annual_land_units_adopted
conv_ref_tot_iunits
conv_ref_annual_tot_iunits
conv_ref_new_iunits
soln_pds_net_grid_electricity_units_saved
soln_pds_net_grid_electricity_units_used
soln_pds_fuel_units_avoided
soln_pds_direct_co2_emissions_saved
soln_pds_direct_ch4_co2_emissions_saved
soln_pds_direct_n2o_co2_emissions_saved
net_land_units_after_emissions_lifetime
soln_pds_annual_land_area_harvested
direct_co2eq_emissions_saved_land
direct_co2_emissions_saved_land
direct_n2o_co2_emissions_saved_land
direct_ch4_co2_emissions_saved_land
model.units
map_to_unit
set_unit
get_unit
model.vma
convert_percentages
convert_NaN
normalize_units
VMA
title
filename
df
units
avg_high_low
write_to_file
reload_from_file
essential_parameters
load_vma_directory
write_vma_directory
model.world_land
AEZ_ALLOCATION_MAP
World_TMR_AEZ_Map
map
store_map
reduce_columns
built with
pdoc
model
.dd
Shared constant values