-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
2879 lines (2696 loc) · 427 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>GTFS Kit 10.1.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/sphinxdoc.css?v=34905f61" />
<script src="_static/documentation_options.js?v=56ec1bb1"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="nav-item nav-item-0"><a href="#">GTFS Kit 10.1.1 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">GTFS Kit 10.1.1 documentation</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="gtfs-kit-version-documentation">
<h1>GTFS Kit 10.1.1 Documentation<a class="headerlink" href="#gtfs-kit-version-documentation" title="Link to this heading">¶</a></h1>
<div class="toctree-wrapper compound">
<span id="document-introduction"></span><section id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Link to this heading">¶</a></h2>
<p>GTFS Kit is a Python library for analyzing <a class="reference external" href="https://en.wikipedia.org/wiki/GTFS">General Transit Feed Specification (GTFS)</a> data in memory without a database.
It uses Pandas and GeoPandas to do the heavy lifting.</p>
</section>
<section id="authors">
<h2>Authors<a class="headerlink" href="#authors" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>Alex Raichev, 2019-09</p></li>
</ul>
</section>
<section id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h2>
<p>Install it from PyPI with UV, say, via <code class="docutils literal notranslate"><span class="pre">uv</span> <span class="pre">add</span> <span class="pre">gtfs_kit</span></code>.</p>
</section>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Link to this heading">¶</a></h2>
<p>In the Jupyter notebook <code class="docutils literal notranslate"><span class="pre">notebooks/examples.ipynb</span></code>.</p>
</section>
<section id="conventions">
<h2>Conventions<a class="headerlink" href="#conventions" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p>In conformance with GTFS, dates are encoded as YYYYMMDD date strings, and times are encoded as HH:MM:SS time strings with the possibility that HH > 24. <strong>Watch out</strong> for that possibility, because it has counterintuitive consequences; see e.g. <code class="xref py py-func docutils literal notranslate"><span class="pre">trips.is_active_trip()</span></code>, which is used in <a class="reference internal" href="#gtfs_kit.routes.compute_route_stats" title="gtfs_kit.routes.compute_route_stats"><code class="xref py py-func docutils literal notranslate"><span class="pre">routes.compute_route_stats()</span></code></a>, <a class="reference internal" href="#gtfs_kit.stops.compute_stop_stats" title="gtfs_kit.stops.compute_stop_stats"><code class="xref py py-func docutils literal notranslate"><span class="pre">stops.compute_stop_stats()</span></code></a>, and <a class="reference internal" href="#gtfs_kit.miscellany.compute_feed_stats" title="gtfs_kit.miscellany.compute_feed_stats"><code class="xref py py-func docutils literal notranslate"><span class="pre">miscellany.compute_feed_stats()</span></code></a>.</p></li>
<li><p>‘DataFrame’ and ‘Series’ refer to Pandas DataFrame and Series objects,
respectively</p></li>
</ul>
</section>
<span id="document-modules"></span><section id="module-gtfs_kit.constants">
<span id="module-constants"></span><h2>Module constants<a class="headerlink" href="#module-gtfs_kit.constants" title="Link to this heading">¶</a></h2>
<p>Constants useful across modules.</p>
<dl class="py data">
<dt class="sig sig-object py" id="gtfs_kit.constants.COLORS_SET2">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.constants.</span></span><span class="sig-name descname"><span class="pre">COLORS_SET2</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['#66c2a5',</span> <span class="pre">'#fc8d62',</span> <span class="pre">'#8da0cb',</span> <span class="pre">'#e78ac3',</span> <span class="pre">'#a6d854',</span> <span class="pre">'#ffd92f',</span> <span class="pre">'#e5c494',</span> <span class="pre">'#b3b3b3']</span></em><a class="headerlink" href="#gtfs_kit.constants.COLORS_SET2" title="Link to this definition">¶</a></dt>
<dd><p>Colorbrewer 8-class Set2 colors</p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="gtfs_kit.constants.DIST_UNITS">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.constants.</span></span><span class="sig-name descname"><span class="pre">DIST_UNITS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['ft',</span> <span class="pre">'mi',</span> <span class="pre">'m',</span> <span class="pre">'km']</span></em><a class="headerlink" href="#gtfs_kit.constants.DIST_UNITS" title="Link to this definition">¶</a></dt>
<dd><p>Valid distance units</p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="gtfs_kit.constants.DTYPE">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.constants.</span></span><span class="sig-name descname"><span class="pre">DTYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'agency_email':</span> <span class="pre">'string',</span> <span class="pre">'agency_fare_url':</span> <span class="pre">'string',</span> <span class="pre">'agency_id':</span> <span class="pre">'string',</span> <span class="pre">'agency_lang':</span> <span class="pre">'string',</span> <span class="pre">'agency_name':</span> <span class="pre">'string',</span> <span class="pre">'agency_phone':</span> <span class="pre">'string',</span> <span class="pre">'agency_timezone':</span> <span class="pre">'string',</span> <span class="pre">'agency_url':</span> <span class="pre">'string',</span> <span class="pre">'arrival_time':</span> <span class="pre">'string',</span> <span class="pre">'attribution_email':</span> <span class="pre">'string',</span> <span class="pre">'attribution_id':</span> <span class="pre">'string',</span> <span class="pre">'attribution_phone':</span> <span class="pre">'string',</span> <span class="pre">'attribution_url':</span> <span class="pre">'string',</span> <span class="pre">'bikes_allowed':</span> <span class="pre">'Int8',</span> <span class="pre">'block_id':</span> <span class="pre">'string',</span> <span class="pre">'contains_id':</span> <span class="pre">'string',</span> <span class="pre">'currency_type':</span> <span class="pre">'string',</span> <span class="pre">'date':</span> <span class="pre">'string',</span> <span class="pre">'departure_time':</span> <span class="pre">'string',</span> <span class="pre">'destination_id':</span> <span class="pre">'string',</span> <span class="pre">'direction_id':</span> <span class="pre">'Int8',</span> <span class="pre">'drop_off_type':</span> <span class="pre">'Int8',</span> <span class="pre">'end_date':</span> <span class="pre">'string',</span> <span class="pre">'end_time':</span> <span class="pre">'string',</span> <span class="pre">'exact_times':</span> <span class="pre">'Int8',</span> <span class="pre">'exception_type':</span> <span class="pre">'Int8',</span> <span class="pre">'fare_id':</span> <span class="pre">'string',</span> <span class="pre">'feed_end_date':</span> <span class="pre">'string',</span> <span class="pre">'feed_lang':</span> <span class="pre">'string',</span> <span class="pre">'feed_publisher_name':</span> <span class="pre">'string',</span> <span class="pre">'feed_publisher_url':</span> <span class="pre">'string',</span> <span class="pre">'feed_start_date':</span> <span class="pre">'string',</span> <span class="pre">'feed_version':</span> <span class="pre">'string',</span> <span class="pre">'friday':</span> <span class="pre">'Int8',</span> <span class="pre">'from_stop_id':</span> <span class="pre">'string',</span> <span class="pre">'headway_secs':</span> <span class="pre">'Int16',</span> <span class="pre">'is_authority':</span> <span class="pre">'Int8',</span> <span class="pre">'is_operator':</span> <span class="pre">'Int8',</span> <span class="pre">'is_producer':</span> <span class="pre">'Int8',</span> <span class="pre">'location_type':</span> <span class="pre">'Int8',</span> <span class="pre">'min_transfer_time':</span> <span class="pre">'Int16',</span> <span class="pre">'monday':</span> <span class="pre">'Int8',</span> <span class="pre">'organization_name':</span> <span class="pre">'string',</span> <span class="pre">'origin_id':</span> <span class="pre">'string',</span> <span class="pre">'parent_station':</span> <span class="pre">'string',</span> <span class="pre">'payment_method':</span> <span class="pre">'Int8',</span> <span class="pre">'pickup_type':</span> <span class="pre">'Int8',</span> <span class="pre">'price':</span> <span class="pre">'float',</span> <span class="pre">'route_color':</span> <span class="pre">'string',</span> <span class="pre">'route_desc':</span> <span class="pre">'string',</span> <span class="pre">'route_id':</span> <span class="pre">'string',</span> <span class="pre">'route_long_name':</span> <span class="pre">'string',</span> <span class="pre">'route_short_name':</span> <span class="pre">'string',</span> <span class="pre">'route_text_color':</span> <span class="pre">'string',</span> <span class="pre">'route_type':</span> <span class="pre">'Int8',</span> <span class="pre">'route_url':</span> <span class="pre">'string',</span> <span class="pre">'saturday':</span> <span class="pre">'Int8',</span> <span class="pre">'service_id':</span> <span class="pre">'string',</span> <span class="pre">'shape_dist_traveled':</span> <span class="pre">'float',</span> <span class="pre">'shape_id':</span> <span class="pre">'string',</span> <span class="pre">'shape_pt_lat':</span> <span class="pre">'float',</span> <span class="pre">'shape_pt_lon':</span> <span class="pre">'float',</span> <span class="pre">'shape_pt_sequence':</span> <span class="pre">'Int32',</span> <span class="pre">'start_date':</span> <span class="pre">'string',</span> <span class="pre">'start_time':</span> <span class="pre">'string',</span> <span class="pre">'stop_code':</span> <span class="pre">'string',</span> <span class="pre">'stop_desc':</span> <span class="pre">'string',</span> <span class="pre">'stop_headsign':</span> <span class="pre">'string',</span> <span class="pre">'stop_id':</span> <span class="pre">'string',</span> <span class="pre">'stop_lat':</span> <span class="pre">'float',</span> <span class="pre">'stop_lon':</span> <span class="pre">'float',</span> <span class="pre">'stop_name':</span> <span class="pre">'string',</span> <span class="pre">'stop_sequence':</span> <span class="pre">'Int32',</span> <span class="pre">'stop_timezone':</span> <span class="pre">'string',</span> <span class="pre">'stop_url':</span> <span class="pre">'string',</span> <span class="pre">'sunday':</span> <span class="pre">'Int8',</span> <span class="pre">'thursday':</span> <span class="pre">'Int8',</span> <span class="pre">'timepoint':</span> <span class="pre">'Int8',</span> <span class="pre">'to_stop_id':</span> <span class="pre">'string',</span> <span class="pre">'transfer_duration':</span> <span class="pre">'Int16',</span> <span class="pre">'transfer_type':</span> <span class="pre">'Int8',</span> <span class="pre">'transfers':</span> <span class="pre">'Int8',</span> <span class="pre">'trip_headsign':</span> <span class="pre">'string',</span> <span class="pre">'trip_id':</span> <span class="pre">'string',</span> <span class="pre">'trip_short_name':</span> <span class="pre">'string',</span> <span class="pre">'tuesday':</span> <span class="pre">'Int8',</span> <span class="pre">'wednesday':</span> <span class="pre">'Int8',</span> <span class="pre">'wheelchair_accessible':</span> <span class="pre">'Int8',</span> <span class="pre">'wheelchair_boarding':</span> <span class="pre">'Int8',</span> <span class="pre">'zone_id':</span> <span class="pre">'string'}</span></em><a class="headerlink" href="#gtfs_kit.constants.DTYPE" title="Link to this definition">¶</a></dt>
<dd><p>Data types for Pandas CSV reads</p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="gtfs_kit.constants.FEED_ATTRS">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.constants.</span></span><span class="sig-name descname"><span class="pre">FEED_ATTRS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['agency',</span> <span class="pre">'attributions',</span> <span class="pre">'calendar',</span> <span class="pre">'calendar_dates',</span> <span class="pre">'fare_attributes',</span> <span class="pre">'fare_rules',</span> <span class="pre">'feed_info',</span> <span class="pre">'frequencies',</span> <span class="pre">'routes',</span> <span class="pre">'shapes',</span> <span class="pre">'stops',</span> <span class="pre">'stop_times',</span> <span class="pre">'trips',</span> <span class="pre">'transfers',</span> <span class="pre">'dist_units']</span></em><a class="headerlink" href="#gtfs_kit.constants.FEED_ATTRS" title="Link to this definition">¶</a></dt>
<dd><p>Primary feed attributes</p>
</dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="gtfs_kit.constants.WGS84">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.constants.</span></span><span class="sig-name descname"><span class="pre">WGS84</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'EPSG:4326'</span></em><a class="headerlink" href="#gtfs_kit.constants.WGS84" title="Link to this definition">¶</a></dt>
<dd><p>WGS84 coordinate reference system for Geopandas</p>
</dd></dl>
</section>
<section id="module-gtfs_kit.helpers">
<span id="module-helpers"></span><h2>Module helpers<a class="headerlink" href="#module-gtfs_kit.helpers" title="Link to this heading">¶</a></h2>
<p>Functions useful across modules.</p>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.almost_equal">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">almost_equal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">f</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">g</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#gtfs_kit.helpers.almost_equal" title="Link to this definition">¶</a></dt>
<dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if and only if the given DataFrames are equal after
sorting their columns names, sorting their values, and
reseting their indices.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.combine_time_series">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">combine_time_series</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time_series_dict</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">DataFrame</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kind</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_directions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="headerlink" href="#gtfs_kit.helpers.combine_time_series" title="Link to this definition">¶</a></dt>
<dd><p>Combine the time series DataFrames in the given dictionary
into one time series DataFrame with hierarchical columns.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>time_series_dict</strong> (<em>dictionary</em>) – Has the form string -> time series</p></li>
<li><p><strong>kind</strong> (<em>string</em>) – <code class="docutils literal notranslate"><span class="pre">'route'</span></code> or <code class="docutils literal notranslate"><span class="pre">'stop'</span></code></p></li>
<li><p><strong>split_directions</strong> (<em>boolean</em>) – If <code class="docutils literal notranslate"><span class="pre">True</span></code>, then assume the original time series contains data
separated by trip direction; otherwise, assume not.
The separation is indicated by a suffix <code class="docutils literal notranslate"><span class="pre">'-0'</span></code> (direction 0)
or <code class="docutils literal notranslate"><span class="pre">'-1'</span></code> (direction 1) in the route ID or stop ID column
values.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Columns are hierarchical (multi-index).
The top level columns are the keys of the dictionary and
the second level columns are <code class="docutils literal notranslate"><span class="pre">'route_id'</span></code> and
<code class="docutils literal notranslate"><span class="pre">'direction_id'</span></code>, if <code class="docutils literal notranslate"><span class="pre">kind</span> <span class="pre">==</span> <span class="pre">'route'</span></code>, or ‘stop_id’ and
<code class="docutils literal notranslate"><span class="pre">'direction_id'</span></code>, if <code class="docutils literal notranslate"><span class="pre">kind</span> <span class="pre">==</span> <span class="pre">'stop'</span></code>.
If <code class="docutils literal notranslate"><span class="pre">split_directions</span></code>, then third column is
<code class="docutils literal notranslate"><span class="pre">'direction_id'</span></code>; otherwise, there is no <code class="docutils literal notranslate"><span class="pre">'direction_id'</span></code>
column.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>DataFrame</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.datestr_to_date">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">datestr_to_date</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">date</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">format_str</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'%Y%m%d'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inverse</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">date</span></span></span><a class="headerlink" href="#gtfs_kit.helpers.datestr_to_date" title="Link to this definition">¶</a></dt>
<dd><p>Given a string <code class="docutils literal notranslate"><span class="pre">x</span></code> representing a date in the given format,
convert it to a datetime.date object and return the result.
If <code class="docutils literal notranslate"><span class="pre">inverse</span></code>, then assume that <code class="docutils literal notranslate"><span class="pre">x</span></code> is a date object and return
its corresponding string in the given format.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.downsample">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">downsample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time_series</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">freq</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="headerlink" href="#gtfs_kit.helpers.downsample" title="Link to this definition">¶</a></dt>
<dd><p>Downsample the given route, stop, or feed time series,
(outputs of <a class="reference internal" href="#gtfs_kit.routes.compute_route_time_series" title="gtfs_kit.routes.compute_route_time_series"><code class="xref py py-func docutils literal notranslate"><span class="pre">routes.compute_route_time_series()</span></code></a>,
<a class="reference internal" href="#gtfs_kit.stops.compute_stop_time_series" title="gtfs_kit.stops.compute_stop_time_series"><code class="xref py py-func docutils literal notranslate"><span class="pre">stops.compute_stop_time_series()</span></code></a>, or
<a class="reference internal" href="#gtfs_kit.miscellany.compute_feed_time_series" title="gtfs_kit.miscellany.compute_feed_time_series"><code class="xref py py-func docutils literal notranslate"><span class="pre">miscellany.compute_feed_time_series()</span></code></a>,
respectively) to the given Pandas frequency string (e.g. ‘15Min’).
Return the given time series unchanged if the given frequency is
shorter than the original frequency.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.drop_feature_ids">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">drop_feature_ids</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">collection</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#gtfs_kit.helpers.drop_feature_ids" title="Link to this definition">¶</a></dt>
<dd><p>Given a GeoJSON FeatureCollection, remove the <code class="docutils literal notranslate"><span class="pre">'id'</span></code> attribute of each
Feature, if it exists.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.get_active_trips_df">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">get_active_trips_df</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">trip_times</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Series</span></span></span><a class="headerlink" href="#gtfs_kit.helpers.get_active_trips_df" title="Link to this definition">¶</a></dt>
<dd><p>Count the number of trips in <code class="docutils literal notranslate"><span class="pre">trip_times</span></code> that are active
at any given time.</p>
<p>Assume <code class="docutils literal notranslate"><span class="pre">trip_times</span></code> contains the columns</p>
<ul class="simple">
<li><p>start_time: start time of the trip in seconds past midnight</p></li>
<li><p>end_time: end time of the trip in seconds past midnight</p></li>
</ul>
<p>Return a Series whose index is times from midnight when trips
start and end and whose values are the number of active trips for that time.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.get_convert_dist">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">get_convert_dist</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dist_units_in</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dist_units_out</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#gtfs_kit.helpers.get_convert_dist" title="Link to this definition">¶</a></dt>
<dd><p>Return a function of the form</p>
<blockquote>
<div><p>distance in the units <code class="docutils literal notranslate"><span class="pre">dist_units_in</span></code> ->
distance in the units <code class="docutils literal notranslate"><span class="pre">dist_units_out</span></code></p>
</div></blockquote>
<p>Only supports distance units in <code class="xref py py-const docutils literal notranslate"><span class="pre">constants.DIST_UNITS</span></code>.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.get_max_runs">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">get_max_runs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">array</span></span></span><a class="headerlink" href="#gtfs_kit.helpers.get_max_runs" title="Link to this definition">¶</a></dt>
<dd><p>Given a list of numbers, return a NumPy array of pairs
(start index, end index + 1) of the runs of max value.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">get_max_runs</span><span class="p">([</span><span class="mi">7</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">])</span>
<span class="go">array([[0, 1],</span>
<span class="go"> [3, 5]])</span>
</pre></div>
</div>
<p>Assume x is not empty.
Recipe comes from
<a class="reference external" href="http://stackoverflow.com/questions/1066758/find-length-of-sequences-of-identical-values-in-a-numpy-array">Stack Overflow</a>.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.get_peak_indices">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">get_peak_indices</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">times</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">counts</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">array</span></span></span><a class="headerlink" href="#gtfs_kit.helpers.get_peak_indices" title="Link to this definition">¶</a></dt>
<dd><p>Given an increasing list of times as seconds past midnight and a
list of trip counts at those respective times,
return a pair of indices i, j such that times[i] to times[j] is
the first longest time period such that for all i <= x < j,
counts[x] is the max of counts.
Assume times and counts have the same nonzero length.</p>
<p>Examples:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">times</span> <span class="o">=</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">20</span><span class="p">,</span> <span class="mi">30</span><span class="p">,</span> <span class="mi">31</span><span class="p">,</span> <span class="mi">32</span><span class="p">,</span> <span class="mi">40</span><span class="p">]</span>
<span class="gp">>>> </span><span class="n">counts</span> <span class="o">=</span> <span class="p">[</span><span class="mi">7</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">]</span>
<span class="gp">>>> </span><span class="n">get_peak_indices</span><span class="p">(</span><span class="n">times</span><span class="p">,</span> <span class="n">counts</span><span class="p">)</span>
<span class="go">array([0, 1])</span>
<span class="gp">>>> </span><span class="n">counts</span> <span class="o">=</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">]</span>
<span class="gp">>>> </span><span class="n">times</span> <span class="o">=</span> <span class="p">[</span><span class="mi">18000</span><span class="p">,</span> <span class="mi">21600</span><span class="p">,</span> <span class="mi">28800</span><span class="p">]</span>
<span class="gp">>>> </span><span class="n">get_peak_indices</span><span class="p">(</span><span class="n">times</span><span class="p">,</span> <span class="n">counts</span><span class="p">)</span>
<span class="go">array([0, 3])</span>
</pre></div>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.get_segment_length">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">get_segment_length</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">linestring</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">LineString</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">p</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Point</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">q</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Point</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">float</span></span></span><a class="headerlink" href="#gtfs_kit.helpers.get_segment_length" title="Link to this definition">¶</a></dt>
<dd><p>Given a Shapely linestring and two Shapely points,
project the points onto the linestring, and return the distance
along the linestring between the two points.
If <code class="docutils literal notranslate"><span class="pre">q</span> <span class="pre">is</span> <span class="pre">None</span></code>, then return the distance from the start of the
linestring to the projection of <code class="docutils literal notranslate"><span class="pre">p</span></code>.
The distance is measured in the native coordinates of the linestring.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.is_metric">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">is_metric</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dist_units</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#gtfs_kit.helpers.is_metric" title="Link to this definition">¶</a></dt>
<dd><p>Return True if the given distance units equals ‘m’ or ‘km’;
otherwise return False.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.is_not_null">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">is_not_null</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">df</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">col_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#gtfs_kit.helpers.is_not_null" title="Link to this definition">¶</a></dt>
<dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if the given DataFrame has a column of the given
name (string), and there exists at least one non-NaN value in that
column; return <code class="docutils literal notranslate"><span class="pre">False</span></code> otherwise.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.longest_subsequence">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">longest_subsequence</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seq</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'strictly'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">order</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'increasing'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">index</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gtfs_kit.helpers.longest_subsequence" title="Link to this definition">¶</a></dt>
<dd><p>Return the longest increasing subsequence of <cite>seq</cite>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>seq</strong> (<em>sequence object</em>) – Can be any sequence, like <cite>str</cite>, <cite>list</cite>, <cite>numpy.array</cite>.</p></li>
<li><p><strong>mode</strong> (<em>{'strict'</em><em>, </em><em>'strictly'</em><em>, </em><em>'weak'</em><em>, </em><em>'weakly'}</em><em>, </em><em>optional</em>) – If set to ‘strict’, the subsequence will contain unique elements.
Using ‘weak’ an element can be repeated many times.
Modes ending in -ly serve as a convenience to use with <cite>order</cite> parameter,
because <cite>longest_sequence(seq, ‘weakly’, ‘increasing’)</cite> reads better.
The default is ‘strict’.</p></li>
<li><p><strong>order</strong> (<em>{'increasing'</em><em>, </em><em>'decreasing'}</em><em>, </em><em>optional</em>) – By default return the longest increasing subsequence, but it is possible
to return the longest decreasing sequence as well.</p></li>
<li><p><strong>key</strong> (<em>function</em><em>, </em><em>optional</em>) – Specifies a function of one argument that is used to extract a comparison
key from each list element (e.g., <cite>str.lower</cite>, <cite>lambda x: x[0]</cite>).
The default value is <cite>None</cite> (compare the elements directly).</p></li>
<li><p><strong>index</strong> (<em>bool</em><em>, </em><em>optional</em>) – If set to <cite>True</cite>, return the indices of the subsequence, otherwise return
the elements. Default is <cite>False</cite>.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><ul class="simple">
<li><p><strong>elements</strong> (<em>list, optional</em>) – A <cite>list</cite> of elements of the longest subsequence.
Returned by default and when <cite>index</cite> is set to <cite>False</cite>.</p></li>
<li><p><strong>indices</strong> (<em>list, optional</em>) – A <cite>list</cite> of indices pointing to elements in the longest subsequence.
Returned when <cite>index</cite> is set to <cite>True</cite>.</p></li>
<li><p>Taken from <a class="reference external" href="https://stackoverflow.com/a/38337443">this Stack Overflow answer</a>.</p></li>
</ul>
</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.make_html">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">make_html</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">d</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#gtfs_kit.helpers.make_html" title="Link to this definition">¶</a></dt>
<dd><p>Convert the given dictionary into an HTML table (string) with
two columns: keys of dictionary, values of dictionary.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.make_ids">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">make_ids</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'id_'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gtfs_kit.helpers.make_ids" title="Link to this definition">¶</a></dt>
<dd><p>Return a length <code class="docutils literal notranslate"><span class="pre">n</span></code> list of unique sequentially labelled strings for use as IDs.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">make_ids</span><span class="p">(</span><span class="mi">11</span><span class="p">,</span> <span class="n">prefix</span><span class="o">=</span><span class="s2">"s"</span><span class="p">)</span>
<span class="go">['s00', s01', 's02', 's03', 's04', 's05', 's06', 's07', 's08', 's09', 's10']</span>
</pre></div>
</div>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.restack_time_series">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">restack_time_series</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unstacked_time_series</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="headerlink" href="#gtfs_kit.helpers.restack_time_series" title="Link to this definition">¶</a></dt>
<dd><p>Given an unstacked stop, route, or feed time series in the form
output by the function <a class="reference internal" href="#gtfs_kit.helpers.unstack_time_series" title="gtfs_kit.helpers.unstack_time_series"><code class="xref py py-func docutils literal notranslate"><span class="pre">unstack_time_series()</span></code></a>, restack it into
its original time series form.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.timestr_mod24">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">timestr_mod24</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#gtfs_kit.helpers.timestr_mod24" title="Link to this definition">¶</a></dt>
<dd><p>Given a GTFS HH:MM:SS time string, return a timestring in the same
format but with the hours taken modulo 24.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.timestr_to_seconds">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">timestr_to_seconds</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">date</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inverse</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mod24</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#gtfs_kit.helpers.timestr_to_seconds" title="Link to this definition">¶</a></dt>
<dd><p>Given an HH:MM:SS time string <code class="docutils literal notranslate"><span class="pre">x</span></code>, return the number of seconds
past midnight that it represents.
In keeping with GTFS standards, the hours entry may be greater than
23.
If <code class="docutils literal notranslate"><span class="pre">mod24</span></code>, then return the number of seconds modulo <code class="docutils literal notranslate"><span class="pre">24*3600</span></code>.
If <code class="docutils literal notranslate"><span class="pre">inverse</span></code>, then do the inverse operation.
In this case, if <code class="docutils literal notranslate"><span class="pre">mod24</span></code> also, then first take the number of
seconds modulo <code class="docutils literal notranslate"><span class="pre">24*3600</span></code>.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.unstack_time_series">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">unstack_time_series</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time_series</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="headerlink" href="#gtfs_kit.helpers.unstack_time_series" title="Link to this definition">¶</a></dt>
<dd><p>Given a route, stop, or feed time series of the form output by the functions,
<code class="xref py py-func docutils literal notranslate"><span class="pre">compute_stop_time_series()</span></code>, <code class="xref py py-func docutils literal notranslate"><span class="pre">compute_route_time_series()</span></code>, or
<code class="xref py py-func docutils literal notranslate"><span class="pre">compute_feed_time_series()</span></code>, respectively, unstack it to return a DataFrame
of with the columns:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">"datetime"</span></code></p></li>
<li><p>the columns <code class="docutils literal notranslate"><span class="pre">time_series.columns.names</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">"value"</span></code>: value at the datetime and other columns</p></li>
</ul>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.helpers.weekday_to_str">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.helpers.</span></span><span class="sig-name descname"><span class="pre">weekday_to_str</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">weekday</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inverse</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></span><a class="headerlink" href="#gtfs_kit.helpers.weekday_to_str" title="Link to this definition">¶</a></dt>
<dd><p>Given a weekday number (integer in the range 0, 1, …, 6),
return its corresponding weekday name as a lowercase string.
Here 0 -> ‘monday’, 1 -> ‘tuesday’, and so on.
If <code class="docutils literal notranslate"><span class="pre">inverse</span></code>, then perform the inverse operation.</p>
</dd></dl>
</section>
<section id="module-validators">
<h2>Module validators<a class="headerlink" href="#module-validators" title="Link to this heading">¶</a></h2>
</section>
<section id="module-gtfs_kit.cleaners">
<span id="module-cleaners"></span><h2>Module cleaners<a class="headerlink" href="#module-gtfs_kit.cleaners" title="Link to this heading">¶</a></h2>
<p>Functions about cleaning feeds.</p>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.cleaners.aggregate_routes">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.cleaners.</span></span><span class="sig-name descname"><span class="pre">aggregate_routes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">by</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'route_short_name'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">route_id_prefix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'route_'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></span><a class="headerlink" href="#gtfs_kit.cleaners.aggregate_routes" title="Link to this definition">¶</a></dt>
<dd><p>Aggregate routes by route short name, say, and assign new route IDs using the
given prefix.</p>
<p>More specifically, create new route IDs with the function
<a class="reference internal" href="#gtfs_kit.cleaners.build_aggregate_routes_dict" title="gtfs_kit.cleaners.build_aggregate_routes_dict"><code class="xref py py-func docutils literal notranslate"><span class="pre">build_aggregate_routes_dict()</span></code></a> and the parameters <code class="docutils literal notranslate"><span class="pre">by</span></code> and
<code class="docutils literal notranslate"><span class="pre">route_id_prefix</span></code> and update the old route IDs to the new ones in all the relevant
Feed tables.
Return the resulting Feed.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.cleaners.aggregate_stops">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.cleaners.</span></span><span class="sig-name descname"><span class="pre">aggregate_stops</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">by</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'stop_code'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stop_id_prefix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'stop_'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></span><a class="headerlink" href="#gtfs_kit.cleaners.aggregate_stops" title="Link to this definition">¶</a></dt>
<dd><p>Aggregate stops by stop code, say, and assign new stop IDs using the
given prefix.</p>
<p>More specifically, create new stop IDs with the function
<a class="reference internal" href="#gtfs_kit.cleaners.build_aggregate_stops_dict" title="gtfs_kit.cleaners.build_aggregate_stops_dict"><code class="xref py py-func docutils literal notranslate"><span class="pre">build_aggregate_stops_dict()</span></code></a> and the parameters <code class="docutils literal notranslate"><span class="pre">by</span></code> and
<code class="docutils literal notranslate"><span class="pre">stop_id_prefix</span></code> and update the old stop IDs to the new ones in all the relevant
Feed tables.
Return the resulting Feed.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.cleaners.build_aggregate_routes_dict">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.cleaners.</span></span><span class="sig-name descname"><span class="pre">build_aggregate_routes_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">routes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'route_short_name'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">route_id_prefix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'route_'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#gtfs_kit.cleaners.build_aggregate_routes_dict" title="Link to this definition">¶</a></dt>
<dd><p>Given a DataFrame of routes, group the routes by route short name, say,
and assign new route IDs using the given prefix.
Return a dictionary of the form <old route ID> -> <new route ID>.
Helper function for <a class="reference internal" href="#gtfs_kit.cleaners.aggregate_routes" title="gtfs_kit.cleaners.aggregate_routes"><code class="xref py py-func docutils literal notranslate"><span class="pre">aggregate_routes()</span></code></a>.</p>
<p>More specifically, group <code class="docutils literal notranslate"><span class="pre">routes</span></code> by the <code class="docutils literal notranslate"><span class="pre">by</span></code> column, and for each group make
one new route ID for all the old route IDs in that group based on the given
<code class="docutils literal notranslate"><span class="pre">route_id_prefix</span></code> string and a running count, e.g. <code class="docutils literal notranslate"><span class="pre">'route_013'</span></code>.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.cleaners.build_aggregate_stops_dict">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.cleaners.</span></span><span class="sig-name descname"><span class="pre">build_aggregate_stops_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">stops</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">by</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'stop_code'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stop_id_prefix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'stop_'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#gtfs_kit.cleaners.build_aggregate_stops_dict" title="Link to this definition">¶</a></dt>
<dd><p>Given a DataFrame of stops, group the stops by stop code, say,
and assign new stop IDs using the given prefix.
Return a dictionary of the form <old stop ID> -> <new stop ID>.
Helper function for <a class="reference internal" href="#gtfs_kit.cleaners.aggregate_stops" title="gtfs_kit.cleaners.aggregate_stops"><code class="xref py py-func docutils literal notranslate"><span class="pre">aggregate_stops()</span></code></a>.</p>
<p>More specifically, group <code class="docutils literal notranslate"><span class="pre">stops</span></code> by the <code class="docutils literal notranslate"><span class="pre">by</span></code> column, and for each group make
one new stop ID for all the old stops IDs in that group based on the given
<code class="docutils literal notranslate"><span class="pre">stop_id_prefix</span></code> string and a running count, e.g. <code class="docutils literal notranslate"><span class="pre">'stop_013'</span></code>.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.cleaners.clean">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.cleaners.</span></span><span class="sig-name descname"><span class="pre">clean</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></span><a class="headerlink" href="#gtfs_kit.cleaners.clean" title="Link to this definition">¶</a></dt>
<dd><p>Apply the following functions to the given Feed in order and return the resulting
Feed.</p>
<ol class="arabic simple">
<li><p><a class="reference internal" href="#gtfs_kit.cleaners.clean_ids" title="gtfs_kit.cleaners.clean_ids"><code class="xref py py-func docutils literal notranslate"><span class="pre">clean_ids()</span></code></a></p></li>
<li><p><a class="reference internal" href="#gtfs_kit.cleaners.clean_times" title="gtfs_kit.cleaners.clean_times"><code class="xref py py-func docutils literal notranslate"><span class="pre">clean_times()</span></code></a></p></li>
<li><p><a class="reference internal" href="#gtfs_kit.cleaners.clean_route_short_names" title="gtfs_kit.cleaners.clean_route_short_names"><code class="xref py py-func docutils literal notranslate"><span class="pre">clean_route_short_names()</span></code></a></p></li>
<li><p><a class="reference internal" href="#gtfs_kit.cleaners.drop_zombies" title="gtfs_kit.cleaners.drop_zombies"><code class="xref py py-func docutils literal notranslate"><span class="pre">drop_zombies()</span></code></a></p></li>
</ol>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.cleaners.clean_column_names">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.cleaners.</span></span><span class="sig-name descname"><span class="pre">clean_column_names</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">df</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="headerlink" href="#gtfs_kit.cleaners.clean_column_names" title="Link to this definition">¶</a></dt>
<dd><p>Strip the whitespace from all column names in the given DataFrame
and return the result.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.cleaners.clean_ids">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.cleaners.</span></span><span class="sig-name descname"><span class="pre">clean_ids</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></span><a class="headerlink" href="#gtfs_kit.cleaners.clean_ids" title="Link to this definition">¶</a></dt>
<dd><p>In the given Feed, strip whitespace from all string IDs and
then replace every remaining whitespace chunk with an underscore.
Return the resulting Feed.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.cleaners.clean_route_short_names">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.cleaners.</span></span><span class="sig-name descname"><span class="pre">clean_route_short_names</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></span><a class="headerlink" href="#gtfs_kit.cleaners.clean_route_short_names" title="Link to this definition">¶</a></dt>
<dd><p>In <code class="docutils literal notranslate"><span class="pre">feed.routes</span></code>, assign ‘n/a’ to missing route short names and
strip whitespace from route short names.
Then disambiguate each route short name that is duplicated by
appending ‘-’ and its route ID.
Return the resulting Feed.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.cleaners.clean_times">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.cleaners.</span></span><span class="sig-name descname"><span class="pre">clean_times</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></span><a class="headerlink" href="#gtfs_kit.cleaners.clean_times" title="Link to this definition">¶</a></dt>
<dd><p>In the given Feed, convert H:MM:SS time strings to HH:MM:SS time
strings to make sorting by time work as expected.
Return the resulting Feed.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.cleaners.drop_invalid_columns">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.cleaners.</span></span><span class="sig-name descname"><span class="pre">drop_invalid_columns</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></span><a class="headerlink" href="#gtfs_kit.cleaners.drop_invalid_columns" title="Link to this definition">¶</a></dt>
<dd><p>Drop all DataFrame columns of the given Feed that are not
listed in the GTFS.
Return the resulting Feed.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.cleaners.drop_zombies">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.cleaners.</span></span><span class="sig-name descname"><span class="pre">drop_zombies</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></span><a class="headerlink" href="#gtfs_kit.cleaners.drop_zombies" title="Link to this definition">¶</a></dt>
<dd><p>In the given Feed, do the following in order and return the resulting Feed.</p>
<ol class="arabic simple">
<li><p>Drop stops of location type 0 or NaN with no stop times.</p></li>
<li><p>Remove undefined parent stations from the <code class="docutils literal notranslate"><span class="pre">parent_station</span></code> column.</p></li>
<li><p>Drop trips with no stop times.</p></li>
<li><p>Drop shapes with no trips.</p></li>
<li><p>Drop routes with no trips.</p></li>
<li><p>Drop services with no trips.</p></li>
</ol>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.cleaners.extend_id">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.cleaners.</span></span><span class="sig-name descname"><span class="pre">extend_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">id_col</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extension</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></span><a class="headerlink" href="#gtfs_kit.cleaners.extend_id" title="Link to this definition">¶</a></dt>
<dd><p>Add a prefix (if <code class="docutils literal notranslate"><span class="pre">prefix</span></code>) or a suffix (otherwise) to all values of column
<code class="docutils literal notranslate"><span class="pre">id_col</span></code> across all tables of this Feed.
This can be helpful when preparing to merge multiple GTFS feeds with colliding
route IDs, say.</p>
<p>Raises a ValueError if <code class="docutils literal notranslate"><span class="pre">id_col</span></code> values can’t have strings added to them,
e.g. if <code class="docutils literal notranslate"><span class="pre">id_col</span></code> is ‘direction_id’.</p>
</dd></dl>
</section>
<section id="module-gtfs_kit.calendar">
<span id="module-calendar"></span><h2>Module calendar<a class="headerlink" href="#module-gtfs_kit.calendar" title="Link to this heading">¶</a></h2>
<p>Functions about calendar and calendar_dates.</p>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.calendar.get_dates">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.calendar.</span></span><span class="sig-name descname"><span class="pre">get_dates</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">as_date_obj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#gtfs_kit.calendar.get_dates" title="Link to this definition">¶</a></dt>
<dd><p>Return a list of YYYYMMDD date strings for which the given Feed is valid,
which could be the empty list if the Feed has no calendar information.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">as_date_obj</span></code>, then return datetime.date objects instead.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.calendar.get_first_week">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.calendar.</span></span><span class="sig-name descname"><span class="pre">get_first_week</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">as_date_obj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#gtfs_kit.calendar.get_first_week" title="Link to this definition">¶</a></dt>
<dd><p>Return a list of YYYYMMDD date strings for the first Monday–Sunday
week (or initial segment thereof) for which the given Feed is valid.
If the feed has no Mondays, then return the empty list.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">as_date_obj</span></code>, then return date objects, otherwise return date strings.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.calendar.get_week">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.calendar.</span></span><span class="sig-name descname"><span class="pre">get_week</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">k</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">as_date_obj</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#gtfs_kit.calendar.get_week" title="Link to this definition">¶</a></dt>
<dd><p>Given a Feed and a positive integer <code class="docutils literal notranslate"><span class="pre">k</span></code>,
return a list of YYYYMMDD date strings corresponding to the kth Monday–Sunday week
(or initial segment thereof) for which the Feed is valid.
For example, k=1 returns the first Monday–Sunday week (or initial segment thereof).
If the Feed does not have k Mondays, then return the empty list.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">as_date_obj</span></code>, then return datetime.date objects instead.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.calendar.subset_dates">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.calendar.</span></span><span class="sig-name descname"><span class="pre">subset_dates</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">dates</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#gtfs_kit.calendar.subset_dates" title="Link to this definition">¶</a></dt>
<dd><p>Given a Feed and a list of YYYYMMDD date strings,
return the sublist of dates that lie in the Feed’s dates
(the output <code class="xref py py-func docutils literal notranslate"><span class="pre">feed.get_dates()</span></code>).</p>
</dd></dl>
</section>
<section id="module-gtfs_kit.routes">
<span id="module-routes"></span><h2>Module routes<a class="headerlink" href="#module-gtfs_kit.routes" title="Link to this heading">¶</a></h2>
<p>Functions about routes.</p>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.routes.build_route_timetable">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.routes.</span></span><span class="sig-name descname"><span class="pre">build_route_timetable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">route_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dates</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pd.DataFrame</span></span></span><a class="headerlink" href="#gtfs_kit.routes.build_route_timetable" title="Link to this definition">¶</a></dt>
<dd><p>Return a timetable for the given route and dates (YYYYMMDD date strings).</p>
<p>Return a DataFrame with whose columns are all those in <code class="docutils literal notranslate"><span class="pre">feed.trips</span></code> plus those in
<code class="docutils literal notranslate"><span class="pre">feed.stop_times</span></code> plus <code class="docutils literal notranslate"><span class="pre">'date'</span></code>.
The trip IDs are restricted to the given route ID.
The result is sorted first by date and then by grouping by
trip ID and sorting the groups by their first departure time.</p>
<p>Skip dates outside of the Feed’s dates.</p>
<p>If there is no route activity on the given dates, then return
an empty DataFrame.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.routes.build_zero_route_time_series">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.routes.</span></span><span class="sig-name descname"><span class="pre">build_zero_route_time_series</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">date_label</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'20010101'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">freq</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'5Min'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_directions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pd.DataFrame</span></span></span><a class="headerlink" href="#gtfs_kit.routes.build_zero_route_time_series" title="Link to this definition">¶</a></dt>
<dd><p>Return a route time series with the same index and hierarchical columns
as output by <a class="reference internal" href="#gtfs_kit.routes.compute_route_time_series_0" title="gtfs_kit.routes.compute_route_time_series_0"><code class="xref py py-func docutils literal notranslate"><span class="pre">compute_route_time_series_0()</span></code></a>,
but fill it full of zero values.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.routes.compute_route_stats">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.routes.</span></span><span class="sig-name descname"><span class="pre">compute_route_stats</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">trip_stats_subset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pd.DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dates</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headway_start_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'07:00:00'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headway_end_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'19:00:00'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_directions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pd.DataFrame</span></span></span><a class="headerlink" href="#gtfs_kit.routes.compute_route_stats" title="Link to this definition">¶</a></dt>
<dd><p>Compute route stats for all the trips that lie in the given subset
of trip stats (of the form output by the function <a class="reference internal" href="#gtfs_kit.trips.compute_trip_stats" title="gtfs_kit.trips.compute_trip_stats"><code class="xref py py-func docutils literal notranslate"><span class="pre">trips.compute_trip_stats()</span></code></a>)
and that start on the given dates (YYYYMMDD date strings).</p>
<p>If <code class="docutils literal notranslate"><span class="pre">split_directions</span></code>, then separate the stats by trip direction (0 or 1).
Use the headway start and end times to specify the time period for computing
headway stats.</p>
<p>Return a DataFrame with the columns</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">'date'</span></code></p></li>
<li><p>the columns listed in :func:<code class="docutils literal notranslate"><span class="pre">compute_route_stats_0</span></code></p></li>
</ul>
<p>Exclude dates with no active trips, which could yield the empty DataFrame.</p>
<p class="rubric">Notes</p>
<ul class="simple">
<li><p>The route stats for date d contain stats for trips that start on
date d only and ignore trips that start on date d-1 and end on
date d</p></li>
<li><p>Raise a ValueError if <code class="docutils literal notranslate"><span class="pre">split_directions</span></code> and no non-NaN
direction ID values present</p></li>
</ul>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.routes.compute_route_stats_0">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.routes.</span></span><span class="sig-name descname"><span class="pre">compute_route_stats_0</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">trip_stats_subset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headway_start_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'07:00:00'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headway_end_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'19:00:00'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_directions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="headerlink" href="#gtfs_kit.routes.compute_route_stats_0" title="Link to this definition">¶</a></dt>
<dd><p>Compute stats for the given subset of trips stats (of the form output by the
function <a class="reference internal" href="#gtfs_kit.trips.compute_trip_stats" title="gtfs_kit.trips.compute_trip_stats"><code class="xref py py-func docutils literal notranslate"><span class="pre">trips.compute_trip_stats()</span></code></a>).</p>
<p>Ignore trips with zero duration, because they are defunct.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">split_directions</span></code>, then separate the stats by trip direction (0 or 1).
Use the headway start and end times to specify the time period for computing
headway stats.</p>
<p>Return a DataFrame with the columns</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">'route_id'</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'route_short_name'</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'route_type'</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'direction_id'</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'num_trips'</span></code>: number of trips on the route in the subset</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'num_trip_starts'</span></code>: number of trips on the route with
nonnull start times</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'num_trip_ends'</span></code>: number of trips on the route with nonnull
end times that end before 23:59:59</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'num_stop_patterns'</span></code>: number of stop pattern across trips</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'is_loop'</span></code>: 1 if at least one of the trips on the route has
its <code class="docutils literal notranslate"><span class="pre">is_loop</span></code> field equal to 1; 0 otherwise</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'is_bidirectional'</span></code>: 1 if the route has trips in both
directions; 0 otherwise</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'start_time'</span></code>: start time of the earliest trip on the route</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'end_time'</span></code>: end time of latest trip on the route</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'max_headway'</span></code>: maximum of the durations (in minutes)
between trip starts on the route between
<code class="docutils literal notranslate"><span class="pre">headway_start_time</span></code> and <code class="docutils literal notranslate"><span class="pre">headway_end_time</span></code> on the given
dates</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'min_headway'</span></code>: minimum of the durations (in minutes)
mentioned above</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'mean_headway'</span></code>: mean of the durations (in minutes)
mentioned above</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'peak_num_trips'</span></code>: maximum number of simultaneous trips in
service (for the given direction, or for both directions when
<code class="docutils literal notranslate"><span class="pre">split_directions==False</span></code>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'peak_start_time'</span></code>: start time of first longest period
during which the peak number of trips occurs</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'peak_end_time'</span></code>: end time of first longest period during
which the peak number of trips occurs</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'service_duration'</span></code>: total of the duration of each trip on
the route in the given subset of trips; measured in hours</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'service_distance'</span></code>: total of the distance traveled by each
trip on the route in the given subset of trips;
measured in kilometers if <code class="docutils literal notranslate"><span class="pre">feed.dist_units</span></code> is metric;
otherwise measured in miles;
contains all <code class="docutils literal notranslate"><span class="pre">np.nan</span></code> entries if <code class="docutils literal notranslate"><span class="pre">feed.shapes</span> <span class="pre">is</span> <span class="pre">None</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'service_speed'</span></code>: service_distance/service_duration</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'mean_trip_distance'</span></code>: service_distance/num_trips</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'mean_trip_duration'</span></code>: service_duration/num_trips</p></li>
</ul>
<p>If not <code class="docutils literal notranslate"><span class="pre">split_directions</span></code>, then remove the
direction_id column and compute each route’s stats,
except for headways, using its trips running in both directions.
In this case, (1) compute max headway by taking the max of the
max headways in both directions; (2) compute mean headway by
taking the weighted mean of the mean headways in both
directions.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">trip_stats_subset</span></code> is empty, return an empty DataFrame.</p>
<p>Raise a ValueError if <code class="docutils literal notranslate"><span class="pre">split_directions</span></code> and no non-NaN
direction ID values present</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.routes.compute_route_time_series">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.routes.</span></span><span class="sig-name descname"><span class="pre">compute_route_time_series</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">trip_stats_subset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">pd.DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dates</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">freq</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'5Min'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_directions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pd.DataFrame</span></span></span><a class="headerlink" href="#gtfs_kit.routes.compute_route_time_series" title="Link to this definition">¶</a></dt>
<dd><p>Compute route stats in time series form for the trips that lie in
the trip stats subset (of the form output by the function
<a class="reference internal" href="#gtfs_kit.trips.compute_trip_stats" title="gtfs_kit.trips.compute_trip_stats"><code class="xref py py-func docutils literal notranslate"><span class="pre">trips.compute_trip_stats()</span></code></a>) and that start on the given dates
(YYYYMMDD date strings).</p>
<p>If <code class="docutils literal notranslate"><span class="pre">split_directions</span></code>, then separate each routes’s stats by trip direction.
Specify the time series frequency with a Pandas frequency string, e.g. <code class="docutils literal notranslate"><span class="pre">'5Min'</span></code>;
max frequency is one minute (‘Min’).</p>
<p>Return a DataFrame of the same format output by the function
<a class="reference internal" href="#gtfs_kit.routes.compute_route_time_series_0" title="gtfs_kit.routes.compute_route_time_series_0"><code class="xref py py-func docutils literal notranslate"><span class="pre">compute_route_time_series_0()</span></code></a> but with multiple dates</p>
<p>Exclude dates that lie outside of the Feed’s date range.
If all dates lie outside the Feed’s date range, then return an
empty DataFrame.</p>
<p class="rubric">Notes</p>
<ul class="simple">
<li><p>See the notes for <a class="reference internal" href="#gtfs_kit.routes.compute_route_time_series_0" title="gtfs_kit.routes.compute_route_time_series_0"><code class="xref py py-func docutils literal notranslate"><span class="pre">compute_route_time_series_0()</span></code></a></p></li>
<li><p>Raise a ValueError if <code class="docutils literal notranslate"><span class="pre">split_directions</span></code> and no non-NaN
direction ID values present</p></li>
</ul>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.routes.compute_route_time_series_0">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.routes.</span></span><span class="sig-name descname"><span class="pre">compute_route_time_series_0</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">trip_stats_subset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">date_label</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'20010101'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">freq</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'5Min'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_directions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="headerlink" href="#gtfs_kit.routes.compute_route_time_series_0" title="Link to this definition">¶</a></dt>
<dd><p>Compute stats in a 24-hour time series form for the given subset of trips (of the
form output by the function <a class="reference internal" href="#gtfs_kit.trips.compute_trip_stats" title="gtfs_kit.trips.compute_trip_stats"><code class="xref py py-func docutils literal notranslate"><span class="pre">trips.compute_trip_stats()</span></code></a>).</p>
<p>If <code class="docutils literal notranslate"><span class="pre">split_directions</span></code>, then separate each routes’s stats by trip direction.
Set the time series frequency according to the given frequency string;
max frequency is one minute (‘Min’).
Use the given YYYYMMDD date label as the date in the time series index.</p>
<p>Return a DataFrame time series version the following route stats for each route.</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">num_trips</span></code>: number of trips in service on the route
at any time within the time bin</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">num_trip_starts</span></code>: number of trips that start within
the time bin</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">num_trip_ends</span></code>: number of trips that end within the
time bin, ignoring trips that end past midnight</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">service_distance</span></code>: sum of the service distance accrued
during the time bin across all trips on the route;
measured in kilometers if <code class="docutils literal notranslate"><span class="pre">feed.dist_units</span></code> is metric;
otherwise measured in miles;</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">service_duration</span></code>: sum of the service duration accrued
during the time bin across all trips on the route;
measured in hours</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">service_speed</span></code>: <code class="docutils literal notranslate"><span class="pre">service_distance/service_duration</span></code>
for the route</p></li>
</ul>
<p>The columns are hierarchical (multi-indexed) with</p>
<ul class="simple">
<li><p>top level: name is <code class="docutils literal notranslate"><span class="pre">'indicator'</span></code>; values are
<code class="docutils literal notranslate"><span class="pre">'num_trip_starts'</span></code>, <code class="docutils literal notranslate"><span class="pre">'num_trip_ends'</span></code>, <code class="docutils literal notranslate"><span class="pre">'num_trips'</span></code>,
<code class="docutils literal notranslate"><span class="pre">'service_distance'</span></code>, <code class="docutils literal notranslate"><span class="pre">'service_duration'</span></code>, and
<code class="docutils literal notranslate"><span class="pre">'service_speed'</span></code></p></li>
<li><p>middle level: name is <code class="docutils literal notranslate"><span class="pre">'route_id'</span></code>;
values are the active routes</p></li>
<li><p>bottom level: name is <code class="docutils literal notranslate"><span class="pre">'direction_id'</span></code>; values are 0s and 1s</p></li>
</ul>
<p>If not <code class="docutils literal notranslate"><span class="pre">split_directions</span></code>, then don’t include the bottom level.</p>
<p>The time series has a timestamp index for a 24-hour period
sampled at the given frequency.
The maximum allowable frequency is 1 minute.
If <code class="docutils literal notranslate"><span class="pre">trip_stats_subset</span></code> is empty, then return an empty
DataFrame with the columns <code class="docutils literal notranslate"><span class="pre">'num_trip_starts'</span></code>,
<code class="docutils literal notranslate"><span class="pre">'num_trip_ends'</span></code>, <code class="docutils literal notranslate"><span class="pre">'num_trips'</span></code>, <code class="docutils literal notranslate"><span class="pre">'service_distance'</span></code>,
<code class="docutils literal notranslate"><span class="pre">'service_duration'</span></code>, and <code class="docutils literal notranslate"><span class="pre">'service_speed'</span></code>.</p>
<p class="rubric">Notes</p>
<ul class="simple">
<li><p>The time series is computed at a one-minute frequency, then
resampled at the end to the given frequency</p></li>
<li><p>Trips that lack start or end times are ignored, so the the
aggregate <code class="docutils literal notranslate"><span class="pre">num_trips</span></code> across the day could be less than the
<code class="docutils literal notranslate"><span class="pre">num_trips</span></code> column of <a class="reference internal" href="#gtfs_kit.routes.compute_route_stats_0" title="gtfs_kit.routes.compute_route_stats_0"><code class="xref py py-func docutils literal notranslate"><span class="pre">compute_route_stats_0()</span></code></a></p></li>
<li><p>All trip departure times are taken modulo 24 hours.
So routes with trips that end past 23:59:59 will have all
their stats wrap around to the early morning of the time series,
except for their <code class="docutils literal notranslate"><span class="pre">num_trip_ends</span></code> indicator.
Trip endings past 23:59:59 not binned so that resampling the
<code class="docutils literal notranslate"><span class="pre">num_trips</span></code> indicator works efficiently.</p></li>
<li><p>Note that the total number of trips for two consecutive time bins
t1 < t2 is the sum of the number of trips in bin t2 plus the
number of trip endings in bin t1.
Thus we can downsample the <code class="docutils literal notranslate"><span class="pre">num_trips</span></code> indicator by keeping
track of only one extra count, <code class="docutils literal notranslate"><span class="pre">num_trip_ends</span></code>, and can avoid
recording individual trip IDs.</p></li>
<li><p>All other indicators are downsampled by summing.</p></li>
<li><p>Raise a ValueError if <code class="docutils literal notranslate"><span class="pre">split_directions</span></code> and no non-NaN
direction ID values present</p></li>
</ul>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.routes.get_routes">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.routes.</span></span><span class="sig-name descname"><span class="pre">get_routes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">as_gdf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_utm</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_directions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pd.DataFrame</span></span></span><a class="headerlink" href="#gtfs_kit.routes.get_routes" title="Link to this definition">¶</a></dt>
<dd><p>Return <code class="docutils literal notranslate"><span class="pre">feed.routes</span></code> or a subset thereof.
If a YYYYMMDD date string is given, then restrict routes to only those active on
the date.
If a HH:MM:SS time string is given, possibly with HH > 23, then restrict routes
to only those active during the time.</p>
<p>Given a Feed, return a GeoDataFrame with all the columns of <code class="docutils literal notranslate"><span class="pre">feed.routes</span></code>
plus a geometry column of (Multi)LineStrings, each of which represents the
corresponding routes’s shape.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">as_gdf</span></code> and <code class="docutils literal notranslate"><span class="pre">feed.shapes</span></code> is not <code class="docutils literal notranslate"><span class="pre">None</span></code>,
then return a GeoDataFrame with all the columns of <code class="docutils literal notranslate"><span class="pre">feed.routes</span></code>
plus a geometry column of (Multi)LineStrings, each of which represents the
corresponding routes’s union of trip shapes.
The GeoDataFrame will have a local UTM CRS if <code class="docutils literal notranslate"><span class="pre">use_utm</span></code>; otherwise it will have
CRS WGS84.
If <code class="docutils literal notranslate"><span class="pre">split_directions</span></code> and <code class="docutils literal notranslate"><span class="pre">as_gdf</span></code>, then add the column <code class="docutils literal notranslate"><span class="pre">direction_id</span></code> and
split each route into the union of its direction 0 shapes
and the union of its direction 1 shapes.
If <code class="docutils literal notranslate"><span class="pre">as_gdf</span></code> and <code class="docutils literal notranslate"><span class="pre">feed.shapes</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, then raise a ValueError.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.routes.map_routes">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.routes.</span></span><span class="sig-name descname"><span class="pre">map_routes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">route_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">route_short_names</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color_palette</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">['#66c2a5',</span> <span class="pre">'#fc8d62',</span> <span class="pre">'#8da0cb',</span> <span class="pre">'#e78ac3',</span> <span class="pre">'#a6d854',</span> <span class="pre">'#ffd92f',</span> <span class="pre">'#e5c494',</span> <span class="pre">'#b3b3b3']</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">show_stops</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#gtfs_kit.routes.map_routes" title="Link to this definition">¶</a></dt>
<dd><p>Return a Folium map showing the given routes and (optionally) their stops.
At least one of <code class="docutils literal notranslate"><span class="pre">route_ids</span></code> and <code class="docutils literal notranslate"><span class="pre">route_short_names</span></code> must be given.
If both are given, then combine the two into a single set of routes.
If any of the given route IDs are not found in the feed, then raise a ValueError.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.routes.routes_to_geojson">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.routes.</span></span><span class="sig-name descname"><span class="pre">routes_to_geojson</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">route_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_directions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_stops</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#gtfs_kit.routes.routes_to_geojson" title="Link to this definition">¶</a></dt>
<dd><p>Return a GeoJSON FeatureCollection of MultiLineString features representing this Feed’s routes.
The coordinates reference system is the default one for GeoJSON,
namely WGS84.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">include_stops</span></code>, then include the route stops as Point features .
If an iterable of route IDs is given, then subset to those routes.
If the subset is empty, then return a FeatureCollection with an empty list of
features.
If the Feed has no shapes, then raise a ValueError.
If any of the given route IDs are not found in the feed, then raise a ValueError.</p>
</dd></dl>
</section>
<section id="module-gtfs_kit.shapes">
<span id="module-shapes"></span><h2>Module shapes<a class="headerlink" href="#module-gtfs_kit.shapes" title="Link to this heading">¶</a></h2>
<p>Functions about shapes.</p>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.shapes.append_dist_to_shapes">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.shapes.</span></span><span class="sig-name descname"><span class="pre">append_dist_to_shapes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></span><a class="headerlink" href="#gtfs_kit.shapes.append_dist_to_shapes" title="Link to this definition">¶</a></dt>
<dd><p>Calculate and append the optional <code class="docutils literal notranslate"><span class="pre">shape_dist_traveled</span></code> field in
<code class="docutils literal notranslate"><span class="pre">feed.shapes</span></code> in terms of the distance units <code class="docutils literal notranslate"><span class="pre">feed.dist_units</span></code>.
Return the resulting Feed.</p>
<p>As a benchmark, using this function on <a class="reference external" href="https://transitfeeds.com/p/trimet/43/1400947517">this Portland feed</a>
produces a <code class="docutils literal notranslate"><span class="pre">shape_dist_traveled</span></code> column that differs by at most
0.016 km in absolute value from of the original values.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.shapes.build_geometry_by_shape">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.shapes.</span></span><span class="sig-name descname"><span class="pre">build_geometry_by_shape</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">shape_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_utm</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#gtfs_kit.shapes.build_geometry_by_shape" title="Link to this definition">¶</a></dt>
<dd><p>Return a dictionary of the form
<shape ID> -> <Shapely LineString representing shape>.
If the Feed has no shapes, then return the empty dictionary.
If <code class="docutils literal notranslate"><span class="pre">use_utm</span></code>, then use local UTM coordinates; otherwise, use WGS84 coordinates.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.shapes.geometrize_shapes">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.shapes.</span></span><span class="sig-name descname"><span class="pre">geometrize_shapes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">shapes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_utm</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">GeoDataFrame</span></span></span><a class="headerlink" href="#gtfs_kit.shapes.geometrize_shapes" title="Link to this definition">¶</a></dt>
<dd><p>Given a GTFS shapes DataFrame, convert it to a GeoDataFrame of LineStrings
and return the result, which will no longer have the columns
<code class="docutils literal notranslate"><span class="pre">'shape_pt_sequence'</span></code>, <code class="docutils literal notranslate"><span class="pre">'shape_pt_lon'</span></code>,
<code class="docutils literal notranslate"><span class="pre">'shape_pt_lat'</span></code>, and <code class="docutils literal notranslate"><span class="pre">'shape_dist_traveled'</span></code>.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">use_utm</span></code>, then use local UTM coordinates for the geometries.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.shapes.get_shapes">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.shapes.</span></span><span class="sig-name descname"><span class="pre">get_shapes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">as_gdf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_utm</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">gpd.DataFrame</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#gtfs_kit.shapes.get_shapes" title="Link to this definition">¶</a></dt>
<dd><p>Get the shapes DataFrame for the given feed, which could be <code class="docutils literal notranslate"><span class="pre">None</span></code>.
If <code class="docutils literal notranslate"><span class="pre">as_gdf</span></code>, then return it as GeoDataFrame with a ‘geometry’ column
of linestrings and no ‘shape_pt_sequence’, ‘shape_pt_lon’, ‘shape_pt_lat’,
‘shape_dist_traveled’ columns.
The GeoDataFrame will have a UTM CRS if <code class="docutils literal notranslate"><span class="pre">use_utm</span></code>; otherwise it will have a
WGS84 CRS.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.shapes.get_shapes_intersecting_geometry">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.shapes.</span></span><span class="sig-name descname"><span class="pre">get_shapes_intersecting_geometry</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">geometry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">sg.base.BaseGeometry</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shapes_g</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">gpd.GeoDataFrame</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">as_gdf</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pd.DataFrame</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#gtfs_kit.shapes.get_shapes_intersecting_geometry" title="Link to this definition">¶</a></dt>
<dd><p>If the Feed has no shapes, then return None.
Otherwise, return the subset of <code class="docutils literal notranslate"><span class="pre">feed.shapes</span></code> that contains all shapes that
intersect the given Shapely WGS84 geometry, e.g. a Polygon or LineString.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">as_gdf</span></code>, then return the shapes as a GeoDataFrame.
Specifying <code class="docutils literal notranslate"><span class="pre">shapes_g</span></code> will skip the first step of the
algorithm, namely, geometrizing <code class="docutils literal notranslate"><span class="pre">feed.shapes</span></code>.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.shapes.shapes_to_geojson">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.shapes.</span></span><span class="sig-name descname"><span class="pre">shapes_to_geojson</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">shape_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#gtfs_kit.shapes.shapes_to_geojson" title="Link to this definition">¶</a></dt>
<dd><p>Return a GeoJSON FeatureCollection of LineString features
representing <code class="docutils literal notranslate"><span class="pre">feed.shapes</span></code>.
If the Feed has no shapes, then the features will be an empty list.
The coordinates reference system is the default one for GeoJSON,
namely WGS84.</p>
<p>If an iterable of shape IDs is given, then subset to those shapes.
If the subset is empty, then return a FeatureCollection with an empty list of
features.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.shapes.ungeometrize_shapes">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.shapes.</span></span><span class="sig-name descname"><span class="pre">ungeometrize_shapes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">shapes_g</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">GeoDataFrame</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">DataFrame</span></span></span><a class="headerlink" href="#gtfs_kit.shapes.ungeometrize_shapes" title="Link to this definition">¶</a></dt>
<dd><p>The inverse of <a class="reference internal" href="#gtfs_kit.shapes.geometrize_shapes" title="gtfs_kit.shapes.geometrize_shapes"><code class="xref py py-func docutils literal notranslate"><span class="pre">geometrize_shapes()</span></code></a>.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">shapes_g</span></code> is in UTM coordinates (has a UTM CRS property),
then convert those UTM coordinates back to WGS84 coordinates,
which is the standard for a GTFS shapes table.</p>
</dd></dl>
</section>
<section id="module-gtfs_kit.stop_times">
<span id="module-stop-times"></span><h2>Module stop_times<a class="headerlink" href="#module-gtfs_kit.stop_times" title="Link to this heading">¶</a></h2>
<p>Functions about stop times.</p>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.stop_times.append_dist_to_stop_times">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.stop_times.</span></span><span class="sig-name descname"><span class="pre">append_dist_to_stop_times</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></span><a class="headerlink" href="#gtfs_kit.stop_times.append_dist_to_stop_times" title="Link to this definition">¶</a></dt>
<dd><p>Calculate and append the optional <code class="docutils literal notranslate"><span class="pre">shape_dist_traveled</span></code> column in
<code class="docutils literal notranslate"><span class="pre">feed.stop_times</span></code> in terms of the distance units <code class="docutils literal notranslate"><span class="pre">feed.dist_units</span></code>.
Trips without shapes will have NaN distances.
Return the resulting Feed.
Uses <code class="docutils literal notranslate"><span class="pre">feed.shapes</span></code>, so if that is missing, then return the original feed.</p>
<p>This does not always give accurate results.
The algorithm works as follows.
Compute the <code class="docutils literal notranslate"><span class="pre">shape_dist_traveled</span></code> field by using Shapely to
measure the distance of a stop along its trip LineString.
If for a given trip this process produces a non-monotonically
increasing, hence incorrect, list of (cumulative) distances, then
fall back to estimating the distances as follows.</p>
<p>Set the first distance to 0, the last to the length of the trip shape,
and leave the remaining ones computed above.
Choose the longest increasing subsequence of that new set of
distances and use them and their corresponding departure times to linearly
interpolate the rest of the distances.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.stop_times.get_start_and_end_times">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.stop_times.</span></span><span class="sig-name descname"><span class="pre">get_start_and_end_times</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#gtfs_kit.stop_times.get_start_and_end_times" title="Link to this definition">¶</a></dt>
<dd><p>Return the first departure time and last arrival time
(HH:MM:SS time strings) listed in <code class="docutils literal notranslate"><span class="pre">feed.stop_times</span></code>, respectively.
Restrict to the given date (YYYYMMDD string) if specified.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.stop_times.get_stop_times">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.stop_times.</span></span><span class="sig-name descname"><span class="pre">get_stop_times</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pd.DataFrame</span></span></span><a class="headerlink" href="#gtfs_kit.stop_times.get_stop_times" title="Link to this definition">¶</a></dt>
<dd><p>Return <code class="docutils literal notranslate"><span class="pre">feed.stop_times</span></code>.
If a date (YYYYMMDD date string) is given, then subset the result to only those
stop times with trips active on the date.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.stop_times.stop_times_to_geojson">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.stop_times.</span></span><span class="sig-name descname"><span class="pre">stop_times_to_geojson</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">trip_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#gtfs_kit.stop_times.stop_times_to_geojson" title="Link to this definition">¶</a></dt>
<dd><p>Return a GeoJSON FeatureCollection of Point features
representing all the trip-stop pairs in <code class="docutils literal notranslate"><span class="pre">feed.stop_times</span></code>.
The coordinates reference system is the default one for GeoJSON,
namely WGS84.</p>
<p>For every trip, drop duplicate stop IDs within that trip.
In particular, a looping trip will lack its final stop.</p>
<p>If an iterable of trip IDs is given, then subset to those trips.
If some of the given trip IDs are not found in the feed, then raise a ValueError.</p>
</dd></dl>
</section>
<section id="module-gtfs_kit.stops">
<span id="module-stops"></span><h2>Module stops<a class="headerlink" href="#module-gtfs_kit.stops" title="Link to this heading">¶</a></h2>
<p>Functions about stops.</p>
<dl class="py data">
<dt class="sig sig-object py" id="gtfs_kit.stops.STOP_STYLE">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.stops.</span></span><span class="sig-name descname"><span class="pre">STOP_STYLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'color':</span> <span class="pre">'#fc8d62',</span> <span class="pre">'fill':</span> <span class="pre">'true',</span> <span class="pre">'fillOpacity':</span> <span class="pre">0.75,</span> <span class="pre">'radius':</span> <span class="pre">8,</span> <span class="pre">'weight':</span> <span class="pre">1}</span></em><a class="headerlink" href="#gtfs_kit.stops.STOP_STYLE" title="Link to this definition">¶</a></dt>
<dd><p>Leaflet circleMarker parameters for mapping stops</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.stops.build_geometry_by_stop">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.stops.</span></span><span class="sig-name descname"><span class="pre">build_geometry_by_stop</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">stop_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_utm</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#gtfs_kit.stops.build_geometry_by_stop" title="Link to this definition">¶</a></dt>
<dd><p>Return a dictionary of the form <stop ID> -> <Shapely Point representing stop>.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.stops.build_stop_timetable">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.stops.</span></span><span class="sig-name descname"><span class="pre">build_stop_timetable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">stop_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dates</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pd.DataFrame</span></span></span><a class="headerlink" href="#gtfs_kit.stops.build_stop_timetable" title="Link to this definition">¶</a></dt>
<dd><p>Return a DataFrame containing the timetable for the given stop ID
and dates (YYYYMMDD date strings)</p>
<p>Return a DataFrame whose columns are all those in <code class="docutils literal notranslate"><span class="pre">feed.trips</span></code> plus those in
<code class="docutils literal notranslate"><span class="pre">feed.stop_times</span></code> plus <code class="docutils literal notranslate"><span class="pre">'date'</span></code>, and the stop IDs are restricted to the given
stop ID.
The result is sorted by date then departure time.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.stops.build_zero_stop_time_series">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.stops.</span></span><span class="sig-name descname"><span class="pre">build_zero_stop_time_series</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">date_label</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'20010101'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">freq</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'5Min'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_directions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pd.DataFrame</span></span></span><a class="headerlink" href="#gtfs_kit.stops.build_zero_stop_time_series" title="Link to this definition">¶</a></dt>
<dd><p>Return a stop time series with the same index and hierarchical columns
as output by the function <a class="reference internal" href="#gtfs_kit.stops.compute_stop_time_series_0" title="gtfs_kit.stops.compute_stop_time_series_0"><code class="xref py py-func docutils literal notranslate"><span class="pre">compute_stop_time_series_0()</span></code></a>,
but fill it full of zero values.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.stops.compute_stop_activity">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.stops.</span></span><span class="sig-name descname"><span class="pre">compute_stop_activity</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">dates</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pd.DataFrame</span></span></span><a class="headerlink" href="#gtfs_kit.stops.compute_stop_activity" title="Link to this definition">¶</a></dt>
<dd><p>Mark stops as active or inactive on the given dates (YYYYMMDD date strings).
A stop is <em>active</em> on a given date if some trips that starts on the
date visits the stop (possibly after midnight).</p>
<p>Return a DataFrame with the columns</p>
<ul class="simple">
<li><p>stop_id</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">dates[0]</span></code>: 1 if the stop has at least one trip visiting it
on <code class="docutils literal notranslate"><span class="pre">dates[0]</span></code>; 0 otherwise</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">dates[1]</span></code>: 1 if the stop has at least one trip visiting it
on <code class="docutils literal notranslate"><span class="pre">dates[1]</span></code>; 0 otherwise</p></li>
<li><p>etc.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">dates[-1]</span></code>: 1 if the stop has at least one trip visiting it
on <code class="docutils literal notranslate"><span class="pre">dates[-1]</span></code>; 0 otherwise</p></li>
</ul>
<p>If all dates lie outside the Feed period, then return an empty DataFrame.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="gtfs_kit.stops.compute_stop_stats">
<span class="sig-prename descclassname"><span class="pre">gtfs_kit.stops.</span></span><span class="sig-name descname"><span class="pre">compute_stop_stats</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">feed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#gtfs_kit.feed.Feed" title="gtfs_kit.feed.Feed"><span class="pre">Feed</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">dates</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stop_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headway_start_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'07:00:00'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headway_end_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'19:00:00'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_directions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">pd.DataFrame</span></span></span><a class="headerlink" href="#gtfs_kit.stops.compute_stop_stats" title="Link to this definition">¶</a></dt>
<dd><p>Compute stats for all stops for the given dates (YYYYMMDD date strings).
Optionally, restrict to the stop IDs given.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">split_directions</span></code>, then separate the stop stats by direction (0 or 1)
of the trips visiting the stops.
Use the headway start and end times to specify the time period for computing
headway stats.</p>
<p>Return a DataFrame with the columns</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">'date'</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'stop_id'</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'direction_id'</span></code>: present if and only if <code class="docutils literal notranslate"><span class="pre">split_directions</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'num_routes'</span></code>: number of routes visiting the stop
(in the given direction) on the date</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'num_trips'</span></code>: number of trips visiting stop
(in the givin direction) on the date</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'max_headway'</span></code>: maximum of the durations (in minutes)
between trip departures at the stop between
<code class="docutils literal notranslate"><span class="pre">headway_start_time</span></code> and <code class="docutils literal notranslate"><span class="pre">headway_end_time</span></code> on the date</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'min_headway'</span></code>: minimum of the durations (in minutes) mentioned
above</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">'mean_headway'</span></code>: mean of the durations (in minutes) mentioned