[Q&A] Using the Freight and EV contribs to create a fleet of electric delivery vehicles

[AFooteHW]

Provide the MATSim version you are using. You can find the version in the pom.xml. E.g. 2025.0.

2025.0

Did you build a minimal example to reproduce the issue?

• Yes!

Describe the problem you are facing.

I am trying to create a matsim scenario that uses both the freight and EV contribs to create a fleet of electric vehicles to perform both long haul and last mile deliveries. I have set up the EV contrib and can get normal agents in the plans.xml file to use electricity and I have the logistics agents creating carriers to collect shipments but I cannot see my carrier agents in the EV outputs.

Are these two contribs compatible with each other?

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.logging.log4j.core.config.Configurator;
import org.apache.logging.log4j.Level;
import org.matsim.api.core.v01.Id;
import org.matsim.api.core.v01.Scenario;
import org.matsim.api.core.v01.TransportMode;
import org.matsim.contrib.ev.EvConfigGroup;
import org.matsim.contrib.ev.EvModule;
import org.matsim.contrib.ev.discharging.AuxEnergyConsumption;
import org.matsim.contrib.ev.discharging.DriveEnergyConsumption;
import org.matsim.contrib.ev.discharging.VehicleTypeSpecificDriveEnergyConsumptionFactory;
import org.matsim.contrib.ev.infrastructure.LTHConsumptionModelReader;
import org.matsim.contrib.ev.routing.EvNetworkRoutingProvider;
import org.matsim.core.config.Config;
import org.matsim.core.config.ConfigGroup;
import org.matsim.core.config.ConfigUtils;
import org.matsim.core.config.ConfigWriter;
import org.matsim.core.config.groups.VspExperimentalConfigGroup;
import org.matsim.core.controler.AbstractModule;
import org.matsim.core.controler.Controler;
import org.matsim.core.controler.OutputDirectoryHierarchy.OverwriteFileSetting;

import org.matsim.core.replanning.GenericPlanStrategyImpl;
import org.matsim.core.replanning.selectors.RandomPlanSelector;
import org.matsim.core.scenario.ScenarioUtils;
import org.matsim.freight.carriers.*;
import org.matsim.freight.carriers.controller.CarrierControllerUtils;
import org.matsim.freight.carriers.controller.CarrierStrategyManager;
import org.matsim.freight.logistics.*;
import org.matsim.freight.logistics.examples.lspReplanning.AssignmentStrategyFactory;
import org.matsim.freight.logistics.resourceImplementations.ResourceImplementationUtils;
import org.matsim.freight.logistics.shipment.LspShipment;
import org.matsim.vehicles.VehicleType;
import org.matsim.vehicles.VehicleUtils;
import org.transit.logistics.TransitLSPScorer;

import java.util.Collection;
import java.util.Collections;

import static org.transit.logistics.createLSP.createInitialLSP;
import static org.transit.logistics.createLSP.createLSPShipments;
import static org.transit.logistics.createLongHaulLSP.createInitialLongHaulLSP;
import static org.transit.logistics.createLongHaulLSP.createLongHaulLSPShipments;

public class RunTransit {

    // Scale factor (must be same as specified when generating demand)
    private static final double SCALE_FACTOR = 0.04;
    private static final Logger logger = LogManager.getLogger(RunTransit.class);

    public static void main(String[] args) throws Exception {
        // Set global log level to DEBUG
        Configurator.setRootLevel(Level.DEBUG);
        EvConfigGroup evConfig = new EvConfigGroup();
        FreightCarriersConfigGroup carriersConfig = new FreightCarriersConfigGroup();
        carriersConfig.setTimeWindowHandling(FreightCarriersConfigGroup.TimeWindowHandling.ignore);
        carriersConfig.setTravelTimeSliceWidth(600);
        Config config = null;
        if (args == null || args.length == 0 || args[0] == null) {
            logger.warn("No config file given. Please provide config file as input at command line");
            System.exit(0);

        } else {
            config = ConfigUtils.loadConfig(args, evConfig, carriersConfig);
        }

        new RunTransit().run(config);
    }

    public void run(Config config) throws Exception {
        config.controller().setOverwriteFileSetting(OverwriteFileSetting.deleteDirectoryIfExists);

        // Specify scale factor
        config.qsim().setFlowCapFactor(SCALE_FACTOR);
        config.qsim().setStorageCapFactor(SCALE_FACTOR);

        Scenario scenario = ScenarioUtils.loadScenario(config);

        logger.info("Creating Freight Vehicle");
        Id<Carrier> carrierId = Id.create("DeliveryCarrier", Carrier.class);
        Id<VehicleType> vehicleTypeId = Id.create("EV_65.0kWh_carrier", VehicleType.class);
        VehicleType collectionVehType = VehicleUtils.createVehicleType(vehicleTypeId, TransportMode.car);
        VehicleUtils.setHbefaTechnology(collectionVehType.getEngineInformation(), "electricity");
        VehicleUtils.setEnergyCapacity(collectionVehType.getEngineInformation(), 65);
        collectionVehType.getCapacity().setOther(10);
        collectionVehType.getCostInformation().setCostsPerMeter(0.0004);
        collectionVehType.getCostInformation().setCostsPerSecond(0.38);
        collectionVehType.getCostInformation().setFixedCost(49.);
        collectionVehType.setMaximumVelocity(50 / 3.6);

        Id<Carrier> longHaulId = Id.create("HGVCarrier", Carrier.class);
        Id<VehicleType> vehicleTypeHGV = Id.create("EV_125.0kWh_HGV", VehicleType.class);
        VehicleType longHaulVehicle = VehicleUtils.createVehicleType(vehicleTypeHGV, TransportMode.car);
        VehicleUtils.setHbefaTechnology(longHaulVehicle.getEngineInformation(), "electricity");
        VehicleUtils.setEnergyCapacity(longHaulVehicle.getEngineInformation(), 125);
        longHaulVehicle.getCapacity().setOther(50);
        longHaulVehicle.getCostInformation().setCostsPerMeter(0.0008);
        longHaulVehicle.getCostInformation().setCostsPerSecond(0.58);
        longHaulVehicle.getCostInformation().setFixedCost(100.);
        longHaulVehicle.setMaximumVelocity(45 / 3.6);

        logger.info("Creating LSP");
        LSP lsp = createInitialLSP(scenario, carrierId, collectionVehType);
        LSP longHaulLSP = createInitialLongHaulLSP(scenario, longHaulId, longHaulVehicle);

        Collection<LspShipment> lspShortHaulShipments = createLSPShipments(scenario.getNetwork());
        Collection<LspShipment> lspLongHaulShipments = createLongHaulLSPShipments(scenario.getNetwork());

        logger.info("Assigning LSPShipments to LSP");
        for (LspShipment lspShipment : lspShortHaulShipments) {
            lsp.assignShipmentToLSP(lspShipment);
        }

        for (LspShipment lspShipment : lspLongHaulShipments) {
            longHaulLSP.assignShipmentToLSP(lspShipment);
        }

        logger.info("Schedule to LSP and the shipments");
        lsp.scheduleLogisticChains();
        longHaulLSP.scheduleLogisticChains();

        logger.info("Set up simulation with LSPModule");
        LSPUtils.loadLspsIntoScenario(scenario, Collections.singletonList(lsp));
        LSPUtils.loadLspsIntoScenario(scenario, Collections.singletonList(longHaulLSP));

        Controler controller = new Controler(scenario);
        {
            VehicleTypeSpecificDriveEnergyConsumptionFactory driveEnergyConsumptionFactory = new VehicleTypeSpecificDriveEnergyConsumptionFactory();
            var vehicleTypeCar = Id.create("EV_65.0kWh", VehicleType.class);
            driveEnergyConsumptionFactory.addEnergyConsumptionModelFactory(vehicleTypeCar,
                    new LTHConsumptionModelReader().readURL(ConfigGroup.getInputFileURL(config.getContext(), "MidCarMap.csv")));
            driveEnergyConsumptionFactory.addEnergyConsumptionModelFactory(vehicleTypeId,
                    new LTHConsumptionModelReader().readURL(ConfigGroup.getInputFileURL(config.getContext(), "SUVMap.csv")));
            driveEnergyConsumptionFactory.addEnergyConsumptionModelFactory(vehicleTypeHGV,
                    new LTHConsumptionModelReader().readURL(ConfigGroup.getInputFileURL(config.getContext(), "HGV16Map.csv")));

            AuxEnergyConsumption.Factory dummy = electricVehicle -> (timeOfDay, period, linkId) -> 0;

            new ConfigWriter(config).write("output-config.xml");

            controller.addOverridingModule(new LSPModule());
            controller.addOverridingModule(new EvModule());
            controller.addOverridingModule(new AbstractModule() {
                @Override
                public void install() {
//                    logger.info("Installing EV module");
//                    install(new EvModule());
//                    logger.info("Installing Logistics module");
//                    install(new LSPModule());

                    bind(DriveEnergyConsumption.Factory.class).toInstance(driveEnergyConsumptionFactory);  // TODO find a way to do this in the new style of adding modules
                    bind(AuxEnergyConsumption.Factory.class).toInstance(dummy); //a dummy factory, as aux consumption is part of the drive consumption in the model

                    addRoutingModuleBinding(TransportMode.car).toProvider(new EvNetworkRoutingProvider(TransportMode.car));

                    bind(LSPScorerFactory.class).toInstance(TransitLSPScorer::new);
                    bind(LSPStrategyManager.class)
                            .toProvider(
                                    () -> {
                                        LSPStrategyManager strategyManager = new LSPStrategyManagerImpl();
                                        strategyManager.addStrategy(
                                                new AssignmentStrategyFactory().createStrategy(), null, 1);
                                        return strategyManager;
                                    });
                    bind(CarrierStrategyManager.class)
                            .toProvider(
                                    () -> {
                                        CarrierStrategyManager strategyManager =
                                                CarrierControllerUtils.createDefaultCarrierStrategyManager();
                                        strategyManager.addStrategy(
                                                new GenericPlanStrategyImpl<>(new RandomPlanSelector<>()), null, 1);
                                        return strategyManager;
                                    });
                }
            });
            controller
                    .getConfig()
                    .vspExperimental()
                    .setVspDefaultsCheckingLevel(VspExperimentalConfigGroup.VspDefaultsCheckingLevel.warn);
            controller.run();

            // print the schedules for the assigned LSPShipments
            logger.info("print the schedules for the assigned Last-mile LSPShipments");
            ResourceImplementationUtils.printResults_shipmentPlan(
                config.controller().getOutputDirectory(), lsp);

            // print the schedules for the assigned LongHaulLSPShipments
            logger.info("print the schedules for the assigned Long-haul LSPShipments");
            ResourceImplementationUtils.printResults_shipmentPlan(
                    config.controller().getOutputDirectory(), longHaulLSP);
        }
    }
}

If possible, provide a link to your minimal example. This might be a GitHub repository.

https://drive.google.com/file/d/1wkEWf3QHBVs-7q3yy_aH86fx0vQRZ_ps/view?usp=sharing

If you want, provide some background information about you and your project. This might help us understand your issue better.

No response