.. _f-datageostreets:

module ``datainc.data_geo_streets``
===================================







Short summary
+++++++++++++

module ``ensae_projects.datainc.data_geo_streets``

Data related to a challenge, streets in Seattle


:githublink:`%|py|6`






Functions
+++++++++

+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                                          | truncated documentation                                                                                                                                   |
+===================================================================================================================+===========================================================================================================================================================+
| :func:`_complete_subset_streets <ensae_projects.datainc.data_geo_streets._complete_subset_streets>`               | Extends a set of edges to have less extermities into the graph composed by the sets of edges.                                                             |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`_enumerate_close <ensae_projects.datainc.data_geo_streets._enumerate_close>`                               | Enumerates close streets from a starting point.                                                                                                           |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`build_streets_vertices <ensae_projects.datainc.data_geo_streets.build_streets_vertices>`                   | Returns vertices and edges based on the subset of edges.                                                                                                  |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`connect_streets <ensae_projects.datainc.data_geo_streets.connect_streets>`                                 | Tells if streets `st1`, `st2` are connected.                                                                                                              |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`folium_html_street_map <ensae_projects.datainc.data_geo_streets.folium_html_street_map>`                   | Returns a :epkg:`folium` map which represents the streets.                                                                                                |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_fields_description <ensae_projects.datainc.data_geo_streets.get_fields_description>`                   | Retrieves a :epkg:`dataframe` which describes the meaning of the metadata.                                                                                |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`get_seattle_streets <ensae_projects.datainc.data_geo_streets.get_seattle_streets>`                         | Retrieves processed data from `Seattle Streets <https://data.seattle.gov/dataset/Street-Network-Database/ afip-2mzr/data)>`_. ...                         |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`plot_streets_network <ensae_projects.datainc.data_geo_streets.plot_streets_network>`                       | Plots the network based on :epkg:`cartopy`.                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`plot_streets_network_projection <ensae_projects.datainc.data_geo_streets.plot_streets_network_projection>` | Returns the default projection for :func:`plot_streets_network`. See `projection <https://scitools.org.uk/cartopy/docs/v0.15/crs/projections.html>`_. ... |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`seattle_streets_set_level <ensae_projects.datainc.data_geo_streets.seattle_streets_set_level>`             | Returns a graph of streets.                                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`seattle_streets_set_level2 <ensae_projects.datainc.data_geo_streets.seattle_streets_set_level2>`           | Returns a small graph of streets.                                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`seattle_streets_set_level3 <ensae_projects.datainc.data_geo_streets.seattle_streets_set_level3>`           | Returns a small graph of streets.                                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`seattle_streets_set_small <ensae_projects.datainc.data_geo_streets.seattle_streets_set_small>`             | Returns a small graph of streets.                                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`shapely_records <ensae_projects.datainc.data_geo_streets.shapely_records>`                                 | Uses `pyshp <https://pypi.python.org/pypi/pyshp/>`_ to return shapes and records from shapefiles.                                                         |
+-------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+








Documentation
+++++++++++++

.. automodule:: ensae_projects.datainc.data_geo_streets
    :members:
    :special-members: __init__
    :show-inheritance: