Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Emissions4Pt #854

Open
wants to merge 5 commits into
base: emissions4Pt
Choose a base branch
from
Open

Emissions4Pt #854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
364a886
add an example for calculating emissions for transit vehicles while r…
haowuintub Jan 14, 2023
649e9ec
cleanups
haowuintub Jan 14, 2023
e735ef1
copy&paste
haowuintub Jan 14, 2023
22aa2bf
update the RunEmissionsForPtOfflineExample
haowuintub Jan 14, 2023
6ffa924
use output_allVehicles.xml.gz (instead of output_vehicles.xml.gz) to …
haowuintub Jan 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 98 additions & 7 deletions src/main/java/org/matsim/codeexamples/extensions/emissions/RunEmissionsForPtExample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
package org.matsim.codeexamples.extensions.emissions;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.matsim.api.core.v01.Scenario;
import org.matsim.api.core.v01.network.Link;
import org.matsim.contrib.emissions.EmissionModule;
import org.matsim.contrib.emissions.EmissionUtils;
import org.matsim.contrib.emissions.HbefaVehicleCategory;
import org.matsim.contrib.emissions.utils.EmissionsConfigGroup;
import org.matsim.contrib.emissions.utils.EmissionsConfigGroup.DetailedVsAverageLookupBehavior;
import org.matsim.core.config.Config;
import org.matsim.core.config.ConfigUtils;
import org.matsim.core.config.groups.QSimConfigGroup;
import org.matsim.core.controler.AbstractModule;
import org.matsim.core.controler.Controler;
import org.matsim.core.scenario.ScenarioUtils;
Expand All @@ -16,27 +20,114 @@
import org.matsim.vehicles.VehicleType;
import org.matsim.vehicles.VehicleUtils;

/**
*
* An example for calculating emissions for transit vehicles while running the matsim scenario.
*
* @author haowu, nagel
*/
class RunEmissionsForPtExample{

private static final Logger log = LogManager.getLogger(RunEmissionsForPtExample.class );

public static void main( String [] args ) {

Config config = ConfigUtils.loadConfig( IOUtils.extendUrl( ExamplesUtils.getTestScenarioURL( "pt-tutorial"), "0.config.xml" ) );
config.vehicles().setVehiclesFile("https://svn.vsp.tu-berlin.de/repos/public-svn/matsim/scenarios/countries/de/berlin/berlin-v5.5-10pct/input/berlin-v5-mode-vehicle-types.xml");
config.qsim().setVehiclesSource(QSimConfigGroup.VehiclesSource.modeVehicleTypesFromVehiclesData);
config.controler().setLastIteration(3);

EmissionsConfigGroup emissionConfig = ConfigUtils.addOrGetModule( config, EmissionsConfigGroup.class );
{
emissionConfig.setAverageColdEmissionFactorsFile( "../EFA_ColdStart_Vehcat_2020_Average_perVehCat_Bln_carOnly.csv" );
emissionConfig.setAverageWarmEmissionFactorsFile( "../EFA_HOT_Vehcat_2020_Average_perVehCat_Bln_carOnly.csv" );
emissionConfig.setHbefaTableConsistencyCheckingLevel(EmissionsConfigGroup.HbefaTableConsistencyCheckingLevel.allCombinations);
emissionConfig.setHbefaVehicleDescriptionSource(EmissionsConfigGroup.HbefaVehicleDescriptionSource.asEngineInformationAttributes);
emissionConfig.setHandlesHighAverageSpeeds(false);
emissionConfig.setWritingEmissionsEvents(true);

emissionConfig.setDetailedVsAverageLookupBehavior( DetailedVsAverageLookupBehavior.directlyTryAverageTable );
// (start with simplest option and debug from there)
//settings from old emission contrib version!
//emissionConfig.setHbefaRoadTypeSource(HbefaRoadTypeSource.fromLinkAttributes);

// define correct emissionConfig here:
// emissionConfig.set...
emissionConfig.setDetailedVsAverageLookupBehavior( DetailedVsAverageLookupBehavior.directlyTryAverageTable );
emissionConfig.setNonScenarioVehicles(EmissionsConfigGroup.NonScenarioVehicles.ignore);
emissionConfig.setEmissionsComputationMethod(EmissionsConfigGroup.EmissionsComputationMethod.AverageSpeed);
}

Scenario scenario = ScenarioUtils.loadScenario( config );

// feed info of vehicles
// non-public transit vehicles should be considered as non-hbefa vehicles
for (VehicleType type : scenario.getVehicles().getVehicleTypes().values()) {
EngineInformation engineInformation = type.getEngineInformation();
VehicleUtils.setHbefaVehicleCategory( engineInformation, HbefaVehicleCategory.NON_HBEFA_VEHICLE.toString());
VehicleUtils.setHbefaTechnology( engineInformation, "average" );
VehicleUtils.setHbefaSizeClass( engineInformation, "average" );
VehicleUtils.setHbefaEmissionsConcept( engineInformation, "average" );
log.info("handled vehicle: " + type.getId());
}
log.info("vehicles could be handled: " + scenario.getVehicles().getVehicleTypes().values().size());

for( VehicleType vehicleType : scenario.getTransitVehicles().getVehicleTypes().values() ){
EngineInformation ei = vehicleType.getEngineInformation();
VehicleUtils.setHbefaVehicleCategory( ei, "bus" ); // or whatever is in your file; maybe just set it to some truck type first
VehicleUtils.setHbefaTechnology( ei, "..." );
// ... define the public transport vehicle types such that there are corresponding lookups in the hbefa files.
EngineInformation transitVehicleEngineInformation = vehicleType.getEngineInformation();
VehicleUtils.setHbefaVehicleCategory( transitVehicleEngineInformation, HbefaVehicleCategory.PASSENGER_CAR.toString() ); // or whatever is in your file; maybe just set it to some truck type first
VehicleUtils.setHbefaTechnology( transitVehicleEngineInformation, "average" );
VehicleUtils.setHbefaSizeClass( transitVehicleEngineInformation, "average" );
VehicleUtils.setHbefaEmissionsConcept( transitVehicleEngineInformation, "average" );
//TODO: Put some random values for the rail vehicles since there is only information of urban bus for transit vehicles in hbefa 4.1.
}

// network
for (Link link : scenario.getNetwork().getLinks().values()) {

double freespeed = Double.NaN;

if (link.getFreespeed() <= 13.888889) {
freespeed = link.getFreespeed() * 2;
// for non motorway roads, the free speed level was reduced
} else {
freespeed = link.getFreespeed();
// for motorways, the original speed levels seems ok.
}

//TODO: also add pt links for the real scenarios
if(freespeed <= 8.333333333){ //30kmh
link.getAttributes().putAttribute("hbefa_road_type", "URB/Access/30");
} else if(freespeed <= 11.111111111){ //40kmh
link.getAttributes().putAttribute("hbefa_road_type", "URB/Access/40");
} else if(freespeed <= 13.888888889){ //50kmh
double lanes = link.getNumberOfLanes();
if(lanes <= 1.0){
link.getAttributes().putAttribute("hbefa_road_type", "URB/Local/50");
} else if(lanes <= 2.0){
link.getAttributes().putAttribute("hbefa_road_type", "URB/Distr/50");
} else if(lanes > 2.0){
link.getAttributes().putAttribute("hbefa_road_type", "URB/Trunk-City/50");
} else{
throw new RuntimeException("NoOfLanes not properly defined");
}
} else if(freespeed <= 16.666666667){ //60kmh
double lanes = link.getNumberOfLanes();
if(lanes <= 1.0){
link.getAttributes().putAttribute("hbefa_road_type", "URB/Local/60");
} else if(lanes <= 2.0){
link.getAttributes().putAttribute("hbefa_road_type", "URB/Trunk-City/60");
} else if(lanes > 2.0){
link.getAttributes().putAttribute("hbefa_road_type", "URB/MW-City/60");
} else{
throw new RuntimeException("NoOfLanes not properly defined");
}
} else if(freespeed <= 19.444444444){ //70kmh
link.getAttributes().putAttribute("hbefa_road_type", "URB/MW-City/70");
} else if(freespeed <= 22.222222222){ //80kmh
link.getAttributes().putAttribute("hbefa_road_type", "URB/MW-Nat./80");
} else if(freespeed > 22.222222222){ //faster
link.getAttributes().putAttribute("hbefa_road_type", "RUR/MW/>130");
} else{
throw new RuntimeException("Link not considered...");
}
}

Controler controler = new Controler( scenario );
Expand Down
180 changes: 180 additions & 0 deletions ...in/java/org/matsim/codeexamples/extensions/emissions/RunEmissionsForPtOfflineExample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
package org.matsim.codeexamples.extensions.emissions;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.matsim.api.core.v01.Id;
import org.matsim.api.core.v01.Scenario;
import org.matsim.api.core.v01.network.Link;
import org.matsim.contrib.emissions.EmissionModule;
import org.matsim.contrib.emissions.HbefaVehicleCategory;
import org.matsim.contrib.emissions.utils.EmissionsConfigGroup;
import org.matsim.contrib.emissions.utils.EmissionsConfigGroup.DetailedVsAverageLookupBehavior;
import org.matsim.core.api.experimental.events.EventsManager;
import org.matsim.core.config.Config;
import org.matsim.core.config.ConfigUtils;
import org.matsim.core.config.groups.QSimConfigGroup;
import org.matsim.core.controler.AbstractModule;
import org.matsim.core.controler.Injector;
import org.matsim.core.events.EventsUtils;
import org.matsim.core.events.algorithms.EventWriterXML;
import org.matsim.core.scenario.ScenarioUtils;
import org.matsim.vehicles.EngineInformation;
import org.matsim.vehicles.VehicleType;
import org.matsim.vehicles.VehicleUtils;

import java.util.ArrayList;
import java.util.List;

/**
*
* An example for calculating emissions for transit vehicles while running the matsim scenario.
*
* @author haowu, nagel
*/
class RunEmissionsForPtOfflineExample {
private static final Logger log = LogManager.getLogger(RunEmissionsForPtOfflineExample.class );
private static final String eventsFile = "output/test_emission4Pt/pt-tutorial_standard/output_events.xml.gz"; // The output event of the standard matsim scenario
private static final String emissionEventOutputPath = "output/test_emission4Pt/pt-tutorial_standard/emission.events.offline.xml.gz";

public static void main( String [] args ) {

Config config = ConfigUtils.loadConfig( "../0.config.xml" ); // Enter the path of config file with which you run the matsim scenario
config.vehicles().setVehiclesFile("output/test_emission4Pt/pt-tutorial_standard/output_allVehicles.xml.gz"); // The output vehicle files which contains the vehicle information which will be used later!
//config.qsim().setVehiclesSource(QSimConfigGroup.VehiclesSource.modeVehicleTypesFromVehiclesData);
config.plansCalcRoute().clearTeleportedModeParams();

EmissionsConfigGroup emissionConfig = ConfigUtils.addOrGetModule( config, EmissionsConfigGroup.class );
{
emissionConfig.setAverageColdEmissionFactorsFile( "../EFA_ColdStart_Vehcat_2020_Average_perVehCat_Bln_carOnly.csv" );
emissionConfig.setAverageWarmEmissionFactorsFile( "../EFA_HOT_Vehcat_2020_Average_perVehCat_Bln_carOnly.csv" );
emissionConfig.setHbefaTableConsistencyCheckingLevel(EmissionsConfigGroup.HbefaTableConsistencyCheckingLevel.allCombinations);
emissionConfig.setHbefaVehicleDescriptionSource(EmissionsConfigGroup.HbefaVehicleDescriptionSource.asEngineInformationAttributes);
emissionConfig.setHandlesHighAverageSpeeds(false);
emissionConfig.setWritingEmissionsEvents(true);

// (start with simplest option and debug from there)
//settings from old emission contrib version!
//emissionConfig.setHbefaRoadTypeSource(HbefaRoadTypeSource.fromLinkAttributes);

// define correct emissionConfig here:
emissionConfig.setDetailedVsAverageLookupBehavior( DetailedVsAverageLookupBehavior.directlyTryAverageTable );
emissionConfig.setNonScenarioVehicles(EmissionsConfigGroup.NonScenarioVehicles.ignore);
//emissionConfig.setNonScenarioVehicles( EmissionsConfigGroup.NonScenarioVehicles.abort );
emissionConfig.setEmissionsComputationMethod(EmissionsConfigGroup.EmissionsComputationMethod.AverageSpeed);
}

Scenario scenario = ScenarioUtils.loadScenario( config );

// feed info of vehicles
// non-public transit vehicles should be considered as non-hbefa vehicles
List<Id<VehicleType>> idList = new ArrayList<>();
scenario.getTransitVehicles().getVehicleTypes().values().forEach(v -> idList.add(v.getId()));
for (VehicleType vehicleType : scenario.getVehicles().getVehicleTypes().values()) {
if (idList.contains(vehicleType.getId()) ) {
EngineInformation transitVehicleEngineInformation = vehicleType.getEngineInformation();
VehicleUtils.setHbefaVehicleCategory( transitVehicleEngineInformation, HbefaVehicleCategory.PASSENGER_CAR.toString() ); // or whatever is in your file; maybe just set it to some truck type first
VehicleUtils.setHbefaTechnology( transitVehicleEngineInformation, "average" );
VehicleUtils.setHbefaSizeClass( transitVehicleEngineInformation, "average" );
VehicleUtils.setHbefaEmissionsConcept( transitVehicleEngineInformation, "average" );
//TODO: Put some random values for the rail vehicles since there is only information of urban bus for transit vehicles in hbefa 4.1.
} else {
EngineInformation engineInformation = vehicleType.getEngineInformation();
VehicleUtils.setHbefaVehicleCategory(engineInformation, HbefaVehicleCategory.NON_HBEFA_VEHICLE.toString());
VehicleUtils.setHbefaTechnology(engineInformation, "average");
VehicleUtils.setHbefaSizeClass(engineInformation, "average");
VehicleUtils.setHbefaEmissionsConcept(engineInformation, "average");
}
log.info("handled vehicle: " + vehicleType.getId());
}
log.info("the number of vehicles handled: " + scenario.getVehicles().getVehicleTypes().values().size());

// network
for (Link link : scenario.getNetwork().getLinks().values()) {

double freespeed = Double.NaN;

if (link.getFreespeed() <= 13.888889) {
freespeed = link.getFreespeed() * 2;
// for non motorway roads, the free speed level was reduced
} else {
freespeed = link.getFreespeed();
// for motorways, the original speed levels seems ok.
}

//TODO: also add pt links for the real scenarios
if(freespeed <= 8.333333333){ //30kmh
link.getAttributes().putAttribute("hbefa_road_type", "URB/Access/30");
} else if(freespeed <= 11.111111111){ //40kmh
link.getAttributes().putAttribute("hbefa_road_type", "URB/Access/40");
} else if(freespeed <= 13.888888889){ //50kmh
double lanes = link.getNumberOfLanes();
if(lanes <= 1.0){
link.getAttributes().putAttribute("hbefa_road_type", "URB/Local/50");
} else if(lanes <= 2.0){
link.getAttributes().putAttribute("hbefa_road_type", "URB/Distr/50");
} else if(lanes > 2.0){
link.getAttributes().putAttribute("hbefa_road_type", "URB/Trunk-City/50");
} else{
throw new RuntimeException("NoOfLanes not properly defined");
}
} else if(freespeed <= 16.666666667){ //60kmh
double lanes = link.getNumberOfLanes();
if(lanes <= 1.0){
link.getAttributes().putAttribute("hbefa_road_type", "URB/Local/60");
} else if(lanes <= 2.0){
link.getAttributes().putAttribute("hbefa_road_type", "URB/Trunk-City/60");
} else if(lanes > 2.0){
link.getAttributes().putAttribute("hbefa_road_type", "URB/MW-City/60");
} else{
throw new RuntimeException("NoOfLanes not properly defined");
}
} else if(freespeed <= 19.444444444){ //70kmh
link.getAttributes().putAttribute("hbefa_road_type", "URB/MW-City/70");
} else if(freespeed <= 22.222222222){ //80kmh
link.getAttributes().putAttribute("hbefa_road_type", "URB/MW-Nat./80");
} else if(freespeed > 22.222222222){ //faster
link.getAttributes().putAttribute("hbefa_road_type", "RUR/MW/>130");
} else{
throw new RuntimeException("Link not considered...");
}
}

// we do not want to run the full Controler. In consequence, we plug together the infrastructure one needs in order to run the emissions contrib:

EventsManager eventsManager = EventsUtils.createEventsManager();

AbstractModule module = new AbstractModule(){
@Override
public void install(){
bind( Scenario.class ).toInstance( scenario );
bind( EventsManager.class ).toInstance( eventsManager ) ;
bind( EmissionModule.class ) ;
}
};

com.google.inject.Injector injector = Injector.createInjector( config, module );

injector.getInstance(EmissionModule.class);

// ---

// add events writer into emissions event handler
final EventWriterXML eventWriterXML = new EventWriterXML( emissionEventOutputPath );
eventsManager.addHandler(eventWriterXML);

// read events file into the events reader. EmissionsModule and events writer have been added as handlers, and will act accordingly.
EventsUtils.readEvents( eventsManager, eventsFile );

// events writer needs to be explicitly closed, otherwise it does not work:
eventWriterXML.closeFile();

/* // also write vehicles and network and config as a service so we have all out files in one directory:
new MatsimVehicleWriter( scenario.getVehicles() ).writeFile( config.controler().getOutputDirectory() + "/output_vehicles.xml.gz" );
NetworkUtils.writeNetwork( scenario.getNetwork(), config.controler().getOutputDirectory() + "/output_network.xml.gz" );
ConfigUtils.writeConfig( config, config.controler().getOutputDirectory() + "/output_config.xml" );
ConfigUtils.writeMinimalConfig( config, config.controler().getOutputDirectory() + "/output_config_reduced.xml" );*/

}

}