GOSTnets: Build, process, and analyze networks

GOSTnets is built on top of geopandas, networkx, osmnx, and rtree.

Installation

From PyPI

pypi support in development

From `conda-forge`

conda support in development

From Source

Clone or download this repository to your local machine. Then, navigate to the root directory of the repository:
```
git clone https://github.com/worldbank/GOSTnets.git
cd GOSTnets
```

Create a virtual environment (optional but recommended):

python3 -m venv venv
source venv/bin/activate  # On Windows, use `venv\Scripts\activate`

Install the package in editable mode with dependencies:
```
pip install -e .
```
The -e flag stands for "editable," meaning changes to the source code will immediately affect the installed package.

Alternative Installations With Optional Dependencies

The following are optional dependencies that can be installed with GOSTnets - which not required to use GOSTnets, but they may be useful for some users, as they enable additional functionality. All of these alternative installs use the same pip install command as above. The examples show how to install these from PyPI, but the same commands can be used to install from source, replacing the package name GOSTnets with a . similar to the example above.

OSM Support (Needed to run functions from `load_osm.py`)

pip install GOSTnets[osm]

Optimization Support (Needed to run functions from `optimization.py`)

pip install GOSTnets[opt]

Development Support

pip install GOSTnets[dev]

Usage

Every function contains a docstring which can be brought up in use to check the inputs for various functions. For example:

import GOSTnets as gn
gn.edge_gdf_from_graph?

returns:

Signature: gn.edge_gdf_from_graph(G, crs={'init': 'epsg:4326'}, attr_list=None, geometry_tag='geometry', xCol='x', yCol='y')
#### Function for generating a GeoDataFrame from a networkx Graph object ###
 REQUIRED: a graph object G
 OPTIONAL: crs - projection of format {'init' :'epsg:4326'}. Defaults to
           WGS84. Note: here we are defining the crs of the input geometry -
           we do NOT reproject to this crs. To reproject, consider using
           geopandas' to_crs method on the returned gdf.
           attr_list: list of the keys which you want to be moved over to
           the GeoDataFrame.
           geometry_tag - the key in the data dictionary for each edge which
           contains the geometry info.
           xCol - if no geometry is present in the edge data dictionary, the
           function will try to construct a straight line between the start
           and end nodes, if geometry information is present in their data
           dictionaries.  Pass the Longitude info as 'xCol'.
           yCol - likewise, determining the Latitude tag for the node's data
           dictionary allows us to make a straight line geometry where an
           actual geometry is missing.
 RETURNS: a GeoDataFrame object of the edges in the graph
#-------------------------------------------------------------------------#

These docstrings have been written for every function, and should help new and old users alike with the options and syntax.

License

This licensed under the MIT License. This project is licensed under the MIT License - see the LICENSE file for details.

worldbank/GOSTnets