UrbanAccess

https://udst.github.io/urbanaccess/
Admin
A tool for computing GTFS transit and OSM pedestrian networks for accessibility analysis.
Tokens:12,733
Snippets:152
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install UrbanAccess for Development

Source: https://udst.github.io/urbanaccess/installation.html

Install UrbanAccess in development mode from a cloned repository. This is recommended for developers contributing to the project.

```bash
python setup.py develop

```

--------------------------------

### Install UrbanAccess using Pip

Source: https://udst.github.io/urbanaccess/installation.html

Use this command to install the latest release of UrbanAccess from PyPI if you are using Pip.

```bash
pip install urbanaccess

```

--------------------------------

### Install UrbanAccess using Conda Forge

Source: https://udst.github.io/urbanaccess/installation.html

Use this command to install the latest release of UrbanAccess if you are using the Conda package manager.

```bash
conda install urbanaccess -c conda-forge

```

--------------------------------

### Run Pandana Aggregation Query

Source: https://udst.github.io/urbanaccess/pandana.html

Perform an aggregation query to calculate accessibility metrics. This example sums the 'jobs' variable within a 45-minute linear decay travel time.

```python
jobs_45 = transit_ped_net.aggregate(45, type='sum', decay='linear', name='jobs')

```

--------------------------------

### Add Conda Forge Channel

Source: https://udst.github.io/urbanaccess/_sources/installation.rst.txt

Add 'conda-forge' as a backup channel to your Conda configuration for future installations.

```bash
conda config --append channels conda-forge
```

--------------------------------

### Run Pandana Nearest POI Query

Source: https://udst.github.io/urbanaccess/pandana.html

Query for the nearest points of interest (POIs) within a specified travel time. This example finds the nearest 'parks' within 45 minutes, limiting to 2 POIs and setting `max_distance` to 0.

```python
nearest_parks = transit_ped_net.nearest_pois(distance=45, category="parks", num_pois=2, max_distance=0)

```

--------------------------------

### Add Conda Forge Channel

Source: https://udst.github.io/urbanaccess/installation.html

Permanently add 'conda-forge' as a channel to your Conda configuration for future installations.

```bash
conda config --append channels conda-forge

```

--------------------------------

### urbanaccess.config.settings

Source: https://udst.github.io/urbanaccess/_sources/utilities.rst.txt

Access global configuration settings.

```APIDOC
## Global Configuration Settings

### Description
Global configuration settings can be accessed and modified using the `settings` object.

### Usage
```python
import urbanaccess

# Access settings
print(urbanaccess.config.settings.default_crs)

# Modify settings (example)
urbanaccess.config.settings.default_crs = "EPSG:4326"
```
```

--------------------------------

### urbanaccess.config.urbanaccess_config.from_yaml

Source: https://udst.github.io/urbanaccess/utilities.html

Create an urbanaccess_config instance from a saved YAML configuration file.

```APIDOC
## urbanaccess.config.urbanaccess_config.from_yaml

### Description
Create a urbanaccess_config instance from a saved YAML configuration.

### Parameters

#### Path Parameters
- **configdir** (str, optional) - Description: Directory to load a YAML file.
- **yamlname** (str or file like, optional) - Description: File name from which to load a YAML file.

### Returns

- **urbanaccess_config** - Description: An instance of urbanaccess_config.
```

--------------------------------

### from_yaml()

Source: https://udst.github.io/urbanaccess/genindex.html

Initializes configuration or data from a YAML source. This is a class method for urbanaccess_config and urbanaccess_gtfsfeeds.

```APIDOC
## from_yaml()

### Description
Initializes configuration or data from a YAML source.

### Method
(This is a class method for urbanaccess.config.urbanaccess_config and urbanaccess.gtfsfeeds.urbanaccess_gtfsfeeds)

### Parameters
(Parameters not specified in the source)

### Request Example
(Not specified in the source)

### Response
(Not specified in the source)
```

--------------------------------

### urbanaccess.osm.load.ua_network_from_bbox

Source: https://udst.github.io/urbanaccess/_sources/data_loaders.rst.txt

Download OSM street network nodes and edges.

```APIDOC
## urbanaccess.osm.load.ua_network_from_bbox

### Description
Downloads OpenStreetMap (OSM) street network nodes and edges based on a bounding box.

### Parameters
This function does not appear to have any documented parameters.
```

--------------------------------

### ua_network_from_bbox()

Source: https://udst.github.io/urbanaccess/genindex.html

Creates a network model using bounding box coordinates. This function is part of the urbanaccess.osm.load module.

```APIDOC
## ua_network_from_bbox()

### Description
Creates a network model using bounding box coordinates.

### Method
(This is a function in the urbanaccess.osm.load module)

### Parameters
(Parameters not specified in the source)

### Request Example
(Not specified in the source)

### Response
(Not specified in the source)
```

--------------------------------

### urbanaccess.osm.network.create_osm_net

Source: https://udst.github.io/urbanaccess/integrated_network.html

Creates a travel time weight network graph in units of minutes from openstreetmap nodes and edges.

```APIDOC
## create_osm_net

### Description
Create a travel time weight network graph in units of minutes from openstreetmap nodes and edges.

### Method
`urbanaccess.osm.network.create_osm_net`

### Parameters
#### Path Parameters
- **osm_edges** (pandas.DataFrame) - Required - osm edge dataframe
- **osm_nodes** (pandas.DataFrame) - Required - osm node dataframe

#### Optional Parameters
- **travel_speed_mph** (int) - Optional - travel speed to use to calculate travel time across a distance on a edge. units are in miles per hour (MPH). Defaults to 3 MPH.
- **network_type** (str) - Optional - default is ‘walk’ for the osm pedestrian network. this string is used to label the osm network once it is integrated with the transit network.

### Returns
- **ua_network** (object) - urbanaccess_network object with osm_edges and osm_nodes dataframes.
  - **ua_network.osm_edges** (pandas.DataFrame)
  - **ua_network.osm_nodes** (pandas.DataFrame)
```

--------------------------------

### Download and Load OpenStreetMap Data

Source: https://udst.github.io/urbanaccess/_sources/data_loaders.rst.txt

Download OpenStreetMap street network nodes and edges using a bounding box.

```python
from urbanaccess.osm import load

load.ua_network_from_bbox(bbox=[-74.0, 40.7, -73.9, 40.8])

```

--------------------------------

### urbanaccess.gtfsfeeds.urbanaccess_gtfsfeeds.from_yaml

Source: https://udst.github.io/urbanaccess/data_loaders.html

Creates an urbanaccess_gtfsfeeds instance from a saved YAML file.

```APIDOC
## from_yaml(gtfsfeeddir='data/gtfsfeeds', yamlname='gtfsfeeds.yaml')

### Description
Create a urbanaccess_gtfsfeeds instance from a saved YAML.

### Parameters

#### gtfsfeeddir str, optional

Directory to load a YAML file.

#### yamlname str or file like, optional

File name from which to load a YAML file.

### Returns

urbanaccess_gtfsfeeds
```

--------------------------------

### Create Transit Network from GTFS Feeds

Source: https://udst.github.io/urbanaccess/integrated_network.html

Generates a transit network graph with travel time impedance in minutes from GTFS data. Specify the day, time range, and optionally use existing stop times or save processed GTFS files.

```python
urbanaccess.gtfs.network.create_transit_net(gtfsfeeds_dfs, day, timerange, calendar_dates_lookup=None, overwrite_existing_stop_times_int=False, use_existing_stop_times_int=False, save_processed_gtfs=False, save_dir='data', save_filename=None)
```

--------------------------------

### urbanaccess.config.urbanaccess_config

Source: https://udst.github.io/urbanaccess/_sources/utilities.rst.txt

Class for managing urbanaccess configuration.

```APIDOC
## urbanaccess_config Class

### Description
The `urbanaccess_config` class provides methods to change the global configuration settings. By default, these settings are already set, but they can be modified using the functions within this class.

### Methods

#### `set_default_crs(crs)`

Sets the default Coordinate Reference System (CRS) for urbanaccess.

- **crs** (str) - The CRS to set (e.g., "EPSG:4326").

#### `set_default_network_type(network_type)`

Sets the default network type for urbanaccess.

- **network_type** (str) - The network type to set (e.g., "walk", "drive").

#### `set_cache_path(path)`

Sets the path for the urbanaccess cache.

- **path** (str) - The directory path for the cache.

### Usage Example
```python
import urbanaccess

# Set a new default CRS
urbanaccess.config.urbanaccess_config.set_default_crs("EPSG:3857")

# Set a different default network type
urbanaccess.config.urbanaccess_config.set_default_network_type("bike")

# Set a custom cache path
urbanaccess.config.urbanaccess_config.set_cache_path("/path/to/my/cache")
```
```

--------------------------------

### urbanaccess.gtfs.network.create_transit_net

Source: https://udst.github.io/urbanaccess/integrated_network.html

Creates a travel time weight network graph in units of minutes from GTFS data.

```APIDOC
## create_transit_net

### Description
Create a travel time weight network graph in units of minutes from GTFS data.

### Method
`urbanaccess.gtfs.network.create_transit_net`

### Parameters
#### Path Parameters
- **gtfsfeeds_dfs** (object) - Required - gtfsfeeds_dfs object with DataFrames of stops, routes, trips, stop_times, calendar, calendar_dates (optional) and stop_times_int (optional)
- **day** (string) - Required - day of the week to extract transit schedule from that corresponds to the day in the GTFS calendar. Accepted values: {‘friday’, ‘monday’, ‘saturday’, ‘sunday’, ‘thursday’, ‘tuesday’, ‘wednesday’}
- **timerange** (list) - Required - time range to extract transit schedule from in a list with time 1 and time 2. Must follow format of a 24 hour clock for example: 08:00:00 or 17:00:00

#### Optional Parameters
- **calendar_dates_lookup** (dict) - Optional - dictionary of the lookup column (key) as a string and corresponding string (value) as string or list of strings to use to subset trips using the calendar_dates DataFrame.
- **overwrite_existing_stop_times_int** (bool) - Optional - if true, and if there is an existing stop_times_int DataFrame stored in the gtfsfeeds_dfs object it will be overwritten
- **use_existing_stop_times_int** (bool) - Optional - if true, and if there is an existing stop_times_int DataFrame for the same time period stored in the gtfsfeeds_dfs object it will be used instead of re-calculated
- **save_processed_gtfs** (bool) - Optional - if true, all processed GTFS DataFrames will be stored to disk in a hdf5 file
- **save_dir** (str) - Optional - directory to save the hdf5 file
- **save_filename** (str) - Optional - name to save the hdf5 file as

### Returns
- **ua_network** (object) - urbanaccess_network object with transit_edges and transit_nodes dataframes.
  - **ua_network.transit_edges** (pandas.DataFrame)
  - **ua_network.transit_nodes** (pandas.DataFrame)
```

--------------------------------

### Create Transit Network

Source: https://udst.github.io/urbanaccess/_sources/integrated_network.rst.txt

Creates a transit network from loaded GTFS feeds, calculating travel time impedance.

```APIDOC
## create_transit_net

### Description
Creates a transit network from the loaded GTFS feeds with travel time impedance.

### Function Signature
`urbanaccess.gtfs.network.create_transit_net()`
```

--------------------------------

### create_osm_net()

Source: https://udst.github.io/urbanaccess/genindex.html

Creates a network model from OpenStreetMap data. This function is part of the urbanaccess.osm.network module.

```APIDOC
## create_osm_net()

### Description
Creates a network model from OpenStreetMap data.

### Method
(This is a function in the urbanaccess.osm.network module)

### Parameters
(Parameters not specified in the source)

### Request Example
(Not specified in the source)

### Response
(Not specified in the source)
```

--------------------------------

### ua_network_from_bbox

Source: https://udst.github.io/urbanaccess/data_loaders.html

Creates a graph network (nodes and edges) from a specified bounding box, compatible with Pandana for network analysis. Supports different network types like 'walk' and 'drive'.

```APIDOC
## ua_network_from_bbox

### Description
Make a graph network (nodes and edges) from a bounding lat/lon box that is compatible with the network analysis tool Pandana.

### Parameters
#### Path Parameters
- **lat_min** (float) - Southern latitude of bounding box.
- **lng_min** (float) - Eastern longitude of bounding box.
- **lat_max** (float) - Northern latitude of bounding box.
- **lng_max** (float) - Western longitude of bounding box.

#### Query Parameters
- **bbox** (tuple) - Bounding box formatted as a 4 element tuple: (lng_max, lat_min, lng_min, lat_max). Example: (-122.304611,37.798933,-122.263412,37.822802). A bbox can be extracted for an area using the CSV format bbox from http://boundingbox.klokantech.com/.
- **network_type** (string) - Optional. Specify the network type where value of ‘walk’ includes roadways where pedestrians are allowed and pedestrian pathways and ‘drive’ includes driveable roadways. Default is walk.
- **timeout** (int) - Optional. The timeout interval for requests and to pass to Overpass API.
- **memory** (int) - Optional. Server memory allocation size for the query, in bytes. If none, server will use its default allocation size.
- **max_query_area_size** (float) - Optional. Max area for any part of the geometry, in the units the geometry is in: any polygon bigger will get divided up for multiple queries to Overpass API (default is 50,000 * 50,000 units (ie, 50km x 50km in area, if units are meters)).
- **remove_lcn** (bool) - Optional. Remove low connectivity nodes from the resulting network. This ensures the resulting network does not have nodes that are unconnected from the rest of the larger network.

### Returns
- **nodesfinal** (pandas.DataFrame) - Final nodes DataFrame.
- **edgesfinal** (pandas.DataFrame) - Final edges DataFrame.
```

--------------------------------

### to_yaml()

Source: https://udst.github.io/urbanaccess/genindex.html

Converts configuration or data to YAML format. This is a method for urbanaccess_config and urbanaccess_gtfsfeeds.

```APIDOC
## to_yaml()

### Description
Converts configuration or data to YAML format.

### Method
(This is a method for urbanaccess.config.urbanaccess_config and urbanaccess.gtfsfeeds.urbanaccess_gtfsfeeds)

### Parameters
(Parameters not specified in the source)

### Request Example
(Not specified in the source)

### Response
(Not specified in the source)
```

--------------------------------

### urbanaccess.config.urbanaccess_config.to_yaml

Source: https://udst.github.io/urbanaccess/utilities.html

Save the current urbanaccess_config to a YAML file.

```APIDOC
## urbanaccess.config.urbanaccess_config.to_yaml

### Description
Save a urbanaccess_config representation to a YAML file.

### Parameters

#### Path Parameters
- **configdir** (str, optional) - Description: Directory to save a YAML file.
- **yamlname** (str or file like, optional) - Description: File name to which to save a YAML file.
- **overwrite** (bool, optional) - Default: False - Description: if true, overwrite an existing same name YAML file in specified directory.

### Returns

- **Nothing** - Description: This method does not return any value.
```

--------------------------------

### Create Street Network

Source: https://udst.github.io/urbanaccess/_sources/integrated_network.rst.txt

Creates a street network from loaded OSM data, calculating travel time impedance.

```APIDOC
## create_osm_net

### Description
Creates a street network from the loaded OSM data with travel time impedance.

### Function Signature
`urbanaccess.osm.network.create_osm_net()`
```

--------------------------------

### Load Network

Source: https://udst.github.io/urbanaccess/_sources/integrated_network.rst.txt

Loads previously saved network data.

```APIDOC
## load_network

### Description
Loads network data.

### Function Signature
`urbanaccess.network.load_network()`
```

--------------------------------

### Create Street Network from OSM Data

Source: https://udst.github.io/urbanaccess/integrated_network.html

Generates a street network graph with travel time impedance in minutes from OpenStreetMap nodes and edges. Customize travel speed and network type (e.g., 'walk').

```python
urbanaccess.osm.network.create_osm_net(osm_edges, osm_nodes, travel_speed_mph=3, network_type='walk')
```

--------------------------------

### create_transit_net()

Source: https://udst.github.io/urbanaccess/genindex.html

Creates a transit network model, likely from GTFS data. This function is part of the urbanaccess.gtfs.network module.

```APIDOC
## create_transit_net()

### Description
Creates a transit network model.

### Method
(This is a function in the urbanaccess.gtfs.network module)

### Parameters
(Parameters not specified in the source)

### Request Example
(Not specified in the source)

### Response
(Not specified in the source)
```

--------------------------------

### Integrate Network

Source: https://udst.github.io/urbanaccess/_sources/integrated_network.rst.txt

Creates an integrated transit and street network. If using headways, they must be computed beforehand.

```APIDOC
## integrate_network

### Description
Creates an integrated transit and street network. If using headways in your integrated network you must first compute the route-stop level headway in this step.

### Function Signature
`urbanaccess.network.integrate_network()`
```

--------------------------------

### urbanaccess.config.urbanaccess_config.to_dict

Source: https://udst.github.io/urbanaccess/utilities.html

Return a dictionary representation of an urbanaccess_config instance.

```APIDOC
## urbanaccess.config.urbanaccess_config.to_dict

### Description
Return a dict representation of an urbanaccess_config instance.

### Returns

- **dict** - Description: A dictionary representation of the configuration.
```

--------------------------------

### Calculate Headways by Route Stop

Source: https://udst.github.io/urbanaccess/data_loaders.html

Computes headways between stops for specific routes within a defined time range. Requires processed GTFS data as input.

```python
urbanaccess.gtfs.headways.headways(_gtfsfeeds_df_ , _headway_timerange_)
```

--------------------------------

### to_dict()

Source: https://udst.github.io/urbanaccess/genindex.html

Converts configuration or data to a dictionary format. This is a method for urbanaccess_config and urbanaccess_gtfsfeeds.

```APIDOC
## to_dict()

### Description
Converts configuration or data to a dictionary format.

### Method
(This is a method for urbanaccess.config.urbanaccess_config and urbanaccess.gtfsfeeds.urbanaccess_gtfsfeeds)

### Parameters
(Parameters not specified in the source)

### Request Example
(Not specified in the source)

### Response
(Not specified in the source)
```

--------------------------------

### Create Pandana Network from UrbanAccess Data

Source: https://udst.github.io/urbanaccess/_sources/pandana.rst.txt

Instantiate a Pandana Network object using nodes and edges from an UrbanAccess integrated network. Ensure `twoway=False` is set if the network is one-way.

```python
transit_ped_net = pdna.Network(integrated_ua_net.net_nodes["x"],
                                   integrated_ua_net.net_nodes["y"],
                                   integrated_ua_net.net_edges["from_int"],
                                   integrated_ua_net.net_edges["to_int"],
                                   integrated_ua_net.net_edges[["weight"]],
                                   twoway=False)
```

--------------------------------

### load_network()

Source: https://udst.github.io/urbanaccess/genindex.html

Loads a network model. This function is part of the urbanaccess.network module.

```APIDOC
## load_network()

### Description
Loads a network model.

### Method
(This is a function in the urbanaccess.network module)

### Parameters
(Parameters not specified in the source)

### Request Example
(Not specified in the source)

### Response
(Not specified in the source)
```

--------------------------------

### download()

Source: https://udst.github.io/urbanaccess/genindex.html

Downloads GTFS feeds. This function is part of the urbanaccess.gtfsfeeds module.

```APIDOC
## download()

### Description
Downloads GTFS feeds.

### Method
(This is a function in the urbanaccess.gtfsfeeds module)

### Parameters
(Parameters not specified in the source)

### Request Example
(Not specified in the source)

### Response
(Not specified in the source)
```

--------------------------------

### integrate_network

Source: https://udst.github.io/urbanaccess/integrated_network.html

Creates an integrated network by combining transit and OpenStreetMap (OSM) data. Optionally applies route-stop level headways to connector edge travel times.

```APIDOC
## integrate_network

### Description
Create an integrated network comprised of transit and OSM nodes and edges by connecting the transit network with the OSM network. Travel time is in units of minutes.

### Parameters

* **urbanaccess_network** (object) - Required - ua_network object with transit_edges, transit_nodes, osm_edges, osm_nodes.
* **headways** (bool, optional) - If true, route stop level headways calculated in a previous step will be applied to the OSM to transit connector edge travel time weights as an approximate measure of average passenger transit stop waiting time.
* **urbanaccess_gtfsfeeds_df** (object, optional) - Required if headways is true; the gtfsfeeds_dfs object that holds the corresponding headways and stops DataFrames.
* **headway_statistic** ({'mean', 'std', 'min', 'max'}, optional) - Required if headways is true; route stop headway statistic to apply to the OSM to transit connector edges: mean, std, min, max. Default is mean.

### Returns

* **urbanaccess_network** (object) - urbanaccess_network object with transit_edges, transit_nodes, osm_edges, osm_nodes, net_connector_edges, net_edges, net_nodes DataFrames.
```

--------------------------------

### col_colors

Source: https://udst.github.io/urbanaccess/plot.html

Generates a list of colors by binning a continuous variable column into quantiles. This is useful for visualizing data distributions on plots.

```APIDOC
## col_colors

### Description
Get a list of colors by binning a continuous variable column into quantiles.

### Method
`urbanaccess.plot.col_colors`

### Parameters
#### Required Parameters
- **df** (pandas.DataFrame) - The dataframe containing the data.
- **col** (string) - the name of the column in the dataframe with the continuous variable.

#### Optional Parameters
- **num_bins** (int) - how many quantiles. Defaults to 5.
- **cmap** (string) - name of a colormap. Defaults to 'spectral'.
- **start** (float) - where to start in the colorspace. Defaults to 0.1.
- **stop** (float) - where to end in the colorspace. Defaults to 0.9.

### Returns
- **colors** (list) - A list of colors.
```

--------------------------------

### integrate_network()

Source: https://udst.github.io/urbanaccess/genindex.html

Integrates network data. This function is part of the urbanaccess.network module.

```APIDOC
## integrate_network()

### Description
Integrates network data.

### Method
(This is a function in the urbanaccess.network module)

### Parameters
(Parameters not specified in the source)

### Request Example
(Not specified in the source)

### Response
(Not specified in the source)
```

--------------------------------

### Compute GTFS Headways

Source: https://udst.github.io/urbanaccess/_sources/data_loaders.rst.txt

Compute route-stop level headways, which is optional but required for using headways in the network integration step.

```python
from urbanaccess.gtfs import headways

headways.headways()

```

--------------------------------

### urbanaccess.gtfsfeeds.urbanaccess_gtfsfeeds.to_yaml

Source: https://udst.github.io/urbanaccess/data_loaders.html

Saves an urbanaccess_gtfsfeeds representation to a YAML file.

```APIDOC
## to_yaml(gtfsfeeddir='data/gtfsfeeds', yamlname='gtfsfeeds.yaml', overwrite=False)

### Description
Save a urbanaccess_gtfsfeeds representation to a YAML file.

### Parameters

#### gtfsfeeddir str, optional

Directory to save a YAML file.

#### yamlname str or file like, optional

File name to which to save a YAML file.

#### overwrite bool, optional

if true, overwrite an existing same name YAML file in specified directory

### Returns

Nothing
```

--------------------------------

### Save Network

Source: https://udst.github.io/urbanaccess/_sources/integrated_network.rst.txt

Saves the current network data.

```APIDOC
## save_network

### Description
Saves the network data.

### Function Signature
`urbanaccess.network.save_network()`
```

--------------------------------

### urbanaccess.gtfsfeeds.download

Source: https://udst.github.io/urbanaccess/_sources/data_loaders.rst.txt

Download data from feeds in your 'feeds' object or from custom feed URLs.

```APIDOC
## urbanaccess.gtfsfeeds.download

### Description
Downloads GTFS data from specified feeds or URLs.

### Parameters
This function does not appear to have any documented parameters.
```

--------------------------------

### load_network

Source: https://udst.github.io/urbanaccess/integrated_network.html

Reads an integrated network's node and edge data from an HDF5 file into a UrbanAccess network object.

```APIDOC
## load_network

### Description
Read an integrated network node and edge data from a hdf5 file to a urbanaccess_network object.

### Parameters

* **dir** (string, optional) - directory to read hdf5 file. Default is 'data'.
* **filename** (string) - Required - name of the hdf5 file to read with .h5 extension.

### Returns

* **ua_network** (object) - urbanaccess_network object with net_edges and net_nodes DataFrames.
    * **ua_network.net_edges** (object)
    * **ua_network.net_nodes** (object)
```

--------------------------------

### urbanaccess.gtfs.network.load_processed_gtfs_data

Source: https://udst.github.io/urbanaccess/_sources/data_loaders.rst.txt

Load processed GTFS data.

```APIDOC
## urbanaccess.gtfs.network.load_processed_gtfs_data

### Description
Loads previously processed GTFS data.

### Parameters
This function does not appear to have any documented parameters.
```

--------------------------------

### Load GTFS Data into DataFrame

Source: https://udst.github.io/urbanaccess/_sources/data_loaders.rst.txt

Load raw GTFS data from multiple feeds into a UrbanAccess transit data object and run data through the validation and formatting sequence. GTFS feeds are assumed to either be a single feed designated by the feed folder or multiple feeds designated as the root folder that holds all individual feed folders.

```python
from urbanaccess.gtfs import load

load.gtfsfeed_to_df(feed_folder='/path/to/your/gtfs/feed')

```

--------------------------------

### Pandana Aggregate Query for Jobs Accessibility

Source: https://udst.github.io/urbanaccess/_sources/pandana.rst.txt

Run an aggregation query to calculate the total number of jobs accessible within a specified travel time using a linear decay function.

```python
jobs_45 = transit_ped_net.aggregate(45, type='sum', decay='linear', name='jobs')
```

--------------------------------

### Load Processed GTFS Data

Source: https://udst.github.io/urbanaccess/_sources/data_loaders.rst.txt

Load the processed GTFS data.

```python
from urbanaccess.gtfs.network import load_processed_gtfs_data

load_processed_gtfs_data()

```

--------------------------------

### Download GTFS Data

Source: https://udst.github.io/urbanaccess/_sources/data_loaders.rst.txt

Download data from feeds in your 'feeds' object or from custom feed URLs.

```python
from urbanaccess.gtfsfeeds import feeds, download

feeds.download()

```

--------------------------------

### save_network

Source: https://udst.github.io/urbanaccess/integrated_network.html

Writes the integrated network's nodes and edges to an HDF5 file.

```APIDOC
## save_network

### Description
Write a urbanaccess_network integrated nodes and edges to a node and edge table in a hdf5 file.

### Parameters

* **urbanaccess_network** (object) - Required - urbanaccess_network object with net_edges and net_nodes DataFrames.
* **filename** (string) - Required - name of the hdf5 file to save with .h5 extension.
* **dir** (string, optional) - directory to save hdf5 file. Default is 'data'.
* **overwrite_key** (bool, optional) - if true any existing table with the specified key name will be overwritten.
* **overwrite_hdf5** (bool, optional) - if true any existing hdf5 file with the specified name in the specified directory will be overwritten.

### Returns

* None
```

--------------------------------

### urbanaccess.gtfsfeeds.urbanaccess_gtfsfeeds.add_feed

Source: https://udst.github.io/urbanaccess/data_loaders.html

Adds a dictionary of GTFS feeds to the existing instance.

```APIDOC
## add_feed(add_dict, replace=False)

### Description
Add a dictionary to the urbanaccess_gtfsfeeds instance.

### Parameters

#### add_dict dict

Dictionary to add to existing urbanaccess_gtfsfeeds with the name of the transit service or agency GTFS feed as the key and the GTFS feed URL as the value to pass to the GTFS downloader as: {unique name of GTFS feed or transit service/agency : URL of feed}

#### replace bool, optional

If key of dict is already in the UrbanAccess replace the existing dict value with the value passed
```

--------------------------------

### headways()

Source: https://udst.github.io/urbanaccess/genindex.html

Calculates headways from GTFS data. This function is part of the urbanaccess.gtfs.headways module.

```APIDOC
## headways()

### Description
Calculates headways from GTFS data.

### Method
(This is a function in the urbanaccess.gtfs.headways module)

### Parameters
(Parameters not specified in the source)

### Request Example
(Not specified in the source)

### Response
(Not specified in the source)
```

--------------------------------

### Pandana Nearest POI Query for Parks

Source: https://udst.github.io/urbanaccess/_sources/pandana.rst.txt

Perform a nearest POI query to find the closest parks within a given travel time threshold. `max_distance=0` indicates no additional spatial filtering beyond travel time.

```python
nearest_parks = transit_ped_net.nearest_pois(distance=45, category="parks", num_pois=2, max_distance=0)
```

--------------------------------

### save_network()

Source: https://udst.github.io/urbanaccess/genindex.html

Saves the network model. This function is part of the urbanaccess.network module.

```APIDOC
## save_network()

### Description
Saves the network model.

### Method
(This is a function in the urbanaccess.network module)

### Parameters
(Parameters not specified in the source)

### Request Example
(Not specified in the source)

### Response
(Not specified in the source)
```

--------------------------------

### urbanaccess.gtfsfeeds.urbanaccess_gtfsfeeds

Source: https://udst.github.io/urbanaccess/data_loaders.html

Manages a collection of GTFS feeds, allowing for addition, removal, and saving/loading from YAML.

```APIDOC
## urbanaccess.gtfsfeeds.urbanaccess_gtfsfeeds

### Description
A dict of GTFS feeds as {name of GTFS feed or transit service/agency : URL of feed} to request and download in the gtfs downloader.

### Parameters

#### gtfs_feeds dict

dictionary of the name of the transit service or agency GTFS feed as the key -note: this name will be used as the feed folder name. If the GTFS feed does not have a agency name in the agency.txt file this key will be used to name the agency- and the GTFS feed URL as the value to pass to the GTFS downloader as: {unique name of GTFS feed or transit service/agency : URL of feed}
```

--------------------------------

### urbanaccess.gtfs.load.gtfsfeed_to_df

Source: https://udst.github.io/urbanaccess/_sources/data_loaders.rst.txt

Load raw GTFS data (from multiple feeds) into a UrbanAccess transit data object and run data through the validation and formatting sequence.

```APIDOC
## urbanaccess.gtfs.load.gtfsfeed_to_df

### Description
Loads raw GTFS data into a UrbanAccess transit data object, performing validation and formatting.

### Parameters
This function does not appear to have any documented parameters.
```

--------------------------------

### add_feed()

Source: https://udst.github.io/urbanaccess/genindex.html

Adds a GTFS feed to the UrbanAccess system. This method is part of the urbanaccess_gtfsfeeds class.

```APIDOC
## add_feed()

### Description
Adds a GTFS feed to the UrbanAccess system.

### Method
(This is a method of the urbanaccess_gtfsfeeds class)

### Parameters
(Parameters not specified in the source)

### Request Example
(Not specified in the source)

### Response
(Not specified in the source)
```

--------------------------------

### headways

Source: https://udst.github.io/urbanaccess/data_loaders.html

Calculates route-stop level headways for a specified time range.

```APIDOC
## headways

### Description
Calculate headways by route stop for a specific time range.

### Method
`urbanaccess.gtfs.headways.headways`

### Parameters
#### Path Parameters
- **gtfsfeeds_df** (object) - gtfsfeeds_dfs object with all processed GTFS data tables

#### Query Parameters
- **headway_timerange** (list) - time range for which to calculate headways between as a list of time 1 and time 2 where times are 24 hour clock strings such as: [‘07:00:00’, ‘10:00:00’]

### Returns
#### Success Response (200)
- **gtfsfeeds_dfs.headways** (pandas.DataFrame) - gtfsfeeds_dfs object for the headways dataframe with statistics of route stop headways in units of minutes with relevant route and stop information
```

--------------------------------

### Load GTFS Feeds into DataFrames

Source: https://udst.github.io/urbanaccess/data_loaders.html

Reads GTFS feed components into pandas DataFrames. Optionally validates data and removes stops outside a specified bounding box. Appends GTFS definitions to columns for clarity.

```python
urbanaccess.gtfs.load.gtfsfeed_to_df(_gtfsfeed_path =None_, _validation =False_, _verbose =True_, _bbox =None_, _remove_stops_outsidebbox =None_, _append_definitions =False_)
```

--------------------------------

### Load Processed GTFS Data from HDF5

Source: https://udst.github.io/urbanaccess/data_loaders.html

Reads previously saved processed GTFS data from an HDF5 file back into a gtfsfeeds_dfs object. Specify the filename and optionally the directory.

```python
urbanaccess.gtfs.network.load_processed_gtfs_data(_filename_ , _dir ='data'_)
```

--------------------------------

### urbanaccess.gtfsfeeds.urbanaccess_gtfsfeeds.to_dict

Source: https://udst.github.io/urbanaccess/data_loaders.html

Returns a dictionary representation of an urbanaccess_gtfsfeeds instance.

```APIDOC
## to_dict()

### Description
Return a dict representation of an urbanaccess_gtfsfeeds instance.
```

--------------------------------

### search()

Source: https://udst.github.io/urbanaccess/genindex.html

Searches within GTFS feeds. This function is part of the urbanaccess.gtfsfeeds module.

```APIDOC
## search()

### Description
Searches within GTFS feeds.

### Method
(This is a function in the urbanaccess.gtfsfeeds module)

### Parameters
(Parameters not specified in the source)

### Request Example
(Not specified in the source)

### Response
(Not specified in the source)
```

--------------------------------

### col_colors()

Source: https://udst.github.io/urbanaccess/genindex.html

Retrieves color information, likely for plotting or visualization purposes. Located in the urbanaccess.plot module.

```APIDOC
## col_colors()

### Description
Retrieves color information.

### Method
(This is a function in the urbanaccess.plot module)

### Parameters
(Parameters not specified in the source)

### Request Example
(Not specified in the source)

### Response
(Not specified in the source)
```

--------------------------------

### plot_net Function

Source: https://udst.github.io/urbanaccess/_sources/plot.rst.txt

Plots the UrbanAccess network. This function can be used to visualize the transit network, the street network, or the travel times on the integrated network.

```APIDOC
## plot_net

### Description
Plots the UrbanAccess network. This function can be used to visualize the transit network, the street network, or the travel times on the integrated network.

### Parameters
This function does not explicitly list parameters in the provided documentation. Refer to the function signature for details.

### Usage Examples

**Plot the transit network**
```
# Example usage for plotting transit network
# |transit_net|
```

**Plot the street network**
```
# Example usage for plotting street network
# |ped_net|
```

**Plot the travel times on the integrated network**
```
# Example usage for plotting travel times
# |travel_time_net|
```
```

--------------------------------

### urbanaccess.gtfs.network.save_processed_gtfs_data

Source: https://udst.github.io/urbanaccess/_sources/data_loaders.rst.txt

Save processed GTFS data.

```APIDOC
## urbanaccess.gtfs.network.save_processed_gtfs_data

### Description
Saves the processed GTFS data.

### Parameters
This function does not appear to have any documented parameters.
```

--------------------------------

### urbanaccess.gtfsfeeds.search

Source: https://udst.github.io/urbanaccess/_sources/data_loaders.rst.txt

Search for feeds on the GTFS Data Exchange. Note that the GTFS Data Exchange is no longer maintained, so feeds may be out of date.

```APIDOC
## urbanaccess.gtfsfeeds.search

### Description
Searches for transit feeds on the GTFS Data Exchange.

### Parameters
This function does not appear to have any documented parameters.
```

--------------------------------

### Search GTFS Feeds

Source: https://udst.github.io/urbanaccess/_sources/data_loaders.rst.txt

Search for feeds on the GTFS Data Exchange. Note that the GTFS Data Exchange is no longer maintained, so feeds may be out of date.

```python
from urbanaccess.gtfsfeeds import search

search(name='CTA')

```

--------------------------------

### urbanaccess.gtfs.headways.headways

Source: https://udst.github.io/urbanaccess/_sources/data_loaders.rst.txt

Compute route-stop level headways, which is optional but required for using headways in the network integration step.

```APIDOC
## urbanaccess.gtfs.headways.headways

### Description
Computes route-stop level headways.

### Parameters
This function does not appear to have any documented parameters.
```

--------------------------------

### col_colors Function

Source: https://udst.github.io/urbanaccess/_sources/plot.rst.txt

Provides color mapping for network elements. This function is likely used internally or in conjunction with plotting functions to define colors for different network components.

```APIDOC
## col_colors

### Description
Provides color mapping for network elements. This function is likely used internally or in conjunction with plotting functions to define colors for different network components.

### Parameters
This function does not explicitly list parameters in the provided documentation. Refer to the function signature for details.
```

--------------------------------

### load_processed_gtfs_data

Source: https://udst.github.io/urbanaccess/data_loaders.html

Reads processed GTFS data from an HDF5 file into a gtfsfeeds_dfs object.

```APIDOC
## load_processed_gtfs_data

### Description
Read data from a hdf5 file to a gtfsfeeds_dfs object.

### Method
`urbanaccess.gtfs.network.load_processed_gtfs_data`

### Parameters
#### Path Parameters
- **filename** (string) - name of the hdf5 file to read with .h5 extension

#### Query Parameters
- **dir** (string, optional) - directory to read hdf5 file

### Returns
#### Success Response (200)
- **gtfsfeeds_dfs** (object)
```

--------------------------------

### Save Processed GTFS Data

Source: https://udst.github.io/urbanaccess/_sources/data_loaders.rst.txt

Save the processed GTFS data.

```python
from urbanaccess.gtfs.network import save_processed_gtfs_data

save_processed_gtfs_data()

```

--------------------------------

### gtfsfeed_to_df

Source: https://udst.github.io/urbanaccess/data_loaders.html

Reads GTFS feed components into dataframes and merges them. Optionally validates data and removes stops outside a specified bounding box.

```APIDOC
## gtfsfeed_to_df

### Description
Reads all GTFS feed components as a dataframe in a gtfsfeeds_dfs object and merges all individual GTFS feeds into a regional metropolitan data table. Optionally, data can also be validated before its use.

### Method
`urbanaccess.gtfs.load.gtfsfeed_to_df`

### Parameters
#### Path Parameters
- **gtfsfeed_path** (str, optional) - root path where all GTFS feeds that make up a contiguous metropolitan area are stored

#### Query Parameters
- **validation** (bool) - if true, the validation check on stops checking for stops outside of a bounding box and stop coordinate hemisphere will be run. this is required to remove stops outside of a bbox
- **verbose** (bool) - if true and stops are found outside of the bbox, the stops that are outside will be printed for your reference
- **bbox** (tuple) - Bounding box formatted as a 4 element tuple: (lng_max, lat_min, lng_min, lat_max) example: (-122.304611,37.798933,-122.263412,37.822802) a bbox can be extracted for an area using: the CSV format bbox from http://boundingbox.klokantech.com/
- **remove_stops_outsidebbox** (bool) - if true stops that are outside the bbox will be removed
- **append_definitions** (bool) - if true, columns that use the GTFS data schema for their attribute codes will have the corresponding GTFS definition information of that code appended to the resulting dataframes for reference

### Returns
#### Success Response (200)
- **gtfsfeeds_dfs** (object) - processed dataframes of corresponding GTFS feed text files
  - **gtfsfeeds_dfs.stops** (pandas.DataFrame)
  - **gtfsfeeds_dfs.routes** (pandas.DataFrame)
  - **gtfsfeeds_dfs.trips** (pandas.DataFrame)
  - **gtfsfeeds_dfs.stop_times** (pandas.DataFrame)
  - **gtfsfeeds_dfs.calendar** (pandas.DataFrame)
  - **gtfsfeeds_dfs.calendar_dates** (pandas.DataFrame)
```

--------------------------------

### plot_net

Source: https://udst.github.io/urbanaccess/plot.html

Plots urbanaccess network nodes and edges. This function can be used to visualize transit networks, street networks, or integrated networks with travel times.

```APIDOC
## plot_net

### Description
Plots urbanaccess network nodes and edges.

### Method
`urbanaccess.plot.plot_net`

### Parameters
#### Required Parameters
- **nodes** (pandas.DataFrame) - The nodes dataframe.
- **edges** (pandas.DataFrame) - The edges dataframe.

#### Optional Parameters
- **x_col** (str) - x coordinate column in nodes dataframe.
- **y_col** (str) - y coordinate column in nodes dataframe.
- **from_col** (str) - name of column to use for ‘from’ node id.
- **to_col** (str) - name of column to use for ‘to’ node id.
- **bbox** (tuple) - Bounding box formatted as a 4 element tuple: (lng_max, lat_min, lng_min, lat_max). If None, bbox will be calculated from spatial extents of data.
- **fig_height** (int) - matplotlib figure height in inches.
- **margin** (float) - margin around the figure.
- **edge_color** (string) - color of the edge lines.
- **edge_linewidth** (float) - width of the edge lines.
- **edge_alpha** (float) - opacity of the edge lines.
- **node_color** (string) - node color.
- **node_size** (int) - node size.
- **node_alpha** (float) - node opacity.
- **node_edgecolor** (string) - the color of the node border.
- **node_zorder** (int) - zorder to plot nodes, edges are zorder 2. A node_zorder 1 will plot nodes under the edges, 3 will plot nodes on top.
- **nodes_only** (bool) - if true only the nodes will plot.
- **ax** (matplotlib.axes._subplots.AxesSubplot) - matplotlib axes, as given by, for example, plt.subplot. Use to specify the projection.

### Returns
- **fig, ax** - The matplotlib figure and axes objects.
```

--------------------------------

### gtfsfeed_to_df()

Source: https://udst.github.io/urbanaccess/genindex.html

Converts GTFS feed data into a pandas DataFrame. This function is part of the urbanaccess.gtfs.load module.

```APIDOC
## gtfsfeed_to_df()

### Description
Converts GTFS feed data into a pandas DataFrame.

### Method
(This is a function in the urbanaccess.gtfs.load module)

### Parameters
(Parameters not specified in the source)

### Request Example
(Not specified in the source)

### Response
(Not specified in the source)
```

--------------------------------

### Save Processed GTFS Data to HDF5

Source: https://udst.github.io/urbanaccess/data_loaders.html

Writes the processed GTFS dataframes from a gtfsfeeds_dfs object to an HDF5 file for persistent storage. Specify the filename and optionally the directory.

```python
urbanaccess.gtfs.network.save_processed_gtfs_data(_gtfsfeeds_dfs_ , _filename_ , _dir ='data'_)
```

--------------------------------

### save_processed_gtfs_data

Source: https://udst.github.io/urbanaccess/data_loaders.html

Writes processed GTFS dataframes to an HDF5 file.

```APIDOC
## save_processed_gtfs_data

### Description
Write dataframes in a gtfsfeeds_dfs object to a hdf5 file.

### Method
`urbanaccess.gtfs.network.save_processed_gtfs_data`

### Parameters
#### Path Parameters
- **gtfsfeeds_dfs** (object) - gtfsfeeds_dfs object
- **filename** (string) - name of the hdf5 file to save with .h5 extension

#### Query Parameters
- **dir** (string, optional) - directory to save hdf5 file

### Returns
None
```

--------------------------------

### remove_feed()

Source: https://udst.github.io/urbanaccess/genindex.html

Removes a GTFS feed from the UrbanAccess system. This method is part of the urbanaccess_gtfsfeeds class.

```APIDOC
## remove_feed()

### Description
Removes a GTFS feed from the UrbanAccess system.

### Method
(This is a method of the urbanaccess_gtfsfeeds class)

### Parameters
(Parameters not specified in the source)

### Request Example
(Not specified in the source)

### Response
(Not specified in the source)
```

--------------------------------

### urbanaccess.gtfsfeeds.urbanaccess_gtfsfeeds.remove_feed

Source: https://udst.github.io/urbanaccess/data_loaders.html

Removes GTFS feeds from the existing urbanaccess_gtfsfeeds instance.

```APIDOC
## remove_feed(del_key=None, remove_all=False)

### Description
Remove GTFS feeds from the existing urbanaccess_gtfsfeeds instance.

### Parameters

#### del_key str or list, optional

dict keys as a single string or list of strings to remove from existing.

#### remove_all bool, optional

if true, remove all keys from existing urbanaccess_gtfsfeeds instance
```
Tokens:
Raw