Skip to main content
Back to top
Ctrl
+
K
The OnStove Model
Quickstart
Resources
Contributors and Partners
The OnStove package
GitHub
The OnStove Model
Quickstart
Resources
Contributors and Partners
The OnStove package
GitHub
Ctrl
+
K
Section Navigation
The model objects
onstove.DataProcessor
onstove.DataProcessor.add_layer
onstove.DataProcessor.add_mask_layer
onstove.DataProcessor.align_layers
onstove.DataProcessor.get_distance_rasters
onstove.DataProcessor.mask_layers
onstove.DataProcessor.normalize_rasters
onstove.DataProcessor.read_model
onstove.DataProcessor.reproject_layers
onstove.DataProcessor.save_datasets
onstove.DataProcessor.set_postgres
onstove.DataProcessor.to_pickle
onstove.MCA
onstove.MCA.add_layer
onstove.MCA.add_mask_layer
onstove.MCA.align_layers
onstove.MCA.get_distance_rasters
onstove.MCA.get_index
onstove.MCA.index
onstove.MCA.mask_layers
onstove.MCA.normalize_rasters
onstove.MCA.plot_share
onstove.MCA.read_model
onstove.MCA.reproject_layers
onstove.MCA.save_datasets
onstove.MCA.set_assistance_need_index
onstove.MCA.set_clean_cooking_index
onstove.MCA.set_demand_index
onstove.MCA.set_postgres
onstove.MCA.set_supply_index
onstove.MCA.to_pickle
onstove.OnStove
onstove.OnStove.add_layer
onstove.OnStove.add_mask_layer
onstove.OnStove.align_layers
onstove.OnStove.calibrate_current_pop
onstove.OnStove.calibrate_urban_rural_split
onstove.OnStove.create_layer
onstove.OnStove.current_elec
onstove.OnStove.distance_to_electricity
onstove.OnStove.extract_emissions_costs_saved
onstove.OnStove.extract_fuel_costs
onstove.OnStove.extract_health_costs_saved
onstove.OnStove.extract_investment_costs
onstove.OnStove.extract_lives_saved
onstove.OnStove.extract_om_costs
onstove.OnStove.extract_opportunity_cost
onstove.OnStove.extract_reduced_emissions
onstove.OnStove.extract_salvage
onstove.OnStove.extract_time_saved
onstove.OnStove.extract_wealth_index
onstove.OnStove.final_elec
onstove.OnStove.get_clean_cooking_access
onstove.OnStove.get_distance_rasters
onstove.OnStove.get_value_of_time
onstove.OnStove.mask_layers
onstove.OnStove.maximum_net_benefit
onstove.OnStove.normalize
onstove.OnStove.normalize_rasters
onstove.OnStove.number_of_households
onstove.OnStove.plot
onstove.OnStove.plot_costs_benefits
onstove.OnStove.plot_distribution
onstove.OnStove.plot_split
onstove.OnStove.population_to_dataframe
onstove.OnStove.raster_to_dataframe
onstove.OnStove.read_model
onstove.OnStove.read_scenario_data
onstove.OnStove.read_tech_data
onstove.OnStove.reproject_layers
onstove.OnStove.run
onstove.OnStove.save_datasets
onstove.OnStove.set_base_fuel
onstove.OnStove.set_postgres
onstove.OnStove.summary
onstove.OnStove.to_csv
onstove.OnStove.to_image
onstove.OnStove.to_pickle
onstove.OnStove.to_raster
The OnStove technology classes
onstove.Technology
onstove.Technology.adjusted_pm25
onstove.Technology.carb
onstove.Technology.carbon_emissions
onstove.Technology.discount_factor
onstove.Technology.discount_fuel_cost
onstove.Technology.discounted_inv
onstove.Technology.discounted_om
onstove.Technology.get_carbon_intensity
onstove.Technology.health_parameters
onstove.Technology.morbidity
onstove.Technology.mort_morb
onstove.Technology.mortality
onstove.Technology.net_benefit
onstove.Technology.normalize
onstove.Technology.paf
onstove.Technology.relative_risk
onstove.Technology.required_energy
onstove.Technology.salvage
onstove.Technology.time_saved
onstove.Technology.total_costs
onstove.Technology.total_time
onstove.Biomass
onstove.Biomass.adjusted_pm25
onstove.Biomass.carb
onstove.Biomass.carbon_emissions
onstove.Biomass.discount_factor
onstove.Biomass.discount_fuel_cost
onstove.Biomass.discounted_inv
onstove.Biomass.discounted_om
onstove.Biomass.get_carbon_intensity
onstove.Biomass.health_parameters
onstove.Biomass.morbidity
onstove.Biomass.mort_morb
onstove.Biomass.mortality
onstove.Biomass.net_benefit
onstove.Biomass.normalize
onstove.Biomass.paf
onstove.Biomass.relative_risk
onstove.Biomass.required_energy
onstove.Biomass.salvage
onstove.Biomass.solar_panel_investment
onstove.Biomass.time_saved
onstove.Biomass.total_costs
onstove.Biomass.total_time
onstove.Biomass.transportation_time
onstove.Charcoal
onstove.Charcoal.adjusted_pm25
onstove.Charcoal.carb
onstove.Charcoal.carbon_emissions
onstove.Charcoal.discount_factor
onstove.Charcoal.discount_fuel_cost
onstove.Charcoal.discounted_inv
onstove.Charcoal.discounted_om
onstove.Charcoal.get_carbon_intensity
onstove.Charcoal.health_parameters
onstove.Charcoal.morbidity
onstove.Charcoal.mort_morb
onstove.Charcoal.mortality
onstove.Charcoal.net_benefit
onstove.Charcoal.normalize
onstove.Charcoal.paf
onstove.Charcoal.production_emissions
onstove.Charcoal.relative_risk
onstove.Charcoal.required_energy
onstove.Charcoal.salvage
onstove.Charcoal.time_saved
onstove.Charcoal.total_costs
onstove.Charcoal.total_time
onstove.Biogas
onstove.Biogas.adjusted_pm25
onstove.Biogas.available_biogas
onstove.Biogas.carb
onstove.Biogas.carbon_emissions
onstove.Biogas.discount_factor
onstove.Biogas.discount_fuel_cost
onstove.Biogas.discounted_inv
onstove.Biogas.discounted_om
onstove.Biogas.get_carbon_intensity
onstove.Biogas.get_collection_time
onstove.Biogas.health_parameters
onstove.Biogas.morbidity
onstove.Biogas.mort_morb
onstove.Biogas.mortality
onstove.Biogas.net_benefit
onstove.Biogas.normalize
onstove.Biogas.paf
onstove.Biogas.read_friction
onstove.Biogas.recalibrate_livestock
onstove.Biogas.relative_risk
onstove.Biogas.required_energy
onstove.Biogas.required_energy_hh
onstove.Biogas.salvage
onstove.Biogas.time_saved
onstove.Biogas.total_costs
onstove.Biogas.total_time
onstove.LPG
onstove.LPG.add_travel_time
onstove.LPG.adjusted_pm25
onstove.LPG.carb
onstove.LPG.carbon_emissions
onstove.LPG.discount_factor
onstove.LPG.discount_fuel_cost
onstove.LPG.discounted_inv
onstove.LPG.discounted_om
onstove.LPG.get_carbon_intensity
onstove.LPG.health_parameters
onstove.LPG.infrastructure_cost
onstove.LPG.infrastructure_salvage
onstove.LPG.morbidity
onstove.LPG.mort_morb
onstove.LPG.mortality
onstove.LPG.net_benefit
onstove.LPG.normalize
onstove.LPG.paf
onstove.LPG.relative_risk
onstove.LPG.required_energy
onstove.LPG.salvage
onstove.LPG.time_saved
onstove.LPG.total_costs
onstove.LPG.total_time
onstove.LPG.transport_emissions
onstove.LPG.transportation_cost
onstove.Electricity
onstove.Electricity.adjusted_pm25
onstove.Electricity.carb
onstove.Electricity.carbon_emissions
onstove.Electricity.discount_factor
onstove.Electricity.discount_fuel_cost
onstove.Electricity.discounted_inv
onstove.Electricity.discounted_om
onstove.Electricity.get_capacity_cost
onstove.Electricity.get_carbon_intensity
onstove.Electricity.get_grid_capacity_cost
onstove.Electricity.grid_salvage
onstove.Electricity.health_parameters
onstove.Electricity.morbidity
onstove.Electricity.mort_morb
onstove.Electricity.mortality
onstove.Electricity.net_benefit
onstove.Electricity.normalize
onstove.Electricity.paf
onstove.Electricity.relative_risk
onstove.Electricity.required_energy
onstove.Electricity.salvage
onstove.Electricity.time_saved
onstove.Electricity.total_costs
onstove.Electricity.total_time
GIS layer objects
onstove.VectorLayer
onstove.VectorLayer.copy
onstove.VectorLayer.get_distance_raster
onstove.VectorLayer.mask
onstove.VectorLayer.plot
onstove.VectorLayer.proximity
onstove.VectorLayer.rasterize
onstove.VectorLayer.read_layer
onstove.VectorLayer.reproject
onstove.VectorLayer.save
onstove.VectorLayer.start_points
onstove.VectorLayer.travel_time
onstove.RasterLayer
onstove.RasterLayer.align
onstove.RasterLayer.calculate_default_transform
onstove.RasterLayer.category_legend
onstove.RasterLayer.copy
onstove.RasterLayer.cumulative_count
onstove.RasterLayer.get_distance_raster
onstove.RasterLayer.get_quantiles
onstove.RasterLayer.log
onstove.RasterLayer.mask
onstove.RasterLayer.normalize
onstove.RasterLayer.plot
onstove.RasterLayer.polygonize
onstove.RasterLayer.proximity
onstove.RasterLayer.quantiles
onstove.RasterLayer.read_layer
onstove.RasterLayer.reproject
onstove.RasterLayer.save
onstove.RasterLayer.save_image
onstove.RasterLayer.save_style
onstove.RasterLayer.shape_from_cell
onstove.RasterLayer.start_points
onstove.RasterLayer.travel_time
Changelog
The OnStove package
onstove.DataProcessor
onstove.Data...
onstove.DataProcessor.to_pickle
#
DataProcessor.
to_pickle
(
name
)
[source]
#
Saves the model as a pickle.
On this page
DataProcessor.to_pickle()
Show Source
