From 6f4aed8bb745ecc2e6671db2ddf8445be6b5f0c6 Mon Sep 17 00:00:00 2001
From: tschlenther <schlenther@vsp.tu-berlin.de>
Date: Tue, 21 May 2024 15:51:05 +0200
Subject: [PATCH] try setting up a test for OpenBerlinDrtScenario

---
 .../run/RunOpenBerlinDrtScenarioTest.java     |  29 ++++
 .../input/drt/berlin-v6.1.drt-test-config.xml | 135 ++++++++++++++++++
 2 files changed, 164 insertions(+)
 create mode 100644 src/test/java/org/matsim/run/RunOpenBerlinDrtScenarioTest.java
 create mode 100644 test/input/drt/berlin-v6.1.drt-test-config.xml

diff --git a/src/test/java/org/matsim/run/RunOpenBerlinDrtScenarioTest.java b/src/test/java/org/matsim/run/RunOpenBerlinDrtScenarioTest.java
new file mode 100644
index 000000000..43dadede1
--- /dev/null
+++ b/src/test/java/org/matsim/run/RunOpenBerlinDrtScenarioTest.java
@@ -0,0 +1,29 @@
+package org.matsim.run;
+
+
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+import org.matsim.application.MATSimApplication;
+import org.matsim.testcases.MatsimTestUtils;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class RunOpenBerlinScenarioTest {
+
+	@RegisterExtension
+	public MatsimTestUtils utils = new MatsimTestUtils();
+
+	@Test
+	public void pct1() {
+
+		int code = MATSimApplication.execute(OpenBerlinScenario.class,
+			"--1pct",
+			"--output", utils.getOutputDirectory(),
+			"--iterations", "2",
+			"--config:simwrapper.defaultDashboards", "disabled"
+		);
+
+		assertThat(code).isEqualTo(0);
+
+	}
+}
diff --git a/test/input/drt/berlin-v6.1.drt-test-config.xml b/test/input/drt/berlin-v6.1.drt-test-config.xml
new file mode 100644
index 000000000..972c7b707
--- /dev/null
+++ b/test/input/drt/berlin-v6.1.drt-test-config.xml
@@ -0,0 +1,135 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE config SYSTEM "http://www.matsim.org/files/dtd/config_v2.dtd">
+<config>
+
+	<module name="berlinExperimental" >
+		<param name="tagDrtLinksBufferAroundServiceAreaShp" value="5000.0" />
+	</module>
+
+	<module name="multiModeDrt">
+		<parameterset type="drt">
+			<parameterset type="ExtensiveInsertionSearch"/>
+			<!-- If true, the startLink is changed to last link in the current schedule, so the taxi starts the next day at the link where it stopped operating the day before. False by default. -->
+			<param name="changeStartLinkToLastLinkInSchedule" value="true" />
+			<!-- allows to configure a service area per drt mode.Used with serviceArea Operational Scheme -->
+			<param name="drtServiceAreaShapeFile" value="https://svn.vsp.tu-berlin.de/repos/public-svn/matsim/scenarios/countries/de/berlin/berlin-v6.1/input/shp/Berlin_25832.shp" />
+			<!-- Idle vehicles return to the nearest of all start links. See: DvrpVehicle.getStartLink() -->
+			<param name="idleVehiclesReturnToDepots" value="false" />
+			<!-- Defines the slope of the maxTravelTime estimation function (optimisation constraint), i.e. maxTravelTimeAlpha * estimated_drt_travel_time + maxTravelTimeBeta. Alpha should not be smaller than 1. -->
+			<param name="maxTravelTimeAlpha" value="1.7" />
+			<!-- Defines the shift of the maxTravelTime estimation function (optimisation constraint), i.e. maxTravelTimeAlpha * estimated_drt_travel_time + maxTravelTimeBeta. Beta should not be smaller than 0. -->
+			<param name="maxTravelTimeBeta" value="120.0" />
+			<!-- Max wait time for the bus to come (optimisation constraint). -->
+			<param name="maxWaitTime" value="300.0" />
+			<!-- Maximum beeline distance (in meters) to next stop location in stopbased system for access/egress walk leg to/from drt. If no stop can be found within this maximum distance will return a direct walk of type drtMode_walk. -->
+			<param name="maxWalkDistance" value="2000.0" />
+			<!-- Mode which will be handled by PassengerEngine and VrpOptimizer (passengers'/customers' perspective) -->
+			<param name="mode" value="drt" />
+			<!-- Number of threads used for parallel evaluation of request insertion into existing schedules. Scales well up to 4, due to path data provision, the most computationally intensive part, using up to 4 threads. Default value is 'min(4, no. of cores available to JVM)' -->
+			<param name="numberOfThreads" value="8" />
+			<!-- Operational Scheme, either of door2door, stopbased or serviceAreaBased. door2door by default -->
+			<param name="operationalScheme" value="serviceAreaBased" />
+			<!-- If true, the max travel and wait times of a submitted request are considered hard constraints (the request gets rejected if one of the constraints is violated). If false, the max travel and wait times are considered soft constraints (insertion of a request that violates one of the constraints is allowed, but its cost is increased by additional penalty to make it relatively less attractive). Penalisation of insertions can be customised by injecting a customised InsertionCostCalculator.PenaltyCalculator -->
+			<param name="rejectRequestIfMaxWaitOrTravelTimeViolated" value="false" />
+			<!-- Bus stop duration. Must be positive. -->
+			<param name="stopDuration" value="60.0"/>
+			<!-- Stop locations file (transit schedule format, but without lines) for DRT stops. Used only for the stopbased mode -->
+			<param name="transitStopFile" value="null"/>
+			<!-- Limit the operation of vehicles to links (of the 'dvrp_routing' network) with 'allowedModes' containing this 'mode'. For backward compatibility, the value is set to false by default - this means that the vehicles are allowed to operate on all links of the 'dvrp_routing' network. The 'dvrp_routing' is defined by DvrpConfigGroup.networkModes) -->
+			<param name="useModeFilteredSubnetwork" value="true"/>
+			<!-- An XML file specifying the vehicle fleet. The file format according to dvrp_vehicles_v1.dtd -->
+			<param name="vehiclesFile"
+				   value="https://svn.vsp.tu-berlin.de/repos/public-svn/matsim/scenarios/countries/de/berlin/berlin-v6.1/input/berlin-v6.1.drt-by-rndLocations-100vehicles-4seats.xml.gz"/>
+			<!-- Writes out detailed DRT customer stats in each iteration. True by default. -->
+			<param name="writeDetailedCustomerStats" value="true"/>
+			<parameterset type="drtfare">
+				<!-- Basefare per Trip (fare = positive value) -->
+				<param name="basefare" value="0.0"/>
+				<!-- Minimum fare per trip (paid instead of the sum of base, time and distance fare if that sum would be lower than the minimum fare, fee = positive value). -->
+				<param name="minFarePerTrip" value="2.0"/>
+				<!-- Daily subscription fee (fee = positive value) -->
+				<param name="dailySubscriptionFee" value="0.0"/>
+				<!-- drt fare per meter (fee = positive value) -->
+				<param name="distanceFare_m" value="0.00035"/>
+				<!-- drt fare per hour (fee = positive value) -->
+				<param name="timeFare_h" value="0.0"/>
+			</parameterset>
+		</parameterset>
+	</module>
+
+	<module name="dvrp">
+		<!-- Mode of which the network will be used for throwing events and hence calculating travel times. Default is car. -->
+		<param name="mobsimMode" value="car"/>
+		<!-- Set of modes of which the network will be used for DVRP travel time estimation and routing DVRP vehicles. Each specific DVRP mode may use a subnetwork of this network for routing vehicles (e.g. DRT buses travelling only along a specified links or serving a limited area). Default is "car" (i.e. single-element set of modes), i.e. the car network is used. Empty value "" (i.e. empty set of modes) means no network filtering, i.e. the original scenario.network is used -->
+		<param name="networkModes" value="drt"/>
+		<!-- Used for OFFLINE estimation of travel times for VrpOptimizer by means of the exponential moving average. The weighting decrease, alpha, must be in (0,1]. We suggest small values of alpha, e.g. 0.05. The averaging starts from the initial travel time estimates. If not provided, the free-speed TTs is used as the initial estimates -->
+		<param name="travelTimeEstimationAlpha" value="0.05"/>
+		<!-- Used for ONLINE estimation of travel times for VrpOptimizer by combining WithinDayTravelTime and DvrpOfflineTravelTimeEstimator. The beta coefficient is provided in seconds and should be either 0 (no online estimation) or positive (mixed online-offline estimation). For 'beta = 0', only the offline estimate is used: 'onlineTT(t) = offlineTT(t)', where 'offlineTT(t)' in the offline estimate for TT at time 't', For 'beta > 0', estimating future TTs at time 't', uses the currently observed TT to correct the offline estimates is made: where 'currentTT' is the currently observed TT, and 'correction = min(1, max(0, 1 - (time - currentTime) / beta))' The rule is that correction decreases linearly from 1 (when 'time = currentTime') to 0 (when 'time = currentTime + beta' For 'time > currentTime + beta' correction is 0, whereas if 'time < currentTime' it is 1. If beta is sufficiently large, 'beta >> 0', only the currently observed TT is used. -->
+		<param name="travelTimeEstimationBeta" value="0.0"/>
+		<parameterset type="travelTimeMatrix" >
+			<!-- size of square cells (meters) used for computing travel time matrix. Default value is 200 m -->
+			<param name="cellSize" value="1000.0" />
+			<!-- Max network distance from node A to node B for B to be considered a neighbor of A. In such cases, a network travel time from A to B is calculated and stored in the sparse travel time matrix. Typically, 'maxNeighborDistance' should be higher than 'cellSize' (e.g. 5-10 times) in order to reduce the impact of imprecise zonal travel times for short distances. On the other, a too big value will result in large neighborhoods, which may slow down queries. The unit is meters. Default value is 1000 m. -->
+			<param name="maxNeighborDistance" value="1000.0" />
+			<!-- Max network travel time from node A to node B for B to be considered a neighbor of A. In such cases, a network travel time from A to B is calculated and stored in the sparse travel time matrix. Typically, 'maxNeighborTravelTime' should correspond to a distance that are higher than 'cellSize' (e.g. 5-10 times) in order to reduce the impact of imprecise zonal travel times for short distances. On the other, a too big value will result in large neighborhoods, which may slow down queries. The unit is seconds. Default value is 0 s (for backward compatibility). -->
+			<param name="maxNeighborTravelTime" value="0.0" />
+		</parameterset>
+	</module>
+
+	<module name="swissRailRaptor" >
+		<!-- KN comments: in principle, walk as alternative to drt will not work, since drt is always faster. Need to give the ASC to the router! However, with the reduced drt network we should be able to see differentiation.) -->
+
+		<!-- Possible values: CalcLeastCostModePerStop, RandomSelectOneModePerRoutingRequestAndDirection -->
+		<param name="intermodalAccessEgressModeSelection" value="CalcLeastCostModePerStop" />
+		<param name="useIntermodalAccessEgress" value="true" />
+		<parameterset type="intermodalAccessEgress" >
+			<!-- Radius from the origin / destination coord in which transit stops are searched. Only if less than 2 transit stops are found the search radius is increased step-wise until the maximum search radius set in param radius is reached. -->
+			<param name="initialSearchRadius" value="1500.0" />
+			<!-- If the mode is routed on the network, specify which linkId acts as access link to this stop in the transport modes sub-network. -->
+			<param name="linkIdAttribute" value="null" />
+			<!-- Radius from the origin / destination coord in which transit stops are accessible by this mode. -->
+			<param name="maxRadius" value="100000.0" />
+			<param name="mode" value="walk" />
+			<!-- If less than 2 stops were found in initialSearchRadius take the distance of the closest transit stop and add this extension radius to search again.The search radius will not exceed the maximum search radius set in param radius. -->
+			<param name="searchExtensionRadius" value="1000.0" />
+			<!-- Name of the transit stop attribute used to filter stops that should be included in the set of potential stops for access and egress. The attribute should be of type String. 'null' disables the filter and all stops within the specified radius will be used. -->
+			<param name="stopFilterAttribute" value="null" />
+			<!-- Only stops where the filter attribute has the value specified here will be considered as access or egress stops. -->
+			<param name="stopFilterValue" value="null" />
+		</parameterset>
+		<parameterset type="intermodalAccessEgress" >
+			<!-- If more than 1 transit stop is found in the initial search radius, the raptor stop finder will stop to search
+				 * more distant transit stops.
+				 * Setting setInitialSearchRadius(12000) will allow for crossing the whole Berlkoenig area with drt as
+				 * access/egress mode to pt. This way we are on the safe side and do not exclude any theoretically possible
+				 * drt ride.
+				 * Unfortunately that means that for a route from Alexanderplatz to Friedrichstrasse the pt router basically has
+				 * to route from all transit stops in the city center of Berlin to all transit stops in the city center of Berlin,
+				 * because it has to consider all transit stops in that 12 km radius from Alexanderplatz and Friedrichstrasse,
+				 * respectively. This slows down pt routing enormously.
+				 * To speed up there are two options:
+				 *  - restrict the set of transit stops accessible by drt using a stop filter attribute, e.g. only RE+S+U-Bahn
+				 *  - reduce the initial search radius (and thereby effectively prohibit drt rides longer than that initial
+				 *    search radius for access/egress to pt, because there is always more than 1 transit stop in that radius).
+				 *
+				 * For 2528 agents and no stop filter attribute PlanRouter in iteration 1 took
+				 *  - ca. 1 min at InitialSearchRadius 3 km
+				 *  - but 53 min at InitialSearchRadius 12km
+				 *
+				 * So we have to make use of the speed up options (and exclude theoretically possible but unlikely drt trips).
+				 *  - gleich aug'19  -->
+			<param name="initialSearchRadius" value="3000.0" />
+			<param name="linkIdAttribute" value="null" />
+			<!-- Berlkoenig service area has a maximum diameter of ca. 11km, access trips over 12km don't make sense.
+				 Prohibit them to save computation time.
+				 (RandomAccessEgressModeRaptorStopFinder will try again with walk, the other available access/egress mode)
+				 maybe we should restrict even further, see comment below for InitialSearchRadius. -->
+			<param name="maxRadius" value="12000.0" />
+			<param name="mode" value="drt" />
+			<param name="searchExtensionRadius" value="1000.0" />
+			<!-- take care that this still corresponds to the attribute used for tagging these TransitStops in RunDrtOpenBerlinScenario -->
+			<param name="stopFilterAttribute" value="drtStopFilter" />
+			<param name="stopFilterValue" value="station_S/U/RE/RB_drtServiceArea" />
+		</parameterset>
+	</module>
+</config>