Metadata-Version: 2.1
Name: pycitysim
Version: 1.20.0
Summary: City Simulator and OpenCity Databases Python SDK
Author-email: Jun Zhang <zhangjun990222@gmail.com>
License: MIT License
        
        Copyright (c) 2024 FIBLAB
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/tsinghua-fib-lab/pycitysim
Project-URL: Documentation, https://pycitysim.sim.fiblab.net/pycitysim
Project-URL: Repository, https://github.com/tsinghua-fib-lab/pycitysim.git
Project-URL: Issues, https://github.com/tsinghua-fib-lab/pycitysim/issues
Keywords: city,simulation,database,sdk
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: importlib-metadata; python_version < "3.8"
Requires-Dist: Deprecated>=1.2.0
Requires-Dist: geojson>=3.1.0
Requires-Dist: geopandas>=0.9.0
Requires-Dist: grpcio<2.0.0,>=1.42.0
Requires-Dist: lru-dict>=1.3.0
Requires-Dist: numpy>=1.24.0
Requires-Dist: opencv-python>=4.8.0.74
Requires-Dist: Pillow>=10.0.0
Requires-Dist: pycityproto==1.19.1
Requires-Dist: pymongo>=3.12.1
Requires-Dist: pyproj>=3.0.0
Requires-Dist: requests>=2.27.0
Requires-Dist: scipy>=1.7.0
Requires-Dist: shapely>=2.0.0
Requires-Dist: stringcase>=1.2.0

# pycitysim

City Simulator and OpenCity databases Python SDK

## 安装 Installation

```shell
pip install pycitysim
```

安装 grpcio 的过程中，如果出现：
When installing grpcio, you may encounter the following error:

```
pip install fails with "No such file or directory: 'c++': 'c++'"
```

代表缺少 C++相关依赖。在 Debian 镜像上，执行：
It means that C++ related dependencies are missing. On the Debian image, execute:

```shell
sudo apt install build-essential
```

在 alpine 镜像上，执行：
On the alpine image, execute:

```shell
apk add g++
```

## 主要子库 Sub-packages

- pycitysim.apphub: OpenCity后端交互库。OpenCity backend interaction package.
- pycitysim.map: 地图数据操作库。Map data operation package.
- pycitysim.routing: 路径规划操作库。Routing operation package.
- pycitysim.sim: 模拟器gRPC接入客户端。City Simulator gRPC access client.
- pycitysim.urbankg: 城市知识图谱访问模块。City knowledge graph access module.

## 示例代码

访问 [examples](https://github.com/tsinghua-fib-lab/pycitysim/tree/main/examples) 查看示例代码。
