roadmap-processing

One Paragraph of project description goes here

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

We will work with pip, wget and virtualenv(optional). You can follow steps below to install it properly.

Installing

Use

python get-pip.py

for installing pip and

sudo pip install virtualenv

for virtualenv or

pip install virtualenv

whether you're using Windows. If you are running in Linux, type

mkdir ~/virtualEnvironment && cd ~/virtualEnvironment

then clone this GitHub project

git clone https://github.com/aicenter/roadmap-processing.git

and finally use

virtualenv --no-site-packages --distribute .env && source .env/bin/activate

to create isolated Python environments.

Examples of usage

First of all, check your versions of required packages

python install_requirements.py

after that you can simply download your favourite city.

python mapdownloader.py "Barcelona"

You can skip this, if you have own city area and continue with

python run_demo.py map.osm -r

and your final result is in folder "/data" as "output-final-result.geojson".

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

  • Dropwizard - The web framework used
  • Maven - Dependency Management
  • ROME - Used to generate RSS Feeds

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

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

Acknowledgments

  • Hat tip to anyone who's code was used
  • Inspiration
  • etc