gtfsparser

README

go gtfsparser

A complete*, easy to use parsing library for GTFS data. Implemented in go. Accepts folders containing GTFS files and ZIPs. Feeds are validated during parsing. ID references are transformed into pointer references where appropriate.

Usage

feed := gtfsparser.NewFeed()
error := feed.Parse("sample-feed.zip")

See feed.go for exported fields.

Example

Parsing of the GTFS example feed:

import (
	"github.com/geops/gtfsparser"
	"fmt"
)

func main() {
	feed := gtfsparser.NewFeed()

	feed.Parse("sample-feed.zip")

	fmt.Printf("Done, parsed %d agencies, %d stops, %d routes, %d trips, %d fare attributes\n\n",
		len(feed.Agencies), len(feed.Stops), len(feed.Routes), len(feed.Trips), len(feed.FareAttributes))

	for k, v := range feed.Stops {
        fmt.Printf("[%s] %s (@ %f,%f)\n", k, v.Name, v.Lat, v.Lon)
    }
}

Output

Done, parsed 1 agencies, 9 stops, 5 routes, 11 trips, 2 fare attributes

[BULLFROG] Bullfrog (Demo) (@ 36.881081,-116.817970)
[NADAV] North Ave / D Ave N (Demo) (@ 36.914894,-116.768211)
[NANAA] North Ave / N A Ave (Demo) (@ 36.914944,-116.761475)
[AMV] Amargosa Valley (Demo) (@ 36.641495,-116.400940)
[FUR_CREEK_RES] Furnace Creek Resort (Demo) (@ 36.425289,-117.133163)
[BEATTY_AIRPORT] Nye County Airport (Demo) (@ 36.868446,-116.784584)
[STAGECOACH] Stagecoach Hotel & Casino (Demo) (@ 36.915684,-116.751678)
[DADAN] Doing Ave / D Ave N (Demo) (@ 36.909489,-116.768242)
[EMSI] E Main St / S Irving St (Demo) (@ 36.905697,-116.762177)

*Known restrictions

Validation may not be 100% complete. Tests are missing.

License

GPL v2, see LICENSE

Documentation

Index

• func Distance(lat1, lon1, lat2, lon2 float64) float64
• func LoadOsmMapper(file string) (map[string][]osmNode, error)
• type CsvParser
  • func NewCsvParser(file io.Reader) CsvParser
  • func (p *CsvParser) ParseCsvLine() []string
  • func (p *CsvParser) ParseHeader()
  • func (p *CsvParser) ParseRecord() map[string]string
• type Feed
  • func GetGTFSFeed(file string) (*Feed, error)
  • func NewFeed() *Feed
  • func (f *Feed) GetGTFSBoundingBox() (minLat, minLon, maxLat, maxLon float32, err error)
  • func (feed Feed) MatchFeedStops(osmMapper map[string][]osmNode) map[gtfs.Stop]osmNode
  • func (feed *Feed) Parse(path string) error
• type GeoPoint
• type ParseError
  • func (e ParseError) Error() string

Functions

func Distance

func Distance(lat1, lon1, lat2, lon2 float64) float64

func LoadOsmMapper

func LoadOsmMapper(file string) (map[string][]osmNode, error)

Types

type CsvParser

type CsvParser struct {
	Curline int
	// contains filtered or unexported fields
}

func NewCsvParser

func NewCsvParser(file io.Reader) CsvParser

func (*CsvParser) ParseCsvLine

func (p *CsvParser) ParseCsvLine() []string

func (*CsvParser) ParseHeader

func (p *CsvParser) ParseHeader()

func (*CsvParser) ParseRecord

func (p *CsvParser) ParseRecord() map[string]string

type Feed

type Feed struct {
	Agencies       map[string]*gtfs.Agency
	Stops          map[string]*gtfs.Stop
	Routes         map[string]*gtfs.Route
	Trips          map[string]*gtfs.Trip
	Services       map[string]*gtfs.Service
	FareAttributes map[string]*gtfs.FareAttribute
	Shapes         map[string]*gtfs.Shape
	Transfers      []*gtfs.Transfer
	FeedInfos      []*gtfs.FeedInfo
	// contains filtered or unexported fields
}

func GetGTFSFeed

func GetGTFSFeed(file string) (*Feed, error)

func NewFeed

func NewFeed() *Feed

Create a new, empty feed

func (*Feed) GetGTFSBoundingBox

func (f *Feed) GetGTFSBoundingBox() (minLat, minLon, maxLat, maxLon float32, err error)

GetGTFSBoundingBox - return min and max points for rectangle of stops in GTFS Feed

func (Feed) MatchFeedStops

func (feed Feed) MatchFeedStops(osmMapper map[string][]osmNode) map[gtfs.Stop]osmNode

func (*Feed) Parse

func (feed *Feed) Parse(path string) error

Parse the GTFS data in the specified folder into the feed

type GeoPoint

type GeoPoint struct {
	Lon float32
	Lat float32
}

GeoPoint Representation of point on Earth

type ParseError

type ParseError struct {
	// contains filtered or unexported fields
}

func (ParseError) Error

func (e ParseError) Error() string