|
1 | 1 | # simwrapper-python-tools |
2 | 2 |
|
3 | | -Official python library for working with SimWrapper |
| 3 | +Official python library for working with SimWrapper. |
4 | 4 |
|
5 | | -SimWrapper is... |
| 5 | +[SimWrapper](https://simwrapper.github.io) is a data visualization tool for exploring large transport simulation results. |
6 | 6 |
|
7 | 7 | ## About this library |
8 | 8 |
|
9 | | -We are at the very early stages of building this library. The API will change, things will break, and there are certainly bugs. You probably shouldn't use this for anything. |
| 9 | +This library contains the "simwrapper" command-line tool, which allows browsing of local files on your PC/laptop using SimWrapper. |
10 | 10 |
|
11 | | -- Our primary goal is to make MATSim play nice with **pandas** and **geopandas**, for data analysis workflows. |
| 11 | +We are at the very early stages of building this tool. The API will change, things will break, and there are certainly bugs. |
| 12 | + |
| 13 | +- Our primary goal is to make it easy to get local simulation results viewable using the SimWrapper website. |
12 | 14 | - We have only tested this using Anaconda Python. Only Python 3.x is supported. |
13 | | -- Currently MATSim network, event, and plans files are supported. Hopefully more will be coming soon. |
14 | | -- For Geopandas network support, you also need to install `geopandas` and `shapely`. |
15 | | -- Supports JSON and Protobuf event file formats |
16 | | -- Can write MATSim files too! |
17 | 15 |
|
18 | 16 | ## Quickstart |
19 | 17 |
|
20 | | -1. Install using `pip install matsim-tools` |
| 18 | +1. Install once, using `pip install simwrapper` |
| 19 | + |
| 20 | +2. `cd` into your data folder, then run `simwrapper serve` to enable the local file server |
21 | 21 |
|
22 | | -2. In lieu of real documentation, here is some sample code to get you started. Good luck! |
| 22 | +3. Browse to either <https://vsp.berlin/simwrapper> or <https://activitysim.github.io/dashboard> to view your local folder outputs. |
0 commit comments