gtfs

package module
v0.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 19, 2021 License: GPL-3.0 Imports: 6 Imported by: 0

README

go-gtfs

Load GTFS files in golang

godoc for artonge/go-gtfs

Build Status cover.run go goreportcard for artonge/go-gtfs

Sourcegraph for artonge/go-gtfs

Install

go get github.com/artonge/go-gtfs

Examples

Load one directory containing GTFS files:

path/to/gtfs_files
├── agency.txt
├── calendar_dates.txt
├── calendar.txt
├── routes.txt
├── stops.txt
├── stop_times.txt
├── transfers.txt
└── trips.txt

g, err := gtfs.Load("path/to/gtfs_files", nil)

Load a directory containing sub directories containing GTFS files:

path/to/gtfs_directories
├── gtfs1
│   ├── agency.txt
│   ├── calendar_dates.txt
│   ├── routes.txt
│   ├── stops.txt
│   ├── stop_times.txt
│   ├── transfers.txt
│   └── trips.txt
└── gtfs2
    ├── agency.txt
    ├── calendar_dates.txt
    ├── calendar.txt
    ├── routes.txt
    ├── stops.txt
    ├── stop_times.txt
    ├── transfers.txt
    └── trips.txt


gs, err := gtfs.LoadSplitted("path/to/gtfs_directories", nil)

You can then access the data through the GTFS structure. That structure contains arrays of approriate structures for each files.

type GTFS struct {
	Path       string // The path to the containing directory
	Agency     Agency
	Routes     []Route
	Stops      []Stop
	StopsTimes []Stop
	Trips      []Trip
	Calendars  []Calendar
	Transfers  []Transfer
}

type Route struct {
	ID        string `csv:"route_id"`
	AgencyID  string `csv:"agency_id"`
	ShortName string `csv:"route_short_name"`
	LongName  string `csv:"route_long_name"`
	Type      int    `csv:"route_type"`
	Desc      string `csv:"route_url"`
	URL       string `csv:"route_desc"`
	Color     string `csv:"route_color"`
	TextColor string `csv:"route_text_color"`
}

...

Contributions

Pull requests are welcome ! :)

Documentation

Index

Constants

View Source 
const (
	RouteTypeTram      = 0
	RouteTypeSubway    = 1
	RouteTypeRail      = 2
	RouteTypeBus       = 3
	RouteTypeFerry     = 4
	RouteTypeCableCar  = 5
	RouteTypeGondola   = 6
	RouteTypeFunicular = 7

	ExceptionTypeAdded   = 1
	ExceptionTypeRemoved = 2
)

Const used in GTFS

Variables

This section is empty.

Functions

func Dump 

func Dump(g *GTFS, dirPath string, filter map[string]bool) error

Dump GTFS data to an already existing directory @param g: GTFS struct to dump @param dirPath: Target directory @param filter: same as for load function @return error

Types

type Agency 

type Agency struct {
	ID       string `csv:"agency_id"`
	Name     string `csv:"agency_name"`
	URL      string `csv:"agency_url"`
	Timezone string `csv:"agency_timezone"`
	Language string `csv:"agency_lang"`
	Phone    string `csv:"agency_phone"`
	FareURL  string `csv:"agency_fare_url"`
	Email    string `csv:"agency_email"`
}

Agency -

type Attribution 

type Attribution struct {
	ID               string `csv:"attribution_id"`
	AgencyID         string `csv:"agency_id"`
	RouteID          string `csv:"route_id"`
	TripID           string `csv:"trip_id"`
	OrganizationName string `csv:"organization_name"`
	IsProducer       int    `csv:"is_producer"`
	IsOperator       int    `csv:"is_operator"`
	IsAuthority      int    `csv:"is_authority"`
	URL              string `csv:"attribution_url"`
	Email            string `csv:"attribution_email"`
	Phone            string `csv:"attribution_phone"`
}

Attribution -

type Calendar 

type Calendar struct {
	ServiceID string `csv:"service_id"`
	Monday    int    `csv:"monday"`
	Tuesday   int    `csv:"tuesday"`
	Wednesday int    `csv:"wednesday"`
	Thursday  int    `csv:"thursday"`
	Friday    int    `csv:"friday"`
	Saturday  int    `csv:"saturday"`
	Sunday    int    `csv:"sunday"`
	StartDate string `csv:"start_date"`
	EndDate   string `csv:"end_date"`
}

Calendar -

type CalendarDate 

type CalendarDate struct {
	ServiceID     string `csv:"service_id"`
	Date          string `csv:"date"`
	ExceptionType int    `csv:"exception_type"`
}

CalendarDate -

type FareAttribute 

type FareAttribute struct {
	ID               string  `csv:"fare_id"`
	Price            float64 `csv:"price"`
	CurrencyType     string  `csv:"currency_type"`
	PaymentMethod    int     `csv:"payment_method"`
	Transfers        int     `csv:"transfers"`
	AgencyID         string  `csv:"agency_id"`
	TransferDuration int     `csv:"transfer_duration"`
}

FareAttribute -

type FareRule 

type FareRule struct {
	FareID        string `csv:"fare_id"`
	RouteID       string `csv:"route_id"`
	OriginID      string `csv:"origin_id"`
	DestinationID string `csv:"destination_id"`
	ContainsID    string `csv:"contains_id"`
}

FareRule -

type FeedInfo 

type FeedInfo struct {
	PublisherName    string `csv:"feed_publisher_name"`
	PublisherURL     string `csv:"feed_publisher_url"`
	FeedLang         string `csv:"feed_lang"`
	DefaultLang      string `csv:"default_lang"`
	FeedStartDate    string `csv:"feed_start_date"`
	FeedEndDate      string `csv:"feed_end_date"`
	FeedVersion      string `csv:"feed_version"`
	FeedContactEmail string `csv:"feed_contact_email"`
	FeedContactURL   string `csv:"feed_contact_url"`
}

FeedInfo -

type Frequency 

type Frequency struct {
	TripID      string `csv:"trip_id"`
	StartTime   string `csv:"start_time"`
	EndTime     string `csv:"end_time"`
	HeadwaySecs int    `csv:"headway_secs"`
	ExactTimes  int    `csv:"exact_times"`
}

Frequency -

type GTFS 

type GTFS struct {
	Path           string // The path to the containing directory
	Agencies       []Agency
	Routes         []Route
	Stops          []Stop
	StopsTimes     []StopTime
	Trips          []Trip
	Calendars      []Calendar
	CalendarDates  []CalendarDate
	Transfers      []Transfer
	Shapes         []Shape
	FareAttributes []FareAttribute
	FareRules      []FareRule
	Frequencies    []Frequency
	Pathways       []Pathway
	Levels         []Level
	FeedInfo       []FeedInfo
	Translations   []Translation
	Attributions   []Attribution
	TripNotes      []TripNotes
}

GTFS -

func Load 

func Load(dirPath string, filter map[string]bool) (*GTFS, error)

Load - load GTFS files @param dirPath: the directory containing the GTFS @param filter: It is possible to partialy load the gtfs files If you don't want to load all the files, add an param to the Load function containing only the files that must be loaded Example: Load("path/to/gtfs", map[string]bool{"routes": true}) @return a filled GTFS or an error

func LoadSplitted 

func LoadSplitted(dirPath string, filter map[string]bool) ([]*GTFS, error)

LoadSplitted - load splitted GTFS files ==> When GTFS are splitted into sub directories @param dirPath: the directory containing the sub GTFSs @param filter: see Load function @return an array of filled GTFS or an error

type Level 

type Level struct {
	ID    string  `csv:"level_id"`
	Index float64 `csv:"level_index"`
	Name  string  `csv:"level_name"`
}

Levels -

type Pathway 

type Pathway struct {
	ID                   string  `csv:"pathway_id"`
	FromStopID           string  `csv:"from_stop_id"`
	ToStopID             string  `csv:"to_stop_id"`
	PathwayMode          int     `csv:"pathway_mode"`
	IsBidirectional      int     `csv:"is_bidirectional"`
	Length               float64 `csv:"length"`
	TraversalTime        int     `csv:"traversal_time"`
	StairCount           int     `csv:"stair_count"`
	MaxSlope             float64 `csv:"max_slope"`
	MinWidth             float64 `csv:"min_width"`
	SignpostedAs         string  `csv:"signposted_as"`
	ReversedSignpostedAs string  `csv:"reversed_signposted_as"`
}

Pathway -

type Route 

type Route struct {
	ID        string `csv:"route_id"`
	AgencyID  string `csv:"agency_id"`
	ShortName string `csv:"route_short_name"`
	LongName  string `csv:"route_long_name"`
	Type      int    `csv:"route_type"`
	Desc      string `csv:"route_url"`
	URL       string `csv:"route_desc"`
	Color     string `csv:"route_color"`
	TextColor string `csv:"route_text_color"`
	SortOrder int    `csv:"route_sort_order"`
}

Route -

type Shape 

type Shape struct {
	ID               string  `csv:"shape_id"`
	Sequence         int     `csv:"shape_pt_sequence"`
	Latitude         float64 `csv:"shape_pt_lat"`
	Longitude        float64 `csv:"shape_pt_lon"`
	DistanceTraveled float64 `csv:"shape_dist_traveled"`
}

Shape -

type Stop 

type Stop struct {
	ID                 string  `csv:"stop_id"`
	Code               string  `csv:"stop_code"`
	Name               string  `csv:"stop_name"`
	Description        string  `csv:"stop_desc"`
	Latitude           float64 `csv:"stop_lat"`
	Longitude          float64 `csv:"stop_lon"`
	ZoneID             string  `csv:"zone_id"`
	URL                string  `csv:"stop_url"`
	Timezone           string  `csv:"stop_timezone"`
	Type               string  `csv:"location_type"`
	Parent             string  `csv:"parent_station"`
	WheelchairBoarding int     `csv:"wheelchair_boarding"`
	LevelID            string  `csv:"level_id"`
	PlatformCode       string  `csv:"platform_code"`
}

Stop -

type StopTime 

type StopTime struct {
	StopID            string  `csv:"stop_id"`
	StopSeq           int     `csv:"stop_sequence"`
	StopHeadSign      string  `csv:"stop_headsign"`
	TripID            string  `csv:"trip_id"`
	ShapeDistTraveled float64 `csv:"shape_dist_traveled"`
	DepartureTime     string  `csv:"departure_time"`
	ArrivalTime       string  `csv:"arrival_time"`
	PickupType        int     `csv:"pickup_type"`
	DropOffType       int     `csv:"drop_off_type"`
	TimePoint         int     `csv:"timepoint"`
}

StopTime -

type Transfer 

type Transfer struct {
	FromStopID string `csv:"from_stop_id"`
	ToStopID   string `csv:"to_stop_id"`
	Type       int    `csv:"transfer_type"`
	MinTime    int    `csv:"min_transfer_time"`
}

Transfer -

type Translation 

type Translation struct {
	TableName   string `csv:"table_name"`
	FieldName   string `csv:"field_name"`
	Language    string `csv:"language"`
	Translation string `csv:"translation"`
	RecordID    string `csv:"record_id"`
	RecordSubID string `csv:"record_sub_id"`
	FieldValue  string `csv:"field_value"`
}

Translation -

type Trip 

type Trip struct {
	ID                   string `csv:"trip_id"`
	ShortName            string `csv:"trip_short_name"`
	RouteID              string `csv:"route_id"`
	ServiceID            string `csv:"service_id"`
	ShapeID              string `csv:"shape_id"`
	DirectionID          string `csv:"direction_id"`
	Headsign             string `csv:"trip_headsign"`
	BlockID              string `csv:"block_id"`
	WheelchairAccessible int    `csv:"wheelchair_accessible"`
	BikesAllowed         int    `csv:"bikes_allowed"`
}

Trip -

type TripNotes added in v0.1.1 

type TripNotes struct {
	TripID           string `csv:"trip_id"`
	Abbreviation     string `csv:"abbreviation"`
	Description      string `csv:"description"`
	Language         string `csv:"lang"`
	FromStopID       string `csv:"from_stop_id"`
	ToStopID         string `csv:"to_stop_id"`
	FromStopSequence int    `csv:"from_stop_sequence"`
	ToStopSequence   int    `csv:"to_stop_sequence"`
}

TripNotes is an optional, non-standard file for adding notes to individual trips.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.