RunSubpopulationsExample.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2013 by the members listed in the COPYING,     *
 *                   LICENSE and WARRANTY file.                            *
 * email           : info at matsim dot org                                *
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *   See also COPYING, LICENSE and WARRANTY file                           *
 *                                                                         *
 * *********************************************************************** */

package tutorial.programming.example18MultipleSubpopulations;

import org.matsim.api.core.v01.Id;
import org.matsim.api.core.v01.Scenario;
import org.matsim.api.core.v01.TransportMode;
import org.matsim.api.core.v01.network.Node;
import org.matsim.api.core.v01.population.Activity;
import org.matsim.api.core.v01.population.Person;
import org.matsim.api.core.v01.population.Plan;
import org.matsim.api.core.v01.population.PopulationFactory;
import org.matsim.api.core.v01.population.PopulationWriter;
import org.matsim.core.config.Config;
import org.matsim.core.config.ConfigUtils;
import org.matsim.core.config.groups.StrategyConfigGroup.StrategySettings;
import org.matsim.core.controler.Controler;
import org.matsim.core.controler.OutputDirectoryHierarchy.OverwriteFileSetting;
import org.matsim.core.network.io.MatsimNetworkReader;
import org.matsim.core.replanning.strategies.DefaultPlanStrategiesModule;
import org.matsim.core.replanning.modules.ReRoute;
import org.matsim.core.replanning.modules.TimeAllocationMutator;
import org.matsim.core.scenario.ScenarioUtils;
import org.matsim.utils.objectattributes.ObjectAttributesXmlWriter;

import java.io.File;

public class RunSubpopulationsExample {
    final static String EQUIL_NETWORK = new File("./examples/equil/network.xml").getAbsolutePath();
    final static String PLANS = new File("./examples/tutorial/programming/multipleSubpopulations/plans.xml").getAbsolutePath();
    final static String OBJECT_ATTRIBUTES = new File("./examples/tutorial/programming/multipleSubpopulations/personAtrributes.xml").getAbsolutePath();
    final static String CONFIG = "./examples/tutorial/programming/multipleSubpopulations/config.xml";
    final static String OUTPUT = "./output/";

    private static final String SUBPOP_ATTRIB_NAME = "subpopulation";
    private static final String SUBPOP1_NAME = "time";
    private static final String SUBPOP2_NAME = "reroute";
    public static void main(String[] args) {
        // preparation of an example scenario:
        {
            Scenario sc = ScenarioUtils.createScenario(ConfigUtils.createConfig());

            /* Set up network and plans. */
            MatsimNetworkReader mnr = new MatsimNetworkReader(sc.getNetwork());
            mnr.readFile(EQUIL_NETWORK);
            createPopulation(sc, SUBPOP1_NAME, 100);
            createPopulation(sc, SUBPOP2_NAME, 100);
            new PopulationWriter(sc.getPopulation(), sc.getNetwork()).write(PLANS);
            new ObjectAttributesXmlWriter(sc.getPopulation().getPersonAttributes()).writeFile(OBJECT_ATTRIBUTES);
        }
        
        // building and running the simulation based on the example scenario:
        Config config = ConfigUtils.createConfig(); 
        ConfigUtils.loadConfig(config, CONFIG);
        config.plans().setInputFile(PLANS);
        config.plans().setInputPersonAttributeFile(OBJECT_ATTRIBUTES);
        config.plans().setSubpopulationAttributeName(SUBPOP_ATTRIB_NAME); /* This is the default anyway. */
        config.network().setInputFile(EQUIL_NETWORK);
        config.controler().setOutputDirectory(OUTPUT);
        
        /* Strategies set up in the 'strategy' module of the config file are
         * only applicable to the 'default' population, i.e. those agents without 
         * a subpopulation attribute. For all agents with a subpopulation
         * attribute, you need to set up the suite of strategies for the 
         * subpopulation(s).
         */
                
        /* Set up the subpopulations. */
        {
            /* Set up the 'time' subpopulation to only consider time allocation 
             * as a strategy, 20% of the time, and the balance using ChangeExpBeta. */
            StrategySettings timeStrategySettings = new StrategySettings(ConfigUtils.createAvailableStrategyId(config));
            timeStrategySettings.setStrategyName(DefaultPlanStrategiesModule.DefaultStrategy.TimeAllocationMutator.toString());
            timeStrategySettings.setSubpopulation(SUBPOP1_NAME);
            timeStrategySettings.setWeight(0.2);
            config.strategy().addStrategySettings(timeStrategySettings);
            
            StrategySettings changeExpBetaStrategySettings = new StrategySettings(ConfigUtils.createAvailableStrategyId(config));
            changeExpBetaStrategySettings.setStrategyName(DefaultPlanStrategiesModule.DefaultSelector.ChangeExpBeta.toString());
            changeExpBetaStrategySettings.setSubpopulation(SUBPOP1_NAME);
            changeExpBetaStrategySettings.setWeight(0.8);
            config.strategy().addStrategySettings(changeExpBetaStrategySettings);
        }
        {
            /* Set up the `reroute' subpopulation to consider rerouting as a 
             * strategy, 20% of the time, and the balance using ChangeExpBeta. */
            StrategySettings rerouteStrategySettings = new StrategySettings( ConfigUtils.createAvailableStrategyId(config) ) ;
            rerouteStrategySettings.setStrategyName(DefaultPlanStrategiesModule.DefaultStrategy.ReRoute.toString());
            rerouteStrategySettings.setSubpopulation(SUBPOP2_NAME);
            rerouteStrategySettings.setWeight(0.2);
            config.strategy().addStrategySettings(rerouteStrategySettings);

            StrategySettings changeExpBetaStrategySettings = new StrategySettings(ConfigUtils.createAvailableStrategyId(config));
            changeExpBetaStrategySettings.setStrategyName(DefaultPlanStrategiesModule.DefaultSelector.ChangeExpBeta.toString());
            changeExpBetaStrategySettings.setSubpopulation(SUBPOP2_NAME);
            changeExpBetaStrategySettings.setWeight(0.8);
            config.strategy().addStrategySettings(changeExpBetaStrategySettings);
        }
        config.controler().setOverwriteFileSetting( OverwriteFileSetting.deleteDirectoryIfExists );
        
        /* Run the model. */
        Controler controler = new Controler(config);
        
        controler.run();
    }

    private static void createPopulation(Scenario scenario, String prefix, int number){
        PopulationFactory pf = scenario.getPopulation().getFactory();
        
        for(int i = 0; i < number; i++){
            Person person = pf.createPerson(Id.create(prefix + "_" + i, Person.class));
            
            /* Create basic home-work-home activities on equil network. */
            Plan plan = pf.createPlan();
            Activity h1 = pf.createActivityFromCoord("h", scenario.getNetwork().getNodes().get(Id.create("1", Node.class)).getCoord());
            h1.setEndTime(6*3600);
            Activity w = pf.createActivityFromCoord("w", scenario.getNetwork().getNodes().get(Id.create("2", Node.class)).getCoord());
            w.setEndTime(17*3600);
            Activity h2 = pf.createActivityFromCoord("h", scenario.getNetwork().getNodes().get(Id.create("3", Node.class)).getCoord());
            h2.setStartTime(18*3600);
            
            /* Add the activities to the plan. */
            plan.addActivity(h1);
            plan.addLeg(pf.createLeg( TransportMode.car ));
            plan.addActivity(w);
            plan.addLeg(pf.createLeg( TransportMode.car ));
            plan.addActivity(h2);
            
            person.addPlan(plan);
            scenario.getPopulation().addPerson(person);

            /* Set the subpopulation attribute. */
            scenario.getPopulation().getPersonAttributes().putAttribute(person.getId().toString(), SUBPOP_ATTRIB_NAME, prefix);
        }
    }

}