Skip to content

Commit eb90ad3

Browse files
committed
update README
1 parent 742d48e commit eb90ad3

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
# simwrapper-python-tools
22

3-
Official python library for working with SimWrapper
3+
Official python library for working with SimWrapper.
44

5-
SimWrapper is...
5+
[SimWrapper](https://simwrapper.github.io) is a data visualization tool for exploring large transport simulation results.
66

77
## About this library
88

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.
1010

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.
1214
- 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!
1715

1816
## Quickstart
1917

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
2121

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

Comments
 (0)