Skip to content

Commit

Permalink
added readme, license
Browse files Browse the repository at this point in the history
  • Loading branch information
johnyf committed Aug 21, 2013
1 parent d2a68aa commit fcf107f
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 0 deletions.
27 changes: 27 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Copyright (c) 2010, Ioannis Filippidis
Copyright (c) 2010, Wouter Falkena
Copyright (c) 2011, Jonathan Sullivan
Copyright (c) 2011, Ioannis Filippidis
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the distribution

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Summary
-------
Load map, extract connectivity, plot road network & find shortest paths from OpenStreetMap `XML` file.

Description
-----------
This software package includes functions for working with OpenStreetMap XML Data files (extension `.osm`), as downloaded from [here](http://www.openstreetmap.org), to:

1. Import and parse the `XML` data file and store the parsed data in a `MATLAB` structure. This data represents the graph of the transportation network.

2. Plot the `MATLAB` structure to get a visualization of the transportation network, its nodes and their labels.

3. Extract the adjacency matrix of the directed graph representing the network's connectivity (i.e., road intersections).

4. Find shortest routes between nodes within the network. Note that distance is measured as the number of transitions between intersection nodes, not over the map.

Download
--------
[Distribution zip](http://www.mathworks.com/matlabcentral/fileexchange/35819-openstreetmap-functions?download=true) from the File Exchange.
Includes dependencies.

Documentation
-------------
Included in `PDF` format in the [distribution zip](http://www.mathworks.com/matlabcentral/fileexchange/35819-openstreetmap-functions?download=true).

Dependencies
------------
- [xml2struct](http://www.mathworks.com/matlabcentral/fileexchange/28518-xml2struct)
- [gaimc: graph algorithms](http://www.mathworks.com/matlabcentral/fileexchange/24134-gaimc-graph-algorithms-in-matlab-code)
- [Lat/Lon aspect ratio](http://www.mathworks.com/matlabcentral/fileexchange/32462-correctly-proportion-a-latlon-plot)
- [plot 2/3d point(s)](http://www.mathworks.com/matlabcentral/fileexchange/34731-plot-23d-points)

License
-------
This package is licensed under the 2-clause BSD license.
The authors of dependencies are included to enable their inclusion for distribution here.

0 comments on commit fcf107f

Please sign in to comment.